api_service

<p>Base R6 class for creating API service wrappers. This class provides a
foundation for building service-specific API clients with authentication,
endpoint management, and configuration.</p>

Implements a credential chain for 'Azure OAuth 2.0' authentication
based on the package 'httr2''s 'OAuth' framework. Sequentially attempts authentication
methods until one succeeds. During development allows interactive
browser-based flows ('Device Code' and 'Auth Code' flows) and non-interactive
flow ('Client Secret') in batch mode.

Pedro Baltazar

Credential Chain for Seamless 'OAuth 2.0' Authentication to
'Azure Services'

api_service function

<p><div class="r6-fields"></div></p><dl>
<dt><code>.client</code></dt>
<dd><p>An api_client instance for making API requests</p></dd><p></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/api_service%24new()?package=azr&version=0.2.0" data-mini-rdoc="azr::api_service$new()"><code>api_service$new()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-api_service-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new API service instance</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_service$new(
  client = NULL,
  chain = NULL,
  endpoints = list(),
  config = list()
)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>client</code></dt>
<dd><p>An api_client instance. If <code>NULL</code>, a new client will be created.</p></dd></dl></div></p><p>
<dt><code>chain</code></dt>
<dd><p>A credential_chain instance for authentication. Optional.</p></dd></p><p>
<dt><code>endpoints</code></dt>
<dd><p>A named list where names are endpoint paths (e.g., "v1.0", "beta")
and values are R6 class objects (not instances) to use for creating resources.
Defaults to an empty list. If the value is <code>NULL</code>, api_resource will be used.</p></dd></p><p>
<dt><code>config</code></dt>
<dd><p>A list of configuration options. Defaults to an empty list.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A new <code>api_service</code> object</p>
</div><p></p><p>
</p>

Methods

API Service Base Class — api_service

<p><div class="r6-fields"></p><dl>
<dt><code>.client</code></dt>
<dd><p>An api_client instance for making API requests</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-api_service-new'><code>api_service$new()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-api_service-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new API service instance</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_service$new(
  client = NULL,
  chain = NULL,
  endpoints = list(),
  config = list()
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>client</code></dt>
<dd><p>An api_client instance. If <code>NULL</code>, a new client will be created.</p></dd>


<dt><code>chain</code></dt>
<dd><p>A credential_chain instance for authentication. Optional.</p></dd>


<dt><code>endpoints</code></dt>
<dd><p>A named list where names are endpoint paths (e.g., "v1.0", "beta")
and values are R6 class objects (not instances) to use for creating resources.
Defaults to an empty list. If the value is <code>NULL</code>, api_resource will be used.</p></dd>


<dt><code>config</code></dt>
<dd><p>A list of configuration options. Defaults to an empty list.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A new <code>api_service</code> object</p>
</div>

</div>


api_service: API Service Base Class

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method `new()`