yellowgrid-api-ts 3.2.140-dev.0 → 3.2.141-dev.0
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 +64 -0
- package/dist/api.d.ts +28 -0
- package/dist/api.js +78 -0
- package/docs/AccountsApi.md +55 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -54,6 +54,7 @@ Class | Method | HTTP request | Description
|
|
|
54
54
|
*AccountsApi* | [**deleteAdminUpdateAccountContact**](docs/AccountsApi.md#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} |
|
|
55
55
|
*AccountsApi* | [**deleteArchiveAccount**](docs/AccountsApi.md#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive |
|
|
56
56
|
*AccountsApi* | [**deleteDeleteClientCredentials**](docs/AccountsApi.md#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials
|
|
57
|
+
*AccountsApi* | [**deleteGetFinanceSettings**](docs/AccountsApi.md#deletegetfinancesettings) | **DELETE** /admin/accounts/{id}/finance |
|
|
57
58
|
*AccountsApi* | [**deleteUpdateAccountContact**](docs/AccountsApi.md#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact
|
|
58
59
|
*AccountsApi* | [**getAdminCreateAccountContact**](docs/AccountsApi.md#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts |
|
|
59
60
|
*AccountsApi* | [**getGetAccount**](docs/AccountsApi.md#getgetaccount) | **GET** /accounts/me | Get Account
|
package/api.ts
CHANGED
|
@@ -8390,6 +8390,39 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
8390
8390
|
const localVarQueryParameter = {} as any;
|
|
8391
8391
|
|
|
8392
8392
|
|
|
8393
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8394
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8395
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
8396
|
+
|
|
8397
|
+
return {
|
|
8398
|
+
url: toPathString(localVarUrlObj),
|
|
8399
|
+
options: localVarRequestOptions,
|
|
8400
|
+
};
|
|
8401
|
+
},
|
|
8402
|
+
/**
|
|
8403
|
+
* Get Account Finance
|
|
8404
|
+
* @param {string} id Account Xero ID
|
|
8405
|
+
* @param {*} [options] Override http request option.
|
|
8406
|
+
* @throws {RequiredError}
|
|
8407
|
+
*/
|
|
8408
|
+
deleteGetFinanceSettings: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8409
|
+
// verify required parameter 'id' is not null or undefined
|
|
8410
|
+
assertParamExists('deleteGetFinanceSettings', 'id', id)
|
|
8411
|
+
const localVarPath = `/admin/accounts/{id}/finance`
|
|
8412
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
8413
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8414
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8415
|
+
let baseOptions;
|
|
8416
|
+
if (configuration) {
|
|
8417
|
+
baseOptions = configuration.baseOptions;
|
|
8418
|
+
}
|
|
8419
|
+
|
|
8420
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
8421
|
+
const localVarHeaderParameter = {} as any;
|
|
8422
|
+
const localVarQueryParameter = {} as any;
|
|
8423
|
+
|
|
8424
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
8425
|
+
|
|
8393
8426
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8394
8427
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8395
8428
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -9636,6 +9669,18 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
9636
9669
|
const localVarOperationServerBasePath = operationServerMap['AccountsApi.deleteDeleteClientCredentials']?.[localVarOperationServerIndex]?.url;
|
|
9637
9670
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9638
9671
|
},
|
|
9672
|
+
/**
|
|
9673
|
+
* Get Account Finance
|
|
9674
|
+
* @param {string} id Account Xero ID
|
|
9675
|
+
* @param {*} [options] Override http request option.
|
|
9676
|
+
* @throws {RequiredError}
|
|
9677
|
+
*/
|
|
9678
|
+
async deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>> {
|
|
9679
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteGetFinanceSettings(id, options);
|
|
9680
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9681
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsApi.deleteGetFinanceSettings']?.[localVarOperationServerIndex]?.url;
|
|
9682
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9683
|
+
},
|
|
9639
9684
|
/**
|
|
9640
9685
|
* Delete Account Contacts
|
|
9641
9686
|
* @summary Delete Account Contact
|
|
@@ -10117,6 +10162,15 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
10117
10162
|
deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
10118
10163
|
return localVarFp.deleteDeleteClientCredentials(id, options).then((request) => request(axios, basePath));
|
|
10119
10164
|
},
|
|
10165
|
+
/**
|
|
10166
|
+
* Get Account Finance
|
|
10167
|
+
* @param {string} id Account Xero ID
|
|
10168
|
+
* @param {*} [options] Override http request option.
|
|
10169
|
+
* @throws {RequiredError}
|
|
10170
|
+
*/
|
|
10171
|
+
deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO> {
|
|
10172
|
+
return localVarFp.deleteGetFinanceSettings(id, options).then((request) => request(axios, basePath));
|
|
10173
|
+
},
|
|
10120
10174
|
/**
|
|
10121
10175
|
* Delete Account Contacts
|
|
10122
10176
|
* @summary Delete Account Contact
|
|
@@ -10497,6 +10551,16 @@ export class AccountsApi extends BaseAPI {
|
|
|
10497
10551
|
return AccountsApiFp(this.configuration).deleteDeleteClientCredentials(id, options).then((request) => request(this.axios, this.basePath));
|
|
10498
10552
|
}
|
|
10499
10553
|
|
|
10554
|
+
/**
|
|
10555
|
+
* Get Account Finance
|
|
10556
|
+
* @param {string} id Account Xero ID
|
|
10557
|
+
* @param {*} [options] Override http request option.
|
|
10558
|
+
* @throws {RequiredError}
|
|
10559
|
+
*/
|
|
10560
|
+
public deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig) {
|
|
10561
|
+
return AccountsApiFp(this.configuration).deleteGetFinanceSettings(id, options).then((request) => request(this.axios, this.basePath));
|
|
10562
|
+
}
|
|
10563
|
+
|
|
10500
10564
|
/**
|
|
10501
10565
|
* Delete Account Contacts
|
|
10502
10566
|
* @summary Delete Account Contact
|
package/dist/api.d.ts
CHANGED
|
@@ -8211,6 +8211,13 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
8211
8211
|
* @throws {RequiredError}
|
|
8212
8212
|
*/
|
|
8213
8213
|
deleteDeleteClientCredentials: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8214
|
+
/**
|
|
8215
|
+
* Get Account Finance
|
|
8216
|
+
* @param {string} id Account Xero ID
|
|
8217
|
+
* @param {*} [options] Override http request option.
|
|
8218
|
+
* @throws {RequiredError}
|
|
8219
|
+
*/
|
|
8220
|
+
deleteGetFinanceSettings: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8214
8221
|
/**
|
|
8215
8222
|
* Delete Account Contacts
|
|
8216
8223
|
* @summary Delete Account Contact
|
|
@@ -8512,6 +8519,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
8512
8519
|
* @throws {RequiredError}
|
|
8513
8520
|
*/
|
|
8514
8521
|
deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8522
|
+
/**
|
|
8523
|
+
* Get Account Finance
|
|
8524
|
+
* @param {string} id Account Xero ID
|
|
8525
|
+
* @param {*} [options] Override http request option.
|
|
8526
|
+
* @throws {RequiredError}
|
|
8527
|
+
*/
|
|
8528
|
+
deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
|
|
8515
8529
|
/**
|
|
8516
8530
|
* Delete Account Contacts
|
|
8517
8531
|
* @summary Delete Account Contact
|
|
@@ -8813,6 +8827,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
8813
8827
|
* @throws {RequiredError}
|
|
8814
8828
|
*/
|
|
8815
8829
|
deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8830
|
+
/**
|
|
8831
|
+
* Get Account Finance
|
|
8832
|
+
* @param {string} id Account Xero ID
|
|
8833
|
+
* @param {*} [options] Override http request option.
|
|
8834
|
+
* @throws {RequiredError}
|
|
8835
|
+
*/
|
|
8836
|
+
deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
|
|
8816
8837
|
/**
|
|
8817
8838
|
* Delete Account Contacts
|
|
8818
8839
|
* @summary Delete Account Contact
|
|
@@ -9114,6 +9135,13 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
9114
9135
|
* @throws {RequiredError}
|
|
9115
9136
|
*/
|
|
9116
9137
|
deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
9138
|
+
/**
|
|
9139
|
+
* Get Account Finance
|
|
9140
|
+
* @param {string} id Account Xero ID
|
|
9141
|
+
* @param {*} [options] Override http request option.
|
|
9142
|
+
* @throws {RequiredError}
|
|
9143
|
+
*/
|
|
9144
|
+
deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
|
|
9117
9145
|
/**
|
|
9118
9146
|
* Delete Account Contacts
|
|
9119
9147
|
* @summary Delete Account Contact
|
package/dist/api.js
CHANGED
|
@@ -551,6 +551,43 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
551
551
|
});
|
|
552
552
|
});
|
|
553
553
|
},
|
|
554
|
+
/**
|
|
555
|
+
* Get Account Finance
|
|
556
|
+
* @param {string} id Account Xero ID
|
|
557
|
+
* @param {*} [options] Override http request option.
|
|
558
|
+
* @throws {RequiredError}
|
|
559
|
+
*/
|
|
560
|
+
deleteGetFinanceSettings: function (id_1) {
|
|
561
|
+
var args_1 = [];
|
|
562
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
563
|
+
args_1[_i - 1] = arguments[_i];
|
|
564
|
+
}
|
|
565
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
566
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
567
|
+
if (options === void 0) { options = {}; }
|
|
568
|
+
return __generator(this, function (_a) {
|
|
569
|
+
// verify required parameter 'id' is not null or undefined
|
|
570
|
+
(0, common_1.assertParamExists)('deleteGetFinanceSettings', 'id', id);
|
|
571
|
+
localVarPath = "/admin/accounts/{id}/finance"
|
|
572
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
573
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
574
|
+
if (configuration) {
|
|
575
|
+
baseOptions = configuration.baseOptions;
|
|
576
|
+
}
|
|
577
|
+
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
578
|
+
localVarHeaderParameter = {};
|
|
579
|
+
localVarQueryParameter = {};
|
|
580
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
581
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
582
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
583
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
584
|
+
return [2 /*return*/, {
|
|
585
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
586
|
+
options: localVarRequestOptions,
|
|
587
|
+
}];
|
|
588
|
+
});
|
|
589
|
+
});
|
|
590
|
+
},
|
|
554
591
|
/**
|
|
555
592
|
* Delete Account Contacts
|
|
556
593
|
* @summary Delete Account Contact
|
|
@@ -1943,6 +1980,28 @@ var AccountsApiFp = function (configuration) {
|
|
|
1943
1980
|
});
|
|
1944
1981
|
});
|
|
1945
1982
|
},
|
|
1983
|
+
/**
|
|
1984
|
+
* Get Account Finance
|
|
1985
|
+
* @param {string} id Account Xero ID
|
|
1986
|
+
* @param {*} [options] Override http request option.
|
|
1987
|
+
* @throws {RequiredError}
|
|
1988
|
+
*/
|
|
1989
|
+
deleteGetFinanceSettings: function (id, options) {
|
|
1990
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1991
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1992
|
+
var _a, _b, _c;
|
|
1993
|
+
return __generator(this, function (_d) {
|
|
1994
|
+
switch (_d.label) {
|
|
1995
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteGetFinanceSettings(id, options)];
|
|
1996
|
+
case 1:
|
|
1997
|
+
localVarAxiosArgs = _d.sent();
|
|
1998
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1999
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.deleteGetFinanceSettings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2000
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
2001
|
+
}
|
|
2002
|
+
});
|
|
2003
|
+
});
|
|
2004
|
+
},
|
|
1946
2005
|
/**
|
|
1947
2006
|
* Delete Account Contacts
|
|
1948
2007
|
* @summary Delete Account Contact
|
|
@@ -2764,6 +2823,15 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
2764
2823
|
deleteDeleteClientCredentials: function (id, options) {
|
|
2765
2824
|
return localVarFp.deleteDeleteClientCredentials(id, options).then(function (request) { return request(axios, basePath); });
|
|
2766
2825
|
},
|
|
2826
|
+
/**
|
|
2827
|
+
* Get Account Finance
|
|
2828
|
+
* @param {string} id Account Xero ID
|
|
2829
|
+
* @param {*} [options] Override http request option.
|
|
2830
|
+
* @throws {RequiredError}
|
|
2831
|
+
*/
|
|
2832
|
+
deleteGetFinanceSettings: function (id, options) {
|
|
2833
|
+
return localVarFp.deleteGetFinanceSettings(id, options).then(function (request) { return request(axios, basePath); });
|
|
2834
|
+
},
|
|
2767
2835
|
/**
|
|
2768
2836
|
* Delete Account Contacts
|
|
2769
2837
|
* @summary Delete Account Contact
|
|
@@ -3148,6 +3216,16 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
3148
3216
|
var _this = this;
|
|
3149
3217
|
return (0, exports.AccountsApiFp)(this.configuration).deleteDeleteClientCredentials(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
3150
3218
|
};
|
|
3219
|
+
/**
|
|
3220
|
+
* Get Account Finance
|
|
3221
|
+
* @param {string} id Account Xero ID
|
|
3222
|
+
* @param {*} [options] Override http request option.
|
|
3223
|
+
* @throws {RequiredError}
|
|
3224
|
+
*/
|
|
3225
|
+
AccountsApi.prototype.deleteGetFinanceSettings = function (id, options) {
|
|
3226
|
+
var _this = this;
|
|
3227
|
+
return (0, exports.AccountsApiFp)(this.configuration).deleteGetFinanceSettings(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
3228
|
+
};
|
|
3151
3229
|
/**
|
|
3152
3230
|
* Delete Account Contacts
|
|
3153
3231
|
* @summary Delete Account Contact
|
package/docs/AccountsApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://localhost*
|
|
|
7
7
|
|[**deleteAdminUpdateAccountContact**](#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
|
|
8
8
|
|[**deleteArchiveAccount**](#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive | |
|
|
9
9
|
|[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
|
|
10
|
+
|[**deleteGetFinanceSettings**](#deletegetfinancesettings) | **DELETE** /admin/accounts/{id}/finance | |
|
|
10
11
|
|[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
|
|
11
12
|
|[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
|
|
12
13
|
|[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
|
|
@@ -207,6 +208,60 @@ No authorization required
|
|
|
207
208
|
|
|
208
209
|
[[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)
|
|
209
210
|
|
|
211
|
+
# **deleteGetFinanceSettings**
|
|
212
|
+
> AccountFinanceDTO deleteGetFinanceSettings()
|
|
213
|
+
|
|
214
|
+
Get Account Finance
|
|
215
|
+
|
|
216
|
+
### Example
|
|
217
|
+
|
|
218
|
+
```typescript
|
|
219
|
+
import {
|
|
220
|
+
AccountsApi,
|
|
221
|
+
Configuration
|
|
222
|
+
} from 'yellowgrid-api-ts';
|
|
223
|
+
|
|
224
|
+
const configuration = new Configuration();
|
|
225
|
+
const apiInstance = new AccountsApi(configuration);
|
|
226
|
+
|
|
227
|
+
let id: string; //Account Xero ID (default to undefined)
|
|
228
|
+
|
|
229
|
+
const { status, data } = await apiInstance.deleteGetFinanceSettings(
|
|
230
|
+
id
|
|
231
|
+
);
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Parameters
|
|
235
|
+
|
|
236
|
+
|Name | Type | Description | Notes|
|
|
237
|
+
|------------- | ------------- | ------------- | -------------|
|
|
238
|
+
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
### Return type
|
|
242
|
+
|
|
243
|
+
**AccountFinanceDTO**
|
|
244
|
+
|
|
245
|
+
### Authorization
|
|
246
|
+
|
|
247
|
+
No authorization required
|
|
248
|
+
|
|
249
|
+
### HTTP request headers
|
|
250
|
+
|
|
251
|
+
- **Content-Type**: Not defined
|
|
252
|
+
- **Accept**: application/json
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
### HTTP response details
|
|
256
|
+
| Status code | Description | Response headers |
|
|
257
|
+
|-------------|-------------|------------------|
|
|
258
|
+
|**200** | Accounts Finance Details | - |
|
|
259
|
+
|**400** | Bad Request | - |
|
|
260
|
+
|**401** | Unauthorised | - |
|
|
261
|
+
|**403** | Access Denied | - |
|
|
262
|
+
|
|
263
|
+
[[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)
|
|
264
|
+
|
|
210
265
|
# **deleteUpdateAccountContact**
|
|
211
266
|
> deleteUpdateAccountContact()
|
|
212
267
|
|