yellowgrid-api-ts 3.2.226 → 3.2.228

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.
package/README.md CHANGED
@@ -66,6 +66,7 @@ Class | Method | HTTP request | Description
66
66
  *AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
67
67
  *AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance |
68
68
  *AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
69
+ *AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
69
70
  *AccountsApi* | [**getGetTcxPartnerDetails**](docs/AccountsApi.md#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner |
70
71
  *AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
71
72
  *AccountsApi* | [**patchSetAccountStatus**](docs/AccountsApi.md#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} |
package/api.ts CHANGED
@@ -9232,6 +9232,43 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
9232
9232
  options: localVarRequestOptions,
9233
9233
  };
9234
9234
  },
9235
+ /**
9236
+ * Download New Price List
9237
+ * @summary Download New Price List
9238
+ * @param {string} id Xero ID
9239
+ * @param {*} [options] Override http request option.
9240
+ * @throws {RequiredError}
9241
+ */
9242
+ getGetNewPriceList: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9243
+ // verify required parameter 'id' is not null or undefined
9244
+ assertParamExists('getGetNewPriceList', 'id', id)
9245
+ const localVarPath = `/admin/accounts/priceList/new`;
9246
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9247
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9248
+ let baseOptions;
9249
+ if (configuration) {
9250
+ baseOptions = configuration.baseOptions;
9251
+ }
9252
+
9253
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9254
+ const localVarHeaderParameter = {} as any;
9255
+ const localVarQueryParameter = {} as any;
9256
+
9257
+ if (id !== undefined) {
9258
+ localVarQueryParameter['id'] = id;
9259
+ }
9260
+
9261
+ localVarHeaderParameter['Accept'] = 'text/csv';
9262
+
9263
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9264
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9265
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9266
+
9267
+ return {
9268
+ url: toPathString(localVarUrlObj),
9269
+ options: localVarRequestOptions,
9270
+ };
9271
+ },
9235
9272
  /**
9236
9273
  * Get Account 3CX Details
9237
9274
  * @param {string} id Xero ID
@@ -10524,6 +10561,19 @@ export const AccountsApiFp = function(configuration?: Configuration) {
10524
10561
  const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetLastAccount']?.[localVarOperationServerIndex]?.url;
10525
10562
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10526
10563
  },
10564
+ /**
10565
+ * Download New Price List
10566
+ * @summary Download New Price List
10567
+ * @param {string} id Xero ID
10568
+ * @param {*} [options] Override http request option.
10569
+ * @throws {RequiredError}
10570
+ */
10571
+ async getGetNewPriceList(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
10572
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetNewPriceList(id, options);
10573
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10574
+ const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetNewPriceList']?.[localVarOperationServerIndex]?.url;
10575
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10576
+ },
10527
10577
  /**
10528
10578
  * Get Account 3CX Details
10529
10579
  * @param {string} id Xero ID
@@ -11081,6 +11131,16 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
11081
11131
  getGetLastAccount(options?: RawAxiosRequestConfig): AxiosPromise<AccountSummaryDTO> {
11082
11132
  return localVarFp.getGetLastAccount(options).then((request) => request(axios, basePath));
11083
11133
  },
11134
+ /**
11135
+ * Download New Price List
11136
+ * @summary Download New Price List
11137
+ * @param {string} id Xero ID
11138
+ * @param {*} [options] Override http request option.
11139
+ * @throws {RequiredError}
11140
+ */
11141
+ getGetNewPriceList(id: string, options?: RawAxiosRequestConfig): AxiosPromise<string> {
11142
+ return localVarFp.getGetNewPriceList(id, options).then((request) => request(axios, basePath));
11143
+ },
11084
11144
  /**
11085
11145
  * Get Account 3CX Details
11086
11146
  * @param {string} id Xero ID
@@ -11558,6 +11618,17 @@ export class AccountsApi extends BaseAPI {
11558
11618
  return AccountsApiFp(this.configuration).getGetLastAccount(options).then((request) => request(this.axios, this.basePath));
11559
11619
  }
11560
11620
 
11621
+ /**
11622
+ * Download New Price List
11623
+ * @summary Download New Price List
11624
+ * @param {string} id Xero ID
11625
+ * @param {*} [options] Override http request option.
11626
+ * @throws {RequiredError}
11627
+ */
11628
+ public getGetNewPriceList(id: string, options?: RawAxiosRequestConfig) {
11629
+ return AccountsApiFp(this.configuration).getGetNewPriceList(id, options).then((request) => request(this.axios, this.basePath));
11630
+ }
11631
+
11561
11632
  /**
11562
11633
  * Get Account 3CX Details
11563
11634
  * @param {string} id Xero ID
package/dist/api.d.ts CHANGED
@@ -8727,6 +8727,14 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
8727
8727
  * @throws {RequiredError}
8728
8728
  */
8729
8729
  getGetLastAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8730
+ /**
8731
+ * Download New Price List
8732
+ * @summary Download New Price List
8733
+ * @param {string} id Xero ID
8734
+ * @param {*} [options] Override http request option.
8735
+ * @throws {RequiredError}
8736
+ */
8737
+ getGetNewPriceList: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8730
8738
  /**
8731
8739
  * Get Account 3CX Details
8732
8740
  * @param {string} id Xero ID
@@ -9095,6 +9103,14 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
9095
9103
  * @throws {RequiredError}
9096
9104
  */
9097
9105
  getGetLastAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountSummaryDTO>>;
9106
+ /**
9107
+ * Download New Price List
9108
+ * @summary Download New Price List
9109
+ * @param {string} id Xero ID
9110
+ * @param {*} [options] Override http request option.
9111
+ * @throws {RequiredError}
9112
+ */
9113
+ getGetNewPriceList(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
9098
9114
  /**
9099
9115
  * Get Account 3CX Details
9100
9116
  * @param {string} id Xero ID
@@ -9463,6 +9479,14 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
9463
9479
  * @throws {RequiredError}
9464
9480
  */
9465
9481
  getGetLastAccount(options?: RawAxiosRequestConfig): AxiosPromise<AccountSummaryDTO>;
9482
+ /**
9483
+ * Download New Price List
9484
+ * @summary Download New Price List
9485
+ * @param {string} id Xero ID
9486
+ * @param {*} [options] Override http request option.
9487
+ * @throws {RequiredError}
9488
+ */
9489
+ getGetNewPriceList(id: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
9466
9490
  /**
9467
9491
  * Get Account 3CX Details
9468
9492
  * @param {string} id Xero ID
@@ -9831,6 +9855,14 @@ export declare class AccountsApi extends BaseAPI {
9831
9855
  * @throws {RequiredError}
9832
9856
  */
9833
9857
  getGetLastAccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountSummaryDTO, any, {}>>;
9858
+ /**
9859
+ * Download New Price List
9860
+ * @summary Download New Price List
9861
+ * @param {string} id Xero ID
9862
+ * @param {*} [options] Override http request option.
9863
+ * @throws {RequiredError}
9864
+ */
9865
+ getGetNewPriceList(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
9834
9866
  /**
9835
9867
  * Get Account 3CX Details
9836
9868
  * @param {string} id Xero ID
package/dist/api.js CHANGED
@@ -1022,6 +1022,46 @@ var AccountsApiAxiosParamCreator = function (configuration) {
1022
1022
  });
1023
1023
  });
1024
1024
  },
1025
+ /**
1026
+ * Download New Price List
1027
+ * @summary Download New Price List
1028
+ * @param {string} id Xero ID
1029
+ * @param {*} [options] Override http request option.
1030
+ * @throws {RequiredError}
1031
+ */
1032
+ getGetNewPriceList: function (id_1) {
1033
+ var args_1 = [];
1034
+ for (var _i = 1; _i < arguments.length; _i++) {
1035
+ args_1[_i - 1] = arguments[_i];
1036
+ }
1037
+ return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
1038
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
1039
+ if (options === void 0) { options = {}; }
1040
+ return __generator(this, function (_a) {
1041
+ // verify required parameter 'id' is not null or undefined
1042
+ (0, common_1.assertParamExists)('getGetNewPriceList', 'id', id);
1043
+ localVarPath = "/admin/accounts/priceList/new";
1044
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1045
+ if (configuration) {
1046
+ baseOptions = configuration.baseOptions;
1047
+ }
1048
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
1049
+ localVarHeaderParameter = {};
1050
+ localVarQueryParameter = {};
1051
+ if (id !== undefined) {
1052
+ localVarQueryParameter['id'] = id;
1053
+ }
1054
+ localVarHeaderParameter['Accept'] = 'text/csv';
1055
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1056
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1057
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1058
+ return [2 /*return*/, {
1059
+ url: (0, common_1.toPathString)(localVarUrlObj),
1060
+ options: localVarRequestOptions,
1061
+ }];
1062
+ });
1063
+ });
1064
+ },
1025
1065
  /**
1026
1066
  * Get Account 3CX Details
1027
1067
  * @param {string} id Xero ID
@@ -2582,6 +2622,29 @@ var AccountsApiFp = function (configuration) {
2582
2622
  });
2583
2623
  });
2584
2624
  },
2625
+ /**
2626
+ * Download New Price List
2627
+ * @summary Download New Price List
2628
+ * @param {string} id Xero ID
2629
+ * @param {*} [options] Override http request option.
2630
+ * @throws {RequiredError}
2631
+ */
2632
+ getGetNewPriceList: function (id, options) {
2633
+ return __awaiter(this, void 0, void 0, function () {
2634
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
2635
+ var _a, _b, _c;
2636
+ return __generator(this, function (_d) {
2637
+ switch (_d.label) {
2638
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetNewPriceList(id, options)];
2639
+ case 1:
2640
+ localVarAxiosArgs = _d.sent();
2641
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2642
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getGetNewPriceList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2643
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
2644
+ }
2645
+ });
2646
+ });
2647
+ },
2585
2648
  /**
2586
2649
  * Get Account 3CX Details
2587
2650
  * @param {string} id Xero ID
@@ -3449,6 +3512,16 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
3449
3512
  getGetLastAccount: function (options) {
3450
3513
  return localVarFp.getGetLastAccount(options).then(function (request) { return request(axios, basePath); });
3451
3514
  },
3515
+ /**
3516
+ * Download New Price List
3517
+ * @summary Download New Price List
3518
+ * @param {string} id Xero ID
3519
+ * @param {*} [options] Override http request option.
3520
+ * @throws {RequiredError}
3521
+ */
3522
+ getGetNewPriceList: function (id, options) {
3523
+ return localVarFp.getGetNewPriceList(id, options).then(function (request) { return request(axios, basePath); });
3524
+ },
3452
3525
  /**
3453
3526
  * Get Account 3CX Details
3454
3527
  * @param {string} id Xero ID
@@ -3930,6 +4003,17 @@ var AccountsApi = /** @class */ (function (_super) {
3930
4003
  var _this = this;
3931
4004
  return (0, exports.AccountsApiFp)(this.configuration).getGetLastAccount(options).then(function (request) { return request(_this.axios, _this.basePath); });
3932
4005
  };
4006
+ /**
4007
+ * Download New Price List
4008
+ * @summary Download New Price List
4009
+ * @param {string} id Xero ID
4010
+ * @param {*} [options] Override http request option.
4011
+ * @throws {RequiredError}
4012
+ */
4013
+ AccountsApi.prototype.getGetNewPriceList = function (id, options) {
4014
+ var _this = this;
4015
+ return (0, exports.AccountsApiFp)(this.configuration).getGetNewPriceList(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
4016
+ };
3933
4017
  /**
3934
4018
  * Get Account 3CX Details
3935
4019
  * @param {string} id Xero ID
@@ -19,6 +19,7 @@ All URIs are relative to *https://bitbucket.org*
19
19
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
20
20
  |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
21
21
  |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
22
+ |[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
22
23
  |[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
23
24
  |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
24
25
  |[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
@@ -838,6 +839,60 @@ No authorization required
838
839
 
839
840
  [[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)
840
841
 
842
+ # **getGetNewPriceList**
843
+ > string getGetNewPriceList()
844
+
845
+ Download New Price List
846
+
847
+ ### Example
848
+
849
+ ```typescript
850
+ import {
851
+ AccountsApi,
852
+ Configuration
853
+ } from 'yellowgrid-api-ts';
854
+
855
+ const configuration = new Configuration();
856
+ const apiInstance = new AccountsApi(configuration);
857
+
858
+ let id: string; //Xero ID (default to undefined)
859
+
860
+ const { status, data } = await apiInstance.getGetNewPriceList(
861
+ id
862
+ );
863
+ ```
864
+
865
+ ### Parameters
866
+
867
+ |Name | Type | Description | Notes|
868
+ |------------- | ------------- | ------------- | -------------|
869
+ | **id** | [**string**] | Xero ID | defaults to undefined|
870
+
871
+
872
+ ### Return type
873
+
874
+ **string**
875
+
876
+ ### Authorization
877
+
878
+ No authorization required
879
+
880
+ ### HTTP request headers
881
+
882
+ - **Content-Type**: Not defined
883
+ - **Accept**: text/csv
884
+
885
+
886
+ ### HTTP response details
887
+ | Status code | Description | Response headers |
888
+ |-------------|-------------|------------------|
889
+ |**200** | Price List | - |
890
+ |**400** | Bad Request | - |
891
+ |**401** | Unauthorised | - |
892
+ |**403** | Access Denied | - |
893
+
894
+ [[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)
895
+
841
896
  # **getGetTcxPartnerDetails**
842
897
  > PartnerDTO getGetTcxPartnerDetails()
843
898
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.226",
3
+ "version": "3.2.228",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {