yellowgrid-api-ts 3.2.154 → 3.2.155

package/.openapi-generator/FILES

@@ -65,6 +65,7 @@ docs/CrmNoteEntity.md
 docs/CrmNoteModel.md
 docs/CustomerInformationModel.md
 docs/CustomerItemRequestDTO.md
+docs/CustomerListAccountDTO.md
 docs/CustomerOrderRequestDTO.md
 docs/CustomerPriceListEnum.md
 docs/CustomerSummaryReportDTO.md

package/README.md

@@ -62,6 +62,7 @@ Class | Method | HTTP request | Description
 *AccountsApi* | [**getGetAccountDetailedSummary**](docs/AccountsApi.md#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary
 *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* | [**getGetCustomerAccountsList**](docs/AccountsApi.md#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | 
 *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* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
@@ -363,6 +364,7 @@ Class | Method | HTTP request | Description
  - [CrmNoteModel](docs/CrmNoteModel.md)
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
+ - [CustomerListAccountDTO](docs/CustomerListAccountDTO.md)
  - [CustomerOrderRequestDTO](docs/CustomerOrderRequestDTO.md)
  - [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
  - [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)

package/api.ts

@@ -1921,6 +1921,31 @@ export interface CustomerItemRequestDTO {
      */
     'readOnly'?: boolean;
 }
+/**
+ * Customer List Account
+ */
+export interface CustomerListAccountDTO {
+    /**
+     * ID
+     */
+    'id'?: number;
+    /**
+     * Xero ID
+     */
+    'xeroId'?: string;
+    /**
+     * Account Number
+     */
+    'accountNumber'?: string;
+    /**
+     * Company Name
+     */
+    'company'?: string;
+    /**
+     * Associated Email Domains
+     */
+    'domains'?: Array<string>;
+}
 /**
  * Order Request
  */
@@ -8917,6 +8942,35 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Customer Accounts List
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerAccountsList: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/admin/accounts/customers/list`;
+            // 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,
+            };
+        },
         /**
          * Get 3CX Keys
          * @summary Get 3CX Keys
@@ -10147,6 +10201,17 @@ export const AccountsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetClientCredentials']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Customer Accounts List
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetCustomerAccountsList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerListAccountDTO>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCustomerAccountsList(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetCustomerAccountsList']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get 3CX Keys
          * @summary Get 3CX Keys
@@ -10666,6 +10731,14 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
         getGetClientCredentials(options?: RawAxiosRequestConfig): AxiosPromise<Array<ClientModel>> {
             return localVarFp.getGetClientCredentials(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Customer Accounts List
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerAccountsList(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerListAccountDTO>> {
+            return localVarFp.getGetCustomerAccountsList(options).then((request) => request(axios, basePath));
+        },
         /**
          * Get 3CX Keys
          * @summary Get 3CX Keys
@@ -11101,6 +11174,15 @@ export class AccountsApi extends BaseAPI {
         return AccountsApiFp(this.configuration).getGetClientCredentials(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetCustomerAccountsList(options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).getGetCustomerAccountsList(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys

package/dist/api.d.ts

@@ -1898,6 +1898,31 @@ export interface CustomerItemRequestDTO {
      */
     'readOnly'?: boolean;
 }
+/**
+ * Customer List Account
+ */
+export interface CustomerListAccountDTO {
+    /**
+     * ID
+     */
+    'id'?: number;
+    /**
+     * Xero ID
+     */
+    'xeroId'?: string;
+    /**
+     * Account Number
+     */
+    'accountNumber'?: string;
+    /**
+     * Company Name
+     */
+    'company'?: string;
+    /**
+     * Associated Email Domains
+     */
+    'domains'?: Array<string>;
+}
 /**
  * Order Request
  */
@@ -8507,6 +8532,12 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetClientCredentials: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys
@@ -8845,6 +8876,12 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetClientCredentials(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ClientModel>>>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerListAccountDTO>>>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys
@@ -9183,6 +9220,12 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetClientCredentials(options?: RawAxiosRequestConfig): AxiosPromise<Array<ClientModel>>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerListAccountDTO>>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys
@@ -9521,6 +9564,12 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetClientCredentials(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientModel[], any, {}>>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerListAccountDTO[], any, {}>>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys

package/dist/api.js

@@ -876,6 +876,39 @@ var AccountsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Customer Accounts List
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerAccountsList: function () {
+            var args_1 = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args_1[_i] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    localVarPath = "/admin/accounts/customers/list";
+                    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,
+                        }];
+                });
+            });
+        },
         /**
          * Get 3CX Keys
          * @summary Get 3CX Keys
@@ -2334,6 +2367,27 @@ var AccountsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Customer Accounts List
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerAccountsList: function (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.getGetCustomerAccountsList(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.getGetCustomerAccountsList']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Get 3CX Keys
          * @summary Get 3CX Keys
@@ -3163,6 +3217,14 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
         getGetClientCredentials: function (options) {
             return localVarFp.getGetClientCredentials(options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Customer Accounts List
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerAccountsList: function (options) {
+            return localVarFp.getGetCustomerAccountsList(options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get 3CX Keys
          * @summary Get 3CX Keys
@@ -3602,6 +3664,15 @@ var AccountsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.AccountsApiFp)(this.configuration).getGetClientCredentials(options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    AccountsApi.prototype.getGetCustomerAccountsList = function (options) {
+        var _this = this;
+        return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerAccountsList(options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys

package/docs/AccountsApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
 |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
+|[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
 |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
 |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
@@ -639,6 +640,53 @@ 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)
 
+# **getGetCustomerAccountsList**
+> Array<CustomerListAccountDTO> getGetCustomerAccountsList()
+
+Get Customer Accounts List
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+const { status, data } = await apiInstance.getGetCustomerAccountsList();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<CustomerListAccountDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account Addresses |  -  |
+|**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)
+
 # **getGetCustomerKeys**
 > Array<TcxKeySummaryDTO> getGetCustomerKeys()
 

package/docs/CustomerListAccountDTO.md

@@ -0,0 +1,29 @@
+# CustomerListAccountDTO
+
+Customer List Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**accountNumber** | **string** | Account Number | [optional] [default to undefined]
+**company** | **string** | Company Name | [optional] [default to undefined]
+**domains** | **Array<string>** | Associated Email Domains | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerListAccountDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerListAccountDTO = {
+    id,
+    xeroId,
+    accountNumber,
+    company,
+    domains,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.154",
+  "version": "3.2.155",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {