yellowgrid-api-ts 3.2.208-dev.0 → 3.2.209-dev.0

package/.openapi-generator/FILES

@@ -64,6 +64,7 @@ docs/CrmContactDTO.md
 docs/CrmDateActivitiesDTO.md
 docs/CrmNoteEntity.md
 docs/CrmNoteModel.md
+docs/CustomerCoordinatesDTO.md
 docs/CustomerInformationModel.md
 docs/CustomerItemRequestDTO.md
 docs/CustomerListAccountDTO.md

package/README.md

@@ -64,6 +64,7 @@ Class | Method | HTTP request | Description
 *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* | [**getGetCustomerMap**](docs/AccountsApi.md#getgetcustomermap) | **GET** /admin/accounts/customer/map | 
 *AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | 
 *AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
 *AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
@@ -382,6 +383,7 @@ Class | Method | HTTP request | Description
  - [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
  - [CrmNoteEntity](docs/CrmNoteEntity.md)
  - [CrmNoteModel](docs/CrmNoteModel.md)
+ - [CustomerCoordinatesDTO](docs/CustomerCoordinatesDTO.md)
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
  - [CustomerListAccountDTO](docs/CustomerListAccountDTO.md)

package/api.ts

@@ -2772,6 +2772,49 @@ export interface CrmNoteModel {
      */
     'callId'?: number;
 }
+/**
+ * Customer Coordinates
+ * @export
+ * @interface CustomerCoordinatesDTO
+ */
+export interface CustomerCoordinatesDTO {
+    /**
+     * ID
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'id'?: string;
+    /**
+     * Company
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'company'?: string;
+    /**
+     * 3CX Reseller ID
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'resellerId'?: string | null;
+    /**
+     * Post Code
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'postCode'?: string;
+    /**
+     * Latitude
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'latitude'?: string;
+    /**
+     * Longitude
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'longitude'?: string;
+}
 /**
  * SIP Trunk Customer
  * @export
@@ -6997,7 +7040,8 @@ export const PatchUpdateTcxHostingPriceListRequestPriceListEnum = {
     _3: '3',
     _4: '4',
     _5: '5',
-    _6: '6'
+    _6: '6',
+    _7: '7'
 } as const;
 
 export type PatchUpdateTcxHostingPriceListRequestPriceListEnum = typeof PatchUpdateTcxHostingPriceListRequestPriceListEnum[keyof typeof PatchUpdateTcxHostingPriceListRequestPriceListEnum];
@@ -11268,6 +11312,12 @@ export interface SupportTicketModel {
  * @interface TableDTO
  */
 export interface TableDTO {
+    /**
+     * Title
+     * @type {string}
+     * @memberof TableDTO
+     */
+    'title'?: string;
     /**
      * 
      * @type {TableRowDTO}
@@ -14159,6 +14209,35 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get Customer Map
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerMap: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/admin/accounts/customer/map`;
+            // 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;
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -15579,6 +15658,17 @@ 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 Customer Map
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerCoordinatesDTO>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCustomerMap(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetCustomerMap']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Account Finance
          * @param {string} id Account Xero ID
@@ -16156,6 +16246,14 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
         getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>> {
             return localVarFp.getGetCustomerKeys(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Customer Map
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerMap(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerCoordinatesDTO>> {
+            return localVarFp.getGetCustomerMap(options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Account Finance
          * @param {string} id Account Xero ID
@@ -16657,6 +16755,16 @@ export class AccountsApi extends BaseAPI {
         return AccountsApiFp(this.configuration).getGetCustomerKeys(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    public getGetCustomerMap(options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).getGetCustomerMap(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID

package/dist/api.d.ts

@@ -2746,6 +2746,49 @@ export interface CrmNoteModel {
      */
     'callId'?: number;
 }
+/**
+ * Customer Coordinates
+ * @export
+ * @interface CustomerCoordinatesDTO
+ */
+export interface CustomerCoordinatesDTO {
+    /**
+     * ID
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'id'?: string;
+    /**
+     * Company
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'company'?: string;
+    /**
+     * 3CX Reseller ID
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'resellerId'?: string | null;
+    /**
+     * Post Code
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'postCode'?: string;
+    /**
+     * Latitude
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'latitude'?: string;
+    /**
+     * Longitude
+     * @type {string}
+     * @memberof CustomerCoordinatesDTO
+     */
+    'longitude'?: string;
+}
 /**
  * SIP Trunk Customer
  * @export
@@ -6937,6 +6980,7 @@ export declare const PatchUpdateTcxHostingPriceListRequestPriceListEnum: {
     readonly _4: "4";
     readonly _5: "5";
     readonly _6: "6";
+    readonly _7: "7";
 };
 export type PatchUpdateTcxHostingPriceListRequestPriceListEnum = typeof PatchUpdateTcxHostingPriceListRequestPriceListEnum[keyof typeof PatchUpdateTcxHostingPriceListRequestPriceListEnum];
 /**
@@ -11148,6 +11192,12 @@ export interface SupportTicketModel {
  * @interface TableDTO
  */
 export interface TableDTO {
+    /**
+     * Title
+     * @type {string}
+     * @memberof TableDTO
+     */
+    'title'?: string;
     /**
      *
      * @type {TableRowDTO}
@@ -13688,6 +13738,12 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetCustomerKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -14065,6 +14121,12 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxKeySummaryDTO>>>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerCoordinatesDTO>>>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -14442,6 +14504,12 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerMap(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerCoordinatesDTO>>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID
@@ -14834,6 +14902,13 @@ export declare class AccountsApi extends BaseAPI {
      * @memberof AccountsApi
      */
     getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxKeySummaryDTO[], any, {}>>;
+    /**
+     * Get Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerCoordinatesDTO[], any, {}>>;
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID

package/dist/api.js

@@ -347,7 +347,8 @@ exports.PatchUpdateTcxHostingPriceListRequestPriceListEnum = {
     _3: '3',
     _4: '4',
     _5: '5',
-    _6: '6'
+    _6: '6',
+    _7: '7'
 };
 exports.ProspectDTOStatusEnum = {
     NoCallBackSet: 'No Call Back Set',
@@ -1040,6 +1041,38 @@ var AccountsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Customer Map
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerMap: 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/customer/map";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    (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 Account Finance
          * @param {string} id Account Xero ID
@@ -2655,6 +2688,27 @@ var AccountsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Customer Map
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerMap: 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.getGetCustomerMap(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.getGetCustomerMap']) === 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 Account Finance
          * @param {string} id Account Xero ID
@@ -3572,6 +3626,14 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
         getGetCustomerKeys: function (options) {
             return localVarFp.getGetCustomerKeys(options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Customer Map
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetCustomerMap: function (options) {
+            return localVarFp.getGetCustomerMap(options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Account Finance
          * @param {string} id Account Xero ID
@@ -4077,6 +4139,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 Customer Map
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    AccountsApi.prototype.getGetCustomerMap = function (options) {
+        var _this = this;
+        return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerMap(options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Account Finance
      * @param {string} id Account Xero ID

package/dist/models/HostingPriceListEnum.d.ts

@@ -29,5 +29,10 @@ export declare const HostingPriceListEnum: {
         readonly value: 6;
         readonly publicValue: "Hosting Only (Wholesale)";
     };
+    readonly HOSTING_ITSP: {
+        readonly name: "HOSTING_ITSP";
+        readonly value: 7;
+        readonly publicValue: "Hosting Only (ITSP)";
+    };
 };
 export type HostingPriceListEnum = typeof HostingPriceListEnum;

package/dist/models/HostingPriceListEnum.js

@@ -31,5 +31,10 @@ exports.HostingPriceListEnum = {
         "name": "HOSTING_WHOLESALE",
         "value": 6,
         "publicValue": "Hosting Only (Wholesale)"
+    },
+    "HOSTING_ITSP": {
+        "name": "HOSTING_ITSP",
+        "value": 7,
+        "publicValue": "Hosting Only (ITSP)"
     }
 };

package/docs/AccountsApi.md

@@ -17,6 +17,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**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|
+|[**getGetCustomerMap**](#getgetcustomermap) | **GET** /admin/accounts/customer/map | |
 |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
 |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
 |[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
@@ -738,6 +739,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)
 
+# **getGetCustomerMap**
+> Array<CustomerCoordinatesDTO> getGetCustomerMap()
+
+Get Customer Map
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+const { status, data } = await apiInstance.getGetCustomerMap();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<CustomerCoordinatesDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer Coordinates |  -  |
+|**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)
+
 # **getGetFinanceSettings**
 > AccountFinanceDTO getGetFinanceSettings()
 

package/docs/CustomerCoordinatesDTO.md

@@ -0,0 +1,31 @@
+# CustomerCoordinatesDTO
+
+Customer Coordinates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID | [optional] [default to undefined]
+**company** | **string** | Company | [optional] [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**latitude** | **string** | Latitude | [optional] [default to undefined]
+**longitude** | **string** | Longitude | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerCoordinatesDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerCoordinatesDTO = {
+    id,
+    company,
+    resellerId,
+    postCode,
+    latitude,
+    longitude,
+};
+```
+
+[[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/docs/TableDTO.md

@@ -6,6 +6,7 @@ Table
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
 **headers** | [**TableRowDTO**](TableRowDTO.md) |  | [optional] [default to undefined]
 **rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
 
@@ -15,6 +16,7 @@ Name | Type | Description | Notes
 import { TableDTO } from 'yellowgrid-api-ts';
 
 const instance: TableDTO = {
+    title,
     headers,
     rows,
 };

package/models/HostingPriceListEnum.ts

@@ -28,6 +28,11 @@ export const HostingPriceListEnum = {
         "name": "HOSTING_WHOLESALE",
         "value": 6,
         "publicValue": "Hosting Only (Wholesale)"
+    },
+    "HOSTING_ITSP": {
+        "name": "HOSTING_ITSP",
+        "value": 7,
+        "publicValue": "Hosting Only (ITSP)"
     }
 } as const;
 

package/package.json

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