@emilgroup/account-sdk-node 1.0.0

package/dist/api/accounts-api.d.ts

@@ -0,0 +1,375 @@
+/**
+ * EMIL AccountService
+ * The EMIL AccountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateAccountRequestDto } from '../models';
+import { CreateAccountResponseClass } from '../models';
+import { GetAccountResponseClass } from '../models';
+import { ListAccountsResponseClass } from '../models';
+import { UpdateAccountRequestDto } from '../models';
+import { UpdateAccountResponseClass } from '../models';
+/**
+ * AccountsApi - axios parameter creator
+ * @export
+ */
+export declare const AccountsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create an account in the database. Account creation is usually part      of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge     might result in an unusable account. Look into lead creation for more information.
+     * @summary Create the account
+     * @param {CreateAccountRequestDto} createAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAccount: (createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
+     * @summary Delete the account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
+     * @summary Retrieve the account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Use the expand query parameter when you need additional information.      The expand query parameter increases the set of fields that appear in the response      in addition to the default fields.      Expanding resources reduces the number of API calls required to accomplish a task.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest account appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List accounts
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100.      Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. *pageToken* is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: **code**, **firstName**, **lastName**, **accountNumber**, **email**, **zipCode**, **birthDate**
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.     Parameters: **firstName**, **lastName**, **accountNumber**, **email**.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.     Parameters: **policy**.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the account
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateAccountRequestDto} updateAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAccount: (code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AccountsApi - functional programming interface
+ * @export
+ */
+export declare const AccountsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create an account in the database. Account creation is usually part      of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge     might result in an unusable account. Look into lead creation for more information.
+     * @summary Create the account
+     * @param {CreateAccountRequestDto} createAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAccount(createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountResponseClass>>;
+    /**
+     * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
+     * @summary Delete the account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
+     * @summary Retrieve the account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Use the expand query parameter when you need additional information.      The expand query parameter increases the set of fields that appear in the response      in addition to the default fields.      Expanding resources reduces the number of API calls required to accomplish a task.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponseClass>>;
+    /**
+     * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest account appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List accounts
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100.      Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. *pageToken* is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: **code**, **firstName**, **lastName**, **accountNumber**, **email**, **zipCode**, **birthDate**
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.     Parameters: **firstName**, **lastName**, **accountNumber**, **email**.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.     Parameters: **policy**.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponseClass>>;
+    /**
+     * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the account
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateAccountRequestDto} updateAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAccount(code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAccountResponseClass>>;
+};
+/**
+ * AccountsApi - factory interface
+ * @export
+ */
+export declare const AccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create an account in the database. Account creation is usually part      of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge     might result in an unusable account. Look into lead creation for more information.
+     * @summary Create the account
+     * @param {CreateAccountRequestDto} createAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAccount(createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateAccountResponseClass>;
+    /**
+     * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
+     * @summary Delete the account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
+     * @summary Retrieve the account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Use the expand query parameter when you need additional information.      The expand query parameter increases the set of fields that appear in the response      in addition to the default fields.      Expanding resources reduces the number of API calls required to accomplish a task.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetAccountResponseClass>;
+    /**
+     * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest account appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List accounts
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100.      Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. *pageToken* is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: **code**, **firstName**, **lastName**, **accountNumber**, **email**, **zipCode**, **birthDate**
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.     Parameters: **firstName**, **lastName**, **accountNumber**, **email**.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.     Parameters: **policy**.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListAccountsResponseClass>;
+    /**
+     * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the account
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateAccountRequestDto} updateAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAccount(code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateAccountResponseClass>;
+};
+/**
+ * Request parameters for createAccount operation in AccountsApi.
+ * @export
+ * @interface AccountsApiCreateAccountRequest
+ */
+export interface AccountsApiCreateAccountRequest {
+    /**
+     *
+     * @type {CreateAccountRequestDto}
+     * @memberof AccountsApiCreateAccount
+     */
+    readonly createAccountRequestDto: CreateAccountRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AccountsApiCreateAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteAccount operation in AccountsApi.
+ * @export
+ * @interface AccountsApiDeleteAccountRequest
+ */
+export interface AccountsApiDeleteAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof AccountsApiDeleteAccount
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AccountsApiDeleteAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getAccount operation in AccountsApi.
+ * @export
+ * @interface AccountsApiGetAccountRequest
+ */
+export interface AccountsApiGetAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof AccountsApiGetAccount
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AccountsApiGetAccount
+     */
+    readonly authorization?: string;
+    /**
+     * Use the expand query parameter when you need additional information.      The expand query parameter increases the set of fields that appear in the response      in addition to the default fields.      Expanding resources reduces the number of API calls required to accomplish a task.
+     * @type {string}
+     * @memberof AccountsApiGetAccount
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listAccounts operation in AccountsApi.
+ * @export
+ * @interface AccountsApiListAccountsRequest
+ */
+export interface AccountsApiListAccountsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AccountsApiListAccounts
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned. Limit ranges between 1 and 100.      Default: 10.
+     * @type {number}
+     * @memberof AccountsApiListAccounts
+     */
+    readonly pageSize?: number;
+    /**
+     * A cursor for use in pagination. *pageToken* is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof AccountsApiListAccounts
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: **code**, **firstName**, **lastName**, **accountNumber**, **email**, **zipCode**, **birthDate**
+     * @type {string}
+     * @memberof AccountsApiListAccounts
+     */
+    readonly filter?: string;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.     Parameters: **firstName**, **lastName**, **accountNumber**, **email**.
+     * @type {string}
+     * @memberof AccountsApiListAccounts
+     */
+    readonly order?: string;
+    /**
+     * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.     Parameters: **policy**.
+     * @type {string}
+     * @memberof AccountsApiListAccounts
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateAccount operation in AccountsApi.
+ * @export
+ * @interface AccountsApiUpdateAccountRequest
+ */
+export interface AccountsApiUpdateAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof AccountsApiUpdateAccount
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateAccountRequestDto}
+     * @memberof AccountsApiUpdateAccount
+     */
+    readonly updateAccountRequestDto: UpdateAccountRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof AccountsApiUpdateAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * AccountsApi - object-oriented interface
+ * @export
+ * @class AccountsApi
+ * @extends {BaseAPI}
+ */
+export declare class AccountsApi extends BaseAPI {
+    /**
+     * This will create an account in the database. Account creation is usually part      of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge     might result in an unusable account. Look into lead creation for more information.
+     * @summary Create the account
+     * @param {AccountsApiCreateAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    createAccount(requestParameters: AccountsApiCreateAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountResponseClass, any>>;
+    /**
+     * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
+     * @summary Delete the account
+     * @param {AccountsApiDeleteAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
+     * @summary Retrieve the account
+     * @param {AccountsApiGetAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    getAccount(requestParameters: AccountsApiGetAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponseClass, any>>;
+    /**
+     * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest account appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List accounts
+     * @param {AccountsApiListAccountsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    listAccounts(requestParameters?: AccountsApiListAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponseClass, any>>;
+    /**
+     * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the account
+     * @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    updateAccount(requestParameters: AccountsApiUpdateAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAccountResponseClass, any>>;
+}