# Accounts (*accounts*) ## Overview ### Available Operations * [register](#register) - Create a new account * [list](#list) - List all accounts * [updateSettings](#updatesettings) - Update account settings * [modifyDetails](#modifydetails) - Update account details * [fetchById](#fetchbyid) - Get account details * [removeById](#removebyid) - Delete account * [getUsage](#getusage) - Get account usage * [create](#create) - Create a new account * [update](#update) - Update account details * [get](#get) - Get account details * [delete](#delete) - Delete account ## register Creates a new user account in the workspace service ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.register({}); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsRegister } from "oppulence-backend-sdk/funcs/accountsRegister.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsRegister(oppulenceBackendSDK, {}); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostApiLeadScraperMicroserviceApiV1AccountsRequestBody](../../models/operations/postapileadscrapermicroserviceapiv1accountsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PostApiLeadScraperMicroserviceApiV1AccountsResponseBody](../../models/operations/postapileadscrapermicroserviceapiv1accountsresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | errors.PostApiLeadScraperMicroserviceApiV1AccountsErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## list Retrieves a list of accounts ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.list({}); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsList } from "oppulence-backend-sdk/funcs/accountsList.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsList(oppulenceBackendSDK, {}); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetApiLeadScraperMicroserviceApiV1AccountsListRequest](../../models/operations/getapileadscrapermicroserviceapiv1accountslistrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetApiLeadScraperMicroserviceApiV1AccountsListResponseBody](../../models/operations/getapileadscrapermicroserviceapiv1accountslistresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | errors.GetApiLeadScraperMicroserviceApiV1AccountsListErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## updateSettings Updates the settings for a given account ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.updateSettings({}); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsUpdateSettings } from "oppulence-backend-sdk/funcs/accountsUpdateSettings.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsUpdateSettings(oppulenceBackendSDK, {}); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutApiLeadScraperMicroserviceApiV1AccountsSettingsRequestBody](../../models/operations/putapileadscrapermicroserviceapiv1accountssettingsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PutApiLeadScraperMicroserviceApiV1AccountsSettingsResponseBody](../../models/operations/putapileadscrapermicroserviceapiv1accountssettingsresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | errors.PutApiLeadScraperMicroserviceApiV1AccountsSettingsErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## modifyDetails Updates specified fields of an existing account ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.modifyDetails({}); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsModifyDetails } from "oppulence-backend-sdk/funcs/accountsModifyDetails.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsModifyDetails(oppulenceBackendSDK, {}); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutApiLeadScraperMicroserviceApiV1AccountsUpdateRequestBody](../../models/operations/putapileadscrapermicroserviceapiv1accountsupdaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PutApiLeadScraperMicroserviceApiV1AccountsUpdateResponseBody](../../models/operations/putapileadscrapermicroserviceapiv1accountsupdateresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | errors.PutApiLeadScraperMicroserviceApiV1AccountsUpdateErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## fetchById Retrieves details of a specific account ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.fetchById({ id: "", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsFetchById } from "oppulence-backend-sdk/funcs/accountsFetchById.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsFetchById(oppulenceBackendSDK, { id: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetApiLeadScraperMicroserviceApiV1AccountsIdRequest](../../models/operations/getapileadscrapermicroserviceapiv1accountsidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetApiLeadScraperMicroserviceApiV1AccountsIdResponseBody](../../models/operations/getapileadscrapermicroserviceapiv1accountsidresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | errors.GetApiLeadScraperMicroserviceApiV1AccountsIdErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## removeById Permanently deletes an account and associated resources ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.removeById({ id: "", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsRemoveById } from "oppulence-backend-sdk/funcs/accountsRemoveById.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsRemoveById(oppulenceBackendSDK, { id: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.DeleteApiLeadScraperMicroserviceApiV1AccountsIdRequest](../../models/operations/deleteapileadscrapermicroserviceapiv1accountsidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.DeleteApiLeadScraperMicroserviceApiV1AccountsIdResponseBody](../../models/operations/deleteapileadscrapermicroserviceapiv1accountsidresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | errors.DeleteApiLeadScraperMicroserviceApiV1AccountsIdErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## getUsage Retrieves usage details for a given account ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.getUsage({ id: "", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsGetUsage } from "oppulence-backend-sdk/funcs/accountsGetUsage.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsGetUsage(oppulenceBackendSDK, { id: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetApiLeadScraperMicroserviceApiV1AccountsIdUsageRequest](../../models/operations/getapileadscrapermicroserviceapiv1accountsidusagerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetApiLeadScraperMicroserviceApiV1AccountsIdUsageResponseBody](../../models/operations/getapileadscrapermicroserviceapiv1accountsidusageresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | errors.GetApiLeadScraperMicroserviceApiV1AccountsIdUsageErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## create Creates a new user account with initial workspace ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.create({ auth0UserId: "", email: "Loyal79@yahoo.com", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsCreate } from "oppulence-backend-sdk/funcs/accountsCreate.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsCreate(oppulenceBackendSDK, { auth0UserId: "", email: "Loyal79@yahoo.com", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostApiWorkspaceServiceV1AccountsRequestBody](../../models/operations/postapiworkspaceservicev1accountsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PostApiWorkspaceServiceV1AccountsResponseBody](../../models/operations/postapiworkspaceservicev1accountsresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | errors.PostApiWorkspaceServiceV1AccountsErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## update Update account details ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.update({}); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsUpdate } from "oppulence-backend-sdk/funcs/accountsUpdate.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsUpdate(oppulenceBackendSDK, {}); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutApiWorkspaceServiceV1AccountsRequestBody](../../models/operations/putapiworkspaceservicev1accountsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.PutApiWorkspaceServiceV1AccountsResponseBody](../../models/operations/putapiworkspaceservicev1accountsresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | errors.PutApiWorkspaceServiceV1AccountsErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## get Get account details ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.get({ id: "", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsGet } from "oppulence-backend-sdk/funcs/accountsGet.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsGet(oppulenceBackendSDK, { id: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetApiWorkspaceServiceV1AccountsIdRequest](../../models/operations/getapiworkspaceservicev1accountsidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.GetApiWorkspaceServiceV1AccountsIdResponseBody](../../models/operations/getapiworkspaceservicev1accountsidresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | | errors.GetApiWorkspaceServiceV1AccountsIdErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## delete Delete account ### Example Usage ```typescript import { OppulenceBackendSDK } from "oppulence-backend-sdk"; const oppulenceBackendSDK = new OppulenceBackendSDK(); async function run() { const result = await oppulenceBackendSDK.accounts.delete({ id: "", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { OppulenceBackendSDKCore } from "oppulence-backend-sdk/core.js"; import { accountsDelete } from "oppulence-backend-sdk/funcs/accountsDelete.js"; // Use `OppulenceBackendSDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const oppulenceBackendSDK = new OppulenceBackendSDKCore(); async function run() { const res = await accountsDelete(oppulenceBackendSDK, { id: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.DeleteApiWorkspaceServiceV1AccountsIdRequest](../../models/operations/deleteapiworkspaceservicev1accountsidrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.DeleteApiWorkspaceServiceV1AccountsIdResponseBody](../../models/operations/deleteapiworkspaceservicev1accountsidresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | | errors.DeleteApiWorkspaceServiceV1AccountsIdErrorResponse | 400 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |