Budgets
Overview
Available Operations
- list - List budgets
- getOrg - List org budgets
- setOrg - Set an org budget
- deleteOrg - Delete an org budget
- orgEvents - List org budget events
- getApiKey - List apikey budgets
- setApiKey - Set an apikey budget
- deleteApiKey - Delete an apikey budget
- apiKeyEvents - List apikey budget events
- getCurrency - Get display currency
- setCurrency - Set display currency
list
Cluster admins see all budgets; org admins see their org's budgets plus budgets on API keys in their org.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.list();
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsList } from "@meetkai/mka1/funcs/budgetsList.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsList(sdk);
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsList failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useBudgetsList,
useBudgetsListSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchBudgetsList,
// Utility to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateAllBudgetsList,
} from "@meetkai/mka1/react-query/budgetsList.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.ListBudgetsResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
getOrg
Returns the org's budgets (self-budget and/or ceiling) with each one's live spend gauge. Targets the caller's own organization (inferred from the API key or session) unless the optional org_id query parameter names another org — cluster admins only.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.getOrg({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsGetOrg } from "@meetkai/mka1/funcs/budgetsGetOrg.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsGetOrg(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsGetOrg failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useBudgetsGetOrg,
useBudgetsGetOrgSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchBudgetsGetOrg,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateBudgetsGetOrg,
invalidateAllBudgetsGetOrg,
} from "@meetkai/mka1/react-query/budgetsGetOrg.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetOrgBudgetsRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.GetOrgBudgetsResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
setOrg
Creates or updates a budget for the org. One budget per (scope, owner); editing re-evaluates against live spend. Targets the caller's own organization (inferred from the API key or session) unless the optional org_id query parameter names another org — cluster admins only.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.setOrg({
requestBody: {
period: "monthly",
limit: 1009.12,
thresholds: [],
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsSetOrg } from "@meetkai/mka1/funcs/budgetsSetOrg.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsSetOrg(sdk, {
requestBody: {
period: "monthly",
limit: 1009.12,
thresholds: [],
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsSetOrg failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useBudgetsSetOrgMutation
} from "@meetkai/mka1/react-query/budgetsSetOrg.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.SetOrgBudgetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.SetOrgBudgetResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
deleteOrg
Removes the org's budget for the given owner; enforcement and alerts stop. Targets the caller's own organization (inferred from the API key or session) unless the optional org_id query parameter names another org — cluster admins only.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.deleteOrg({
owner: "cluster",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsDeleteOrg } from "@meetkai/mka1/funcs/budgetsDeleteOrg.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsDeleteOrg(sdk, {
owner: "cluster",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsDeleteOrg failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useBudgetsDeleteOrgMutation
} from "@meetkai/mka1/react-query/budgetsDeleteOrg.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.DeleteOrgBudgetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.DeleteOrgBudgetResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
orgEvents
Returns recent threshold-alert and block events for the org's budgets. Targets the caller's own organization (inferred from the API key or session) unless the optional org_id query parameter names another org — cluster admins only.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.orgEvents({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsOrgEvents } from "@meetkai/mka1/funcs/budgetsOrgEvents.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsOrgEvents(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsOrgEvents failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useBudgetsOrgEvents,
useBudgetsOrgEventsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchBudgetsOrgEvents,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateBudgetsOrgEvents,
invalidateAllBudgetsOrgEvents,
} from "@meetkai/mka1/react-query/budgetsOrgEvents.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListOrgBudgetEventsRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.ListOrgBudgetEventsResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
getApiKey
Returns the apikey's budgets (self-budget and/or ceiling) with each one's live spend gauge. Callable by cluster admins, or org admins for API keys in their own organization.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.getApiKey({
apiKeyId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsGetApiKey } from "@meetkai/mka1/funcs/budgetsGetApiKey.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsGetApiKey(sdk, {
apiKeyId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsGetApiKey failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useBudgetsGetApiKey,
useBudgetsGetApiKeySuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchBudgetsGetApiKey,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateBudgetsGetApiKey,
invalidateAllBudgetsGetApiKey,
} from "@meetkai/mka1/react-query/budgetsGetApiKey.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetApiKeyBudgetsRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.GetApiKeyBudgetsResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
setApiKey
Creates or updates a budget for the apikey. One budget per (scope, owner); editing re-evaluates against live spend. Callable by cluster admins, or org admins for API keys in their own organization.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.setApiKey({
apiKeyId: "<id>",
requestBody: {
period: "weekly",
limit: 3281.35,
thresholds: [
{
pct: 793338,
action: "alert",
},
],
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsSetApiKey } from "@meetkai/mka1/funcs/budgetsSetApiKey.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsSetApiKey(sdk, {
apiKeyId: "<id>",
requestBody: {
period: "weekly",
limit: 3281.35,
thresholds: [
{
pct: 793338,
action: "alert",
},
],
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsSetApiKey failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useBudgetsSetApiKeyMutation
} from "@meetkai/mka1/react-query/budgetsSetApiKey.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.SetApiKeyBudgetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.SetApiKeyBudgetResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
deleteApiKey
Removes the apikey's budget for the given owner; enforcement and alerts stop. Callable by cluster admins, or org admins for API keys in their own organization.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.deleteApiKey({
apiKeyId: "<id>",
owner: "org",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsDeleteApiKey } from "@meetkai/mka1/funcs/budgetsDeleteApiKey.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsDeleteApiKey(sdk, {
apiKeyId: "<id>",
owner: "org",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsDeleteApiKey failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useBudgetsDeleteApiKeyMutation
} from "@meetkai/mka1/react-query/budgetsDeleteApiKey.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.DeleteApiKeyBudgetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.DeleteApiKeyBudgetResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
apiKeyEvents
Returns recent threshold-alert and block events for the apikey's budgets. Callable by cluster admins, or org admins for API keys in their own organization.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.apiKeyEvents({
apiKeyId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsApiKeyEvents } from "@meetkai/mka1/funcs/budgetsApiKeyEvents.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsApiKeyEvents(sdk, {
apiKeyId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsApiKeyEvents failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useBudgetsApiKeyEvents,
useBudgetsApiKeyEventsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchBudgetsApiKeyEvents,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateBudgetsApiKeyEvents,
invalidateAllBudgetsApiKeyEvents,
} from "@meetkai/mka1/react-query/budgetsApiKeyEvents.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListApiKeyBudgetEventsRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.ListApiKeyBudgetEventsResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
getCurrency
Get display currency
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.getCurrency();
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsGetCurrency } from "@meetkai/mka1/funcs/budgetsGetCurrency.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsGetCurrency(sdk);
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsGetCurrency failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useBudgetsGetCurrency,
useBudgetsGetCurrencySuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchBudgetsGetCurrency,
// Utility to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateAllBudgetsGetCurrency,
} from "@meetkai/mka1/react-query/budgetsGetCurrency.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.GetCurrencyResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
setCurrency
ISO 4217 code used for display on budgets and cost reports. No conversion is performed anywhere.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.budgets.setCurrency({
currency: "Kwacha",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { budgetsSetCurrency } from "@meetkai/mka1/funcs/budgetsSetCurrency.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await budgetsSetCurrency(sdk, {
currency: "Kwacha",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("budgetsSetCurrency failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useBudgetsSetCurrencyMutation
} from "@meetkai/mka1/react-query/budgetsSetCurrency.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.SetCurrencyRequestBody | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<operations.SetCurrencyResponseBody>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |