yellowgrid-api-ts 3.2.240 → 3.2.241

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -65,6 +65,7 @@ docs/CrmContactDTO.md
65
65
  docs/CrmDateActivitiesDTO.md
66
66
  docs/CrmNoteEntity.md
67
67
  docs/CrmNoteModel.md
68
+ docs/CustomerCoordinatesDTO.md
68
69
  docs/CustomerInformationModel.md
69
70
  docs/CustomerItemRequestDTO.md
70
71
  docs/CustomerListAccountDTO.md
package/README.md CHANGED
@@ -64,6 +64,7 @@ Class | Method | HTTP request | Description
64
64
  *AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
65
65
  *AccountsApi* | [**getGetCustomerAccountsList**](docs/AccountsApi.md#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list |
66
66
  *AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
67
+ *AccountsApi* | [**getGetCustomerMap**](docs/AccountsApi.md#getgetcustomermap) | **GET** /admin/accounts/customer/map |
67
68
  *AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance |
68
69
  *AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
69
70
  *AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
@@ -382,6 +383,7 @@ Class | Method | HTTP request | Description
382
383
  - [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
383
384
  - [CrmNoteEntity](docs/CrmNoteEntity.md)
384
385
  - [CrmNoteModel](docs/CrmNoteModel.md)
386
+ - [CustomerCoordinatesDTO](docs/CustomerCoordinatesDTO.md)
385
387
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
386
388
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
387
389
  - [CustomerListAccountDTO](docs/CustomerListAccountDTO.md)
package/api.ts CHANGED
@@ -1894,6 +1894,35 @@ export interface CrmNoteModel {
1894
1894
  */
1895
1895
  'callId'?: number;
1896
1896
  }
1897
+ /**
1898
+ * Customer Coordinates
1899
+ */
1900
+ export interface CustomerCoordinatesDTO {
1901
+ /**
1902
+ * ID
1903
+ */
1904
+ 'id'?: string;
1905
+ /**
1906
+ * Company
1907
+ */
1908
+ 'company'?: string;
1909
+ /**
1910
+ * 3CX Reseller ID
1911
+ */
1912
+ 'resellerId'?: string | null;
1913
+ /**
1914
+ * Post Code
1915
+ */
1916
+ 'postCode'?: string;
1917
+ /**
1918
+ * Latitude
1919
+ */
1920
+ 'latitude'?: string;
1921
+ /**
1922
+ * Longitude
1923
+ */
1924
+ 'longitude'?: string;
1925
+ }
1897
1926
  /**
1898
1927
  * SIP Trunk Customer
1899
1928
  */
@@ -9621,6 +9650,35 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
9621
9650
  options: localVarRequestOptions,
9622
9651
  };
9623
9652
  },
9653
+ /**
9654
+ * Get Customer Map
9655
+ * @param {*} [options] Override http request option.
9656
+ * @throws {RequiredError}
9657
+ */
9658
+ getGetCustomerMap: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9659
+ const localVarPath = `/admin/accounts/customer/map`;
9660
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9661
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9662
+ let baseOptions;
9663
+ if (configuration) {
9664
+ baseOptions = configuration.baseOptions;
9665
+ }
9666
+
9667
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9668
+ const localVarHeaderParameter = {} as any;
9669
+ const localVarQueryParameter = {} as any;
9670
+
9671
+ localVarHeaderParameter['Accept'] = 'application/json';
9672
+
9673
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9674
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9675
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9676
+
9677
+ return {
9678
+ url: toPathString(localVarUrlObj),
9679
+ options: localVarRequestOptions,
9680
+ };
9681
+ },
9624
9682
  /**
9625
9683
  * Get Account Finance
9626
9684
  * @param {string} id Account Xero ID
@@ -10989,6 +11047,17 @@ export const AccountsApiFp = function(configuration?: Configuration) {
10989
11047
  const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetCustomerKeys']?.[localVarOperationServerIndex]?.url;
10990
11048
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10991
11049
  },
11050
+ /**
11051
+ * Get Customer Map
11052
+ * @param {*} [options] Override http request option.
11053
+ * @throws {RequiredError}
11054
+ */
11055
+ async getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerCoordinatesDTO>>> {
11056
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCustomerMap(options);
11057
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11058
+ const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetCustomerMap']?.[localVarOperationServerIndex]?.url;
11059
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11060
+ },
10992
11061
  /**
10993
11062
  * Get Account Finance
10994
11063
  * @param {string} id Account Xero ID
@@ -11565,6 +11634,14 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
11565
11634
  getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>> {
11566
11635
  return localVarFp.getGetCustomerKeys(options).then((request) => request(axios, basePath));
11567
11636
  },
11637
+ /**
11638
+ * Get Customer Map
11639
+ * @param {*} [options] Override http request option.
11640
+ * @throws {RequiredError}
11641
+ */
11642
+ getGetCustomerMap(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerCoordinatesDTO>> {
11643
+ return localVarFp.getGetCustomerMap(options).then((request) => request(axios, basePath));
11644
+ },
11568
11645
  /**
11569
11646
  * Get Account Finance
11570
11647
  * @param {string} id Account Xero ID
@@ -12050,6 +12127,15 @@ export class AccountsApi extends BaseAPI {
12050
12127
  return AccountsApiFp(this.configuration).getGetCustomerKeys(options).then((request) => request(this.axios, this.basePath));
12051
12128
  }
12052
12129
 
12130
+ /**
12131
+ * Get Customer Map
12132
+ * @param {*} [options] Override http request option.
12133
+ * @throws {RequiredError}
12134
+ */
12135
+ public getGetCustomerMap(options?: RawAxiosRequestConfig) {
12136
+ return AccountsApiFp(this.configuration).getGetCustomerMap(options).then((request) => request(this.axios, this.basePath));
12137
+ }
12138
+
12053
12139
  /**
12054
12140
  * Get Account Finance
12055
12141
  * @param {string} id Account Xero ID
package/dist/api.d.ts CHANGED
@@ -1868,6 +1868,35 @@ export interface CrmNoteModel {
1868
1868
  */
1869
1869
  'callId'?: number;
1870
1870
  }
1871
+ /**
1872
+ * Customer Coordinates
1873
+ */
1874
+ export interface CustomerCoordinatesDTO {
1875
+ /**
1876
+ * ID
1877
+ */
1878
+ 'id'?: string;
1879
+ /**
1880
+ * Company
1881
+ */
1882
+ 'company'?: string;
1883
+ /**
1884
+ * 3CX Reseller ID
1885
+ */
1886
+ 'resellerId'?: string | null;
1887
+ /**
1888
+ * Post Code
1889
+ */
1890
+ 'postCode'?: string;
1891
+ /**
1892
+ * Latitude
1893
+ */
1894
+ 'latitude'?: string;
1895
+ /**
1896
+ * Longitude
1897
+ */
1898
+ 'longitude'?: string;
1899
+ }
1871
1900
  /**
1872
1901
  * SIP Trunk Customer
1873
1902
  */
@@ -9145,6 +9174,12 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
9145
9174
  * @throws {RequiredError}
9146
9175
  */
9147
9176
  getGetCustomerKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9177
+ /**
9178
+ * Get Customer Map
9179
+ * @param {*} [options] Override http request option.
9180
+ * @throws {RequiredError}
9181
+ */
9182
+ getGetCustomerMap: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9148
9183
  /**
9149
9184
  * Get Account Finance
9150
9185
  * @param {string} id Account Xero ID
@@ -9521,6 +9556,12 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
9521
9556
  * @throws {RequiredError}
9522
9557
  */
9523
9558
  getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxKeySummaryDTO>>>;
9559
+ /**
9560
+ * Get Customer Map
9561
+ * @param {*} [options] Override http request option.
9562
+ * @throws {RequiredError}
9563
+ */
9564
+ getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerCoordinatesDTO>>>;
9524
9565
  /**
9525
9566
  * Get Account Finance
9526
9567
  * @param {string} id Account Xero ID
@@ -9897,6 +9938,12 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
9897
9938
  * @throws {RequiredError}
9898
9939
  */
9899
9940
  getGetCustomerKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxKeySummaryDTO>>;
9941
+ /**
9942
+ * Get Customer Map
9943
+ * @param {*} [options] Override http request option.
9944
+ * @throws {RequiredError}
9945
+ */
9946
+ getGetCustomerMap(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerCoordinatesDTO>>;
9900
9947
  /**
9901
9948
  * Get Account Finance
9902
9949
  * @param {string} id Account Xero ID
@@ -10273,6 +10320,12 @@ export declare class AccountsApi extends BaseAPI {
10273
10320
  * @throws {RequiredError}
10274
10321
  */
10275
10322
  getGetCustomerKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxKeySummaryDTO[], any, {}>>;
10323
+ /**
10324
+ * Get Customer Map
10325
+ * @param {*} [options] Override http request option.
10326
+ * @throws {RequiredError}
10327
+ */
10328
+ getGetCustomerMap(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerCoordinatesDTO[], any, {}>>;
10276
10329
  /**
10277
10330
  * Get Account Finance
10278
10331
  * @param {string} id Account Xero ID
package/dist/api.js CHANGED
@@ -1048,6 +1048,39 @@ var AccountsApiAxiosParamCreator = function (configuration) {
1048
1048
  });
1049
1049
  });
1050
1050
  },
1051
+ /**
1052
+ * Get Customer Map
1053
+ * @param {*} [options] Override http request option.
1054
+ * @throws {RequiredError}
1055
+ */
1056
+ getGetCustomerMap: function () {
1057
+ var args_1 = [];
1058
+ for (var _i = 0; _i < arguments.length; _i++) {
1059
+ args_1[_i] = arguments[_i];
1060
+ }
1061
+ return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
1062
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
1063
+ if (options === void 0) { options = {}; }
1064
+ return __generator(this, function (_a) {
1065
+ localVarPath = "/admin/accounts/customer/map";
1066
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1067
+ if (configuration) {
1068
+ baseOptions = configuration.baseOptions;
1069
+ }
1070
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
1071
+ localVarHeaderParameter = {};
1072
+ localVarQueryParameter = {};
1073
+ localVarHeaderParameter['Accept'] = 'application/json';
1074
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1075
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1076
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1077
+ return [2 /*return*/, {
1078
+ url: (0, common_1.toPathString)(localVarUrlObj),
1079
+ options: localVarRequestOptions,
1080
+ }];
1081
+ });
1082
+ });
1083
+ },
1051
1084
  /**
1052
1085
  * Get Account Finance
1053
1086
  * @param {string} id Account Xero ID
@@ -2675,6 +2708,27 @@ var AccountsApiFp = function (configuration) {
2675
2708
  });
2676
2709
  });
2677
2710
  },
2711
+ /**
2712
+ * Get Customer Map
2713
+ * @param {*} [options] Override http request option.
2714
+ * @throws {RequiredError}
2715
+ */
2716
+ getGetCustomerMap: function (options) {
2717
+ return __awaiter(this, void 0, void 0, function () {
2718
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
2719
+ var _a, _b, _c;
2720
+ return __generator(this, function (_d) {
2721
+ switch (_d.label) {
2722
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCustomerMap(options)];
2723
+ case 1:
2724
+ localVarAxiosArgs = _d.sent();
2725
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2726
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getGetCustomerMap']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2727
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
2728
+ }
2729
+ });
2730
+ });
2731
+ },
2678
2732
  /**
2679
2733
  * Get Account Finance
2680
2734
  * @param {string} id Account Xero ID
@@ -3591,6 +3645,14 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
3591
3645
  getGetCustomerKeys: function (options) {
3592
3646
  return localVarFp.getGetCustomerKeys(options).then(function (request) { return request(axios, basePath); });
3593
3647
  },
3648
+ /**
3649
+ * Get Customer Map
3650
+ * @param {*} [options] Override http request option.
3651
+ * @throws {RequiredError}
3652
+ */
3653
+ getGetCustomerMap: function (options) {
3654
+ return localVarFp.getGetCustomerMap(options).then(function (request) { return request(axios, basePath); });
3655
+ },
3594
3656
  /**
3595
3657
  * Get Account Finance
3596
3658
  * @param {string} id Account Xero ID
@@ -4080,6 +4142,15 @@ var AccountsApi = /** @class */ (function (_super) {
4080
4142
  var _this = this;
4081
4143
  return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerKeys(options).then(function (request) { return request(_this.axios, _this.basePath); });
4082
4144
  };
4145
+ /**
4146
+ * Get Customer Map
4147
+ * @param {*} [options] Override http request option.
4148
+ * @throws {RequiredError}
4149
+ */
4150
+ AccountsApi.prototype.getGetCustomerMap = function (options) {
4151
+ var _this = this;
4152
+ return (0, exports.AccountsApiFp)(this.configuration).getGetCustomerMap(options).then(function (request) { return request(_this.axios, _this.basePath); });
4153
+ };
4083
4154
  /**
4084
4155
  * Get Account Finance
4085
4156
  * @param {string} id Account Xero ID
@@ -17,6 +17,7 @@ All URIs are relative to *https://bitbucket.org*
17
17
  |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\&#39;s client credentials|
18
18
  |[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
19
19
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
20
+ |[**getGetCustomerMap**](#getgetcustomermap) | **GET** /admin/accounts/customer/map | |
20
21
  |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
21
22
  |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
22
23
  |[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
@@ -738,6 +739,53 @@ No authorization required
738
739
 
739
740
  [[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)
740
741
 
742
+ # **getGetCustomerMap**
743
+ > Array<CustomerCoordinatesDTO> getGetCustomerMap()
744
+
745
+ Get Customer Map
746
+
747
+ ### Example
748
+
749
+ ```typescript
750
+ import {
751
+ AccountsApi,
752
+ Configuration
753
+ } from 'yellowgrid-api-ts';
754
+
755
+ const configuration = new Configuration();
756
+ const apiInstance = new AccountsApi(configuration);
757
+
758
+ const { status, data } = await apiInstance.getGetCustomerMap();
759
+ ```
760
+
761
+ ### Parameters
762
+ This endpoint does not have any parameters.
763
+
764
+
765
+ ### Return type
766
+
767
+ **Array<CustomerCoordinatesDTO>**
768
+
769
+ ### Authorization
770
+
771
+ No authorization required
772
+
773
+ ### HTTP request headers
774
+
775
+ - **Content-Type**: Not defined
776
+ - **Accept**: application/json
777
+
778
+
779
+ ### HTTP response details
780
+ | Status code | Description | Response headers |
781
+ |-------------|-------------|------------------|
782
+ |**200** | Customer Coordinates | - |
783
+ |**400** | Bad Request | - |
784
+ |**401** | Unauthorised | - |
785
+ |**403** | Access Denied | - |
786
+
787
+ [[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)
788
+
741
789
  # **getGetFinanceSettings**
742
790
  > AccountFinanceDTO getGetFinanceSettings()
743
791
 
@@ -0,0 +1,31 @@
1
+ # CustomerCoordinatesDTO
2
+
3
+ Customer Coordinates
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | ID | [optional] [default to undefined]
10
+ **company** | **string** | Company | [optional] [default to undefined]
11
+ **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
12
+ **postCode** | **string** | Post Code | [optional] [default to undefined]
13
+ **latitude** | **string** | Latitude | [optional] [default to undefined]
14
+ **longitude** | **string** | Longitude | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { CustomerCoordinatesDTO } from 'yellowgrid-api-ts';
20
+
21
+ const instance: CustomerCoordinatesDTO = {
22
+ id,
23
+ company,
24
+ resellerId,
25
+ postCode,
26
+ latitude,
27
+ longitude,
28
+ };
29
+ ```
30
+
31
+ [[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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.240",
3
+ "version": "3.2.241",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {