yellowgrid-api-ts 3.2.225 → 3.2.227
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 +1 -0
- package/api.ts +61 -0
- package/dist/api.d.ts +28 -0
- package/dist/api.js +75 -0
- package/docs/AccountsApi.md +48 -0
- package/package.json +1 -1
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,36 @@ 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 {*} [options] Override http request option.
|
|
9239
|
+
* @throws {RequiredError}
|
|
9240
|
+
*/
|
|
9241
|
+
getGetNewPriceList: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9242
|
+
const localVarPath = `/admin/accounts/priceList/new`;
|
|
9243
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9244
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9245
|
+
let baseOptions;
|
|
9246
|
+
if (configuration) {
|
|
9247
|
+
baseOptions = configuration.baseOptions;
|
|
9248
|
+
}
|
|
9249
|
+
|
|
9250
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
9251
|
+
const localVarHeaderParameter = {} as any;
|
|
9252
|
+
const localVarQueryParameter = {} as any;
|
|
9253
|
+
|
|
9254
|
+
localVarHeaderParameter['Accept'] = 'text/csv';
|
|
9255
|
+
|
|
9256
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9257
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9258
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9259
|
+
|
|
9260
|
+
return {
|
|
9261
|
+
url: toPathString(localVarUrlObj),
|
|
9262
|
+
options: localVarRequestOptions,
|
|
9263
|
+
};
|
|
9264
|
+
},
|
|
9235
9265
|
/**
|
|
9236
9266
|
* Get Account 3CX Details
|
|
9237
9267
|
* @param {string} id Xero ID
|
|
@@ -10524,6 +10554,18 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
10524
10554
|
const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetLastAccount']?.[localVarOperationServerIndex]?.url;
|
|
10525
10555
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10526
10556
|
},
|
|
10557
|
+
/**
|
|
10558
|
+
* Download New Price List
|
|
10559
|
+
* @summary Download New Price List
|
|
10560
|
+
* @param {*} [options] Override http request option.
|
|
10561
|
+
* @throws {RequiredError}
|
|
10562
|
+
*/
|
|
10563
|
+
async getGetNewPriceList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
10564
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetNewPriceList(options);
|
|
10565
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10566
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetNewPriceList']?.[localVarOperationServerIndex]?.url;
|
|
10567
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10568
|
+
},
|
|
10527
10569
|
/**
|
|
10528
10570
|
* Get Account 3CX Details
|
|
10529
10571
|
* @param {string} id Xero ID
|
|
@@ -11081,6 +11123,15 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
11081
11123
|
getGetLastAccount(options?: RawAxiosRequestConfig): AxiosPromise<AccountSummaryDTO> {
|
|
11082
11124
|
return localVarFp.getGetLastAccount(options).then((request) => request(axios, basePath));
|
|
11083
11125
|
},
|
|
11126
|
+
/**
|
|
11127
|
+
* Download New Price List
|
|
11128
|
+
* @summary Download New Price List
|
|
11129
|
+
* @param {*} [options] Override http request option.
|
|
11130
|
+
* @throws {RequiredError}
|
|
11131
|
+
*/
|
|
11132
|
+
getGetNewPriceList(options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
11133
|
+
return localVarFp.getGetNewPriceList(options).then((request) => request(axios, basePath));
|
|
11134
|
+
},
|
|
11084
11135
|
/**
|
|
11085
11136
|
* Get Account 3CX Details
|
|
11086
11137
|
* @param {string} id Xero ID
|
|
@@ -11558,6 +11609,16 @@ export class AccountsApi extends BaseAPI {
|
|
|
11558
11609
|
return AccountsApiFp(this.configuration).getGetLastAccount(options).then((request) => request(this.axios, this.basePath));
|
|
11559
11610
|
}
|
|
11560
11611
|
|
|
11612
|
+
/**
|
|
11613
|
+
* Download New Price List
|
|
11614
|
+
* @summary Download New Price List
|
|
11615
|
+
* @param {*} [options] Override http request option.
|
|
11616
|
+
* @throws {RequiredError}
|
|
11617
|
+
*/
|
|
11618
|
+
public getGetNewPriceList(options?: RawAxiosRequestConfig) {
|
|
11619
|
+
return AccountsApiFp(this.configuration).getGetNewPriceList(options).then((request) => request(this.axios, this.basePath));
|
|
11620
|
+
}
|
|
11621
|
+
|
|
11561
11622
|
/**
|
|
11562
11623
|
* Get Account 3CX Details
|
|
11563
11624
|
* @param {string} id Xero ID
|
package/dist/api.d.ts
CHANGED
|
@@ -8727,6 +8727,13 @@ 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 {*} [options] Override http request option.
|
|
8734
|
+
* @throws {RequiredError}
|
|
8735
|
+
*/
|
|
8736
|
+
getGetNewPriceList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8730
8737
|
/**
|
|
8731
8738
|
* Get Account 3CX Details
|
|
8732
8739
|
* @param {string} id Xero ID
|
|
@@ -9095,6 +9102,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
9095
9102
|
* @throws {RequiredError}
|
|
9096
9103
|
*/
|
|
9097
9104
|
getGetLastAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountSummaryDTO>>;
|
|
9105
|
+
/**
|
|
9106
|
+
* Download New Price List
|
|
9107
|
+
* @summary Download New Price List
|
|
9108
|
+
* @param {*} [options] Override http request option.
|
|
9109
|
+
* @throws {RequiredError}
|
|
9110
|
+
*/
|
|
9111
|
+
getGetNewPriceList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
9098
9112
|
/**
|
|
9099
9113
|
* Get Account 3CX Details
|
|
9100
9114
|
* @param {string} id Xero ID
|
|
@@ -9463,6 +9477,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
9463
9477
|
* @throws {RequiredError}
|
|
9464
9478
|
*/
|
|
9465
9479
|
getGetLastAccount(options?: RawAxiosRequestConfig): AxiosPromise<AccountSummaryDTO>;
|
|
9480
|
+
/**
|
|
9481
|
+
* Download New Price List
|
|
9482
|
+
* @summary Download New Price List
|
|
9483
|
+
* @param {*} [options] Override http request option.
|
|
9484
|
+
* @throws {RequiredError}
|
|
9485
|
+
*/
|
|
9486
|
+
getGetNewPriceList(options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
9466
9487
|
/**
|
|
9467
9488
|
* Get Account 3CX Details
|
|
9468
9489
|
* @param {string} id Xero ID
|
|
@@ -9831,6 +9852,13 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
9831
9852
|
* @throws {RequiredError}
|
|
9832
9853
|
*/
|
|
9833
9854
|
getGetLastAccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountSummaryDTO, any, {}>>;
|
|
9855
|
+
/**
|
|
9856
|
+
* Download New Price List
|
|
9857
|
+
* @summary Download New Price List
|
|
9858
|
+
* @param {*} [options] Override http request option.
|
|
9859
|
+
* @throws {RequiredError}
|
|
9860
|
+
*/
|
|
9861
|
+
getGetNewPriceList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
9834
9862
|
/**
|
|
9835
9863
|
* Get Account 3CX Details
|
|
9836
9864
|
* @param {string} id Xero ID
|
package/dist/api.js
CHANGED
|
@@ -1022,6 +1022,40 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
1022
1022
|
});
|
|
1023
1023
|
});
|
|
1024
1024
|
},
|
|
1025
|
+
/**
|
|
1026
|
+
* Download New Price List
|
|
1027
|
+
* @summary Download New Price List
|
|
1028
|
+
* @param {*} [options] Override http request option.
|
|
1029
|
+
* @throws {RequiredError}
|
|
1030
|
+
*/
|
|
1031
|
+
getGetNewPriceList: function () {
|
|
1032
|
+
var args_1 = [];
|
|
1033
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
1034
|
+
args_1[_i] = arguments[_i];
|
|
1035
|
+
}
|
|
1036
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
1037
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1038
|
+
if (options === void 0) { options = {}; }
|
|
1039
|
+
return __generator(this, function (_a) {
|
|
1040
|
+
localVarPath = "/admin/accounts/priceList/new";
|
|
1041
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1042
|
+
if (configuration) {
|
|
1043
|
+
baseOptions = configuration.baseOptions;
|
|
1044
|
+
}
|
|
1045
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
1046
|
+
localVarHeaderParameter = {};
|
|
1047
|
+
localVarQueryParameter = {};
|
|
1048
|
+
localVarHeaderParameter['Accept'] = 'text/csv';
|
|
1049
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1050
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1051
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1052
|
+
return [2 /*return*/, {
|
|
1053
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1054
|
+
options: localVarRequestOptions,
|
|
1055
|
+
}];
|
|
1056
|
+
});
|
|
1057
|
+
});
|
|
1058
|
+
},
|
|
1025
1059
|
/**
|
|
1026
1060
|
* Get Account 3CX Details
|
|
1027
1061
|
* @param {string} id Xero ID
|
|
@@ -2582,6 +2616,28 @@ var AccountsApiFp = function (configuration) {
|
|
|
2582
2616
|
});
|
|
2583
2617
|
});
|
|
2584
2618
|
},
|
|
2619
|
+
/**
|
|
2620
|
+
* Download New Price List
|
|
2621
|
+
* @summary Download New Price List
|
|
2622
|
+
* @param {*} [options] Override http request option.
|
|
2623
|
+
* @throws {RequiredError}
|
|
2624
|
+
*/
|
|
2625
|
+
getGetNewPriceList: function (options) {
|
|
2626
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2627
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
2628
|
+
var _a, _b, _c;
|
|
2629
|
+
return __generator(this, function (_d) {
|
|
2630
|
+
switch (_d.label) {
|
|
2631
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetNewPriceList(options)];
|
|
2632
|
+
case 1:
|
|
2633
|
+
localVarAxiosArgs = _d.sent();
|
|
2634
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2635
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getGetNewPriceList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2636
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
2637
|
+
}
|
|
2638
|
+
});
|
|
2639
|
+
});
|
|
2640
|
+
},
|
|
2585
2641
|
/**
|
|
2586
2642
|
* Get Account 3CX Details
|
|
2587
2643
|
* @param {string} id Xero ID
|
|
@@ -3449,6 +3505,15 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
3449
3505
|
getGetLastAccount: function (options) {
|
|
3450
3506
|
return localVarFp.getGetLastAccount(options).then(function (request) { return request(axios, basePath); });
|
|
3451
3507
|
},
|
|
3508
|
+
/**
|
|
3509
|
+
* Download New Price List
|
|
3510
|
+
* @summary Download New Price List
|
|
3511
|
+
* @param {*} [options] Override http request option.
|
|
3512
|
+
* @throws {RequiredError}
|
|
3513
|
+
*/
|
|
3514
|
+
getGetNewPriceList: function (options) {
|
|
3515
|
+
return localVarFp.getGetNewPriceList(options).then(function (request) { return request(axios, basePath); });
|
|
3516
|
+
},
|
|
3452
3517
|
/**
|
|
3453
3518
|
* Get Account 3CX Details
|
|
3454
3519
|
* @param {string} id Xero ID
|
|
@@ -3930,6 +3995,16 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
3930
3995
|
var _this = this;
|
|
3931
3996
|
return (0, exports.AccountsApiFp)(this.configuration).getGetLastAccount(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
3932
3997
|
};
|
|
3998
|
+
/**
|
|
3999
|
+
* Download New Price List
|
|
4000
|
+
* @summary Download New Price List
|
|
4001
|
+
* @param {*} [options] Override http request option.
|
|
4002
|
+
* @throws {RequiredError}
|
|
4003
|
+
*/
|
|
4004
|
+
AccountsApi.prototype.getGetNewPriceList = function (options) {
|
|
4005
|
+
var _this = this;
|
|
4006
|
+
return (0, exports.AccountsApiFp)(this.configuration).getGetNewPriceList(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
4007
|
+
};
|
|
3933
4008
|
/**
|
|
3934
4009
|
* Get Account 3CX Details
|
|
3935
4010
|
* @param {string} id Xero ID
|
package/docs/AccountsApi.md
CHANGED
|
@@ -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,53 @@ 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
|
+
const { status, data } = await apiInstance.getGetNewPriceList();
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
### Parameters
|
|
862
|
+
This endpoint does not have any parameters.
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
### Return type
|
|
866
|
+
|
|
867
|
+
**string**
|
|
868
|
+
|
|
869
|
+
### Authorization
|
|
870
|
+
|
|
871
|
+
No authorization required
|
|
872
|
+
|
|
873
|
+
### HTTP request headers
|
|
874
|
+
|
|
875
|
+
- **Content-Type**: Not defined
|
|
876
|
+
- **Accept**: text/csv
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
### HTTP response details
|
|
880
|
+
| Status code | Description | Response headers |
|
|
881
|
+
|-------------|-------------|------------------|
|
|
882
|
+
|**200** | Price List | - |
|
|
883
|
+
|**400** | Bad Request | - |
|
|
884
|
+
|**401** | Unauthorised | - |
|
|
885
|
+
|**403** | Access Denied | - |
|
|
886
|
+
|
|
887
|
+
[[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)
|
|
888
|
+
|
|
841
889
|
# **getGetTcxPartnerDetails**
|
|
842
890
|
> PartnerDTO getGetTcxPartnerDetails()
|
|
843
891
|
|