yellowgrid-api-ts 3.2.140-dev.0 → 3.2.142-dev.0

package/README.md

@@ -63,6 +63,7 @@ Class | Method | HTTP request | Description
 *AccountsApi* | [**getGetAccounts**](docs/AccountsApi.md#getgetaccounts) | **GET** /accounts | Get Accounts
 *AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
 *AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
+*AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | 
 *AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
 *AccountsApi* | [**patchSetPortalAccess**](docs/AccountsApi.md#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | 
 *AccountsApi* | [**patchSetPrizePromo**](docs/AccountsApi.md#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | 

package/api.ts

@@ -8707,6 +8707,39 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Account Finance
+         * @param {string} id Account Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetFinanceSettings: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetFinanceSettings', 'id', id)
+            const localVarPath = `/admin/accounts/{id}/finance`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -9751,6 +9784,18 @@ export const AccountsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetCustomerKeys']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Account Finance
+         * @param {string} id Account Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetFinanceSettings(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetFinanceSettings']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -10205,6 +10250,15 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
         getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>> {
             return localVarFp.getGetCustomerKeys(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Account Finance
+         * @param {string} id Account Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO> {
+            return localVarFp.getGetFinanceSettings(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -10594,6 +10648,16 @@ export class AccountsApi extends BaseAPI {
         return AccountsApiFp(this.configuration).getGetCustomerKeys(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).getGetFinanceSettings(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Verify account email address
      * @summary Verify account email address

package/dist/api.d.ts

@@ -8281,6 +8281,13 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetCustomerKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetFinanceSettings: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Verify account email address
      * @summary Verify account email address
@@ -8582,6 +8589,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxKeySummaryDTO>>>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
     /**
      * Verify account email address
      * @summary Verify account email address
@@ -8883,6 +8897,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
     /**
      * Verify account email address
      * @summary Verify account email address
@@ -9184,6 +9205,13 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxKeySummaryDTO[], any, {}>>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
     /**
      * Verify account email address
      * @summary Verify account email address

package/dist/api.js

@@ -890,6 +890,43 @@ var AccountsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Account Finance
+         * @param {string} id Account Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetFinanceSettings: function (id_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('getGetFinanceSettings', 'id', id);
+                    localVarPath = "/admin/accounts/{id}/finance"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -2148,6 +2185,28 @@ var AccountsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Account Finance
+         * @param {string} id Account Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetFinanceSettings: function (id, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetFinanceSettings(id, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getGetFinanceSettings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -2852,6 +2911,15 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
         getGetCustomerKeys: function (options) {
             return localVarFp.getGetCustomerKeys(options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Account Finance
+         * @param {string} id Account Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetFinanceSettings: function (id, options) {
+            return localVarFp.getGetFinanceSettings(id, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -3245,6 +3313,16 @@ var AccountsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerKeys(options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    AccountsApi.prototype.getGetFinanceSettings = function (id, options) {
+        var _this = this;
+        return (0, exports.AccountsApiFp)(this.configuration).getGetFinanceSettings(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Verify account email address
      * @summary Verify account email address

package/docs/AccountsApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *https://localhost*
 |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
+|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
 |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
 |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
@@ -681,6 +682,60 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getGetFinanceSettings**
+> AccountFinanceDTO getGetFinanceSettings()
+
+Get Account Finance
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Account Xero ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetFinanceSettings(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Account Xero ID | defaults to undefined|
+
+
+### Return type
+
+**AccountFinanceDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts Finance Details |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getVerifyEmailAddress**
 > getVerifyEmailAddress()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.140-dev.0",
+  "version": "3.2.142-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {