yellowgrid-api-ts 3.2.136-dev.0 → 3.2.137-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* | [**deleteDeleteClientCredentials**](docs/AccountsApi.md#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials
|
|
56
56
|
*AccountsApi* | [**deleteUpdateAccountContact**](docs/AccountsApi.md#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact
|
|
57
|
+
*AccountsApi* | [**getAdminCreateAccountContact**](docs/AccountsApi.md#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts/ |
|
|
57
58
|
*AccountsApi* | [**getGetAccount**](docs/AccountsApi.md#getgetaccount) | **GET** /accounts/me | Get Account
|
|
58
59
|
*AccountsApi* | [**getGetAccountContacts**](docs/AccountsApi.md#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts
|
|
59
60
|
*AccountsApi* | [**getGetAccountDetailedSummary**](docs/AccountsApi.md#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary
|
package/api.ts
CHANGED
|
@@ -8308,6 +8308,39 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
8308
8308
|
const localVarQueryParameter = {} as any;
|
|
8309
8309
|
|
|
8310
8310
|
|
|
8311
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8312
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8313
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
8314
|
+
|
|
8315
|
+
return {
|
|
8316
|
+
url: toPathString(localVarUrlObj),
|
|
8317
|
+
options: localVarRequestOptions,
|
|
8318
|
+
};
|
|
8319
|
+
},
|
|
8320
|
+
/**
|
|
8321
|
+
* Get Account Contacts
|
|
8322
|
+
* @param {string} id Account Xero ID
|
|
8323
|
+
* @param {*} [options] Override http request option.
|
|
8324
|
+
* @throws {RequiredError}
|
|
8325
|
+
*/
|
|
8326
|
+
getAdminCreateAccountContact: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8327
|
+
// verify required parameter 'id' is not null or undefined
|
|
8328
|
+
assertParamExists('getAdminCreateAccountContact', 'id', id)
|
|
8329
|
+
const localVarPath = `/admin/accounts/{id}/contacts/`
|
|
8330
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
8331
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8332
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8333
|
+
let baseOptions;
|
|
8334
|
+
if (configuration) {
|
|
8335
|
+
baseOptions = configuration.baseOptions;
|
|
8336
|
+
}
|
|
8337
|
+
|
|
8338
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
8339
|
+
const localVarHeaderParameter = {} as any;
|
|
8340
|
+
const localVarQueryParameter = {} as any;
|
|
8341
|
+
|
|
8342
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
8343
|
+
|
|
8311
8344
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8312
8345
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8313
8346
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -9381,6 +9414,18 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
9381
9414
|
const localVarOperationServerBasePath = operationServerMap['AccountsApi.deleteUpdateAccountContact']?.[localVarOperationServerIndex]?.url;
|
|
9382
9415
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9383
9416
|
},
|
|
9417
|
+
/**
|
|
9418
|
+
* Get Account Contacts
|
|
9419
|
+
* @param {string} id Account Xero ID
|
|
9420
|
+
* @param {*} [options] Override http request option.
|
|
9421
|
+
* @throws {RequiredError}
|
|
9422
|
+
*/
|
|
9423
|
+
async getAdminCreateAccountContact(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountContactModel>>> {
|
|
9424
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAdminCreateAccountContact(id, options);
|
|
9425
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9426
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsApi.getAdminCreateAccountContact']?.[localVarOperationServerIndex]?.url;
|
|
9427
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9428
|
+
},
|
|
9384
9429
|
/**
|
|
9385
9430
|
* Get Account
|
|
9386
9431
|
* @summary Get Account
|
|
@@ -9799,6 +9844,15 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
9799
9844
|
deleteUpdateAccountContact(email: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
9800
9845
|
return localVarFp.deleteUpdateAccountContact(email, options).then((request) => request(axios, basePath));
|
|
9801
9846
|
},
|
|
9847
|
+
/**
|
|
9848
|
+
* Get Account Contacts
|
|
9849
|
+
* @param {string} id Account Xero ID
|
|
9850
|
+
* @param {*} [options] Override http request option.
|
|
9851
|
+
* @throws {RequiredError}
|
|
9852
|
+
*/
|
|
9853
|
+
getAdminCreateAccountContact(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AccountContactModel>> {
|
|
9854
|
+
return localVarFp.getAdminCreateAccountContact(id, options).then((request) => request(axios, basePath));
|
|
9855
|
+
},
|
|
9802
9856
|
/**
|
|
9803
9857
|
* Get Account
|
|
9804
9858
|
* @summary Get Account
|
|
@@ -10131,6 +10185,16 @@ export class AccountsApi extends BaseAPI {
|
|
|
10131
10185
|
return AccountsApiFp(this.configuration).deleteUpdateAccountContact(email, options).then((request) => request(this.axios, this.basePath));
|
|
10132
10186
|
}
|
|
10133
10187
|
|
|
10188
|
+
/**
|
|
10189
|
+
* Get Account Contacts
|
|
10190
|
+
* @param {string} id Account Xero ID
|
|
10191
|
+
* @param {*} [options] Override http request option.
|
|
10192
|
+
* @throws {RequiredError}
|
|
10193
|
+
*/
|
|
10194
|
+
public getAdminCreateAccountContact(id: string, options?: RawAxiosRequestConfig) {
|
|
10195
|
+
return AccountsApiFp(this.configuration).getAdminCreateAccountContact(id, options).then((request) => request(this.axios, this.basePath));
|
|
10196
|
+
}
|
|
10197
|
+
|
|
10134
10198
|
/**
|
|
10135
10199
|
* Get Account
|
|
10136
10200
|
* @summary Get Account
|
package/dist/api.d.ts
CHANGED
|
@@ -8134,6 +8134,13 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
8134
8134
|
* @throws {RequiredError}
|
|
8135
8135
|
*/
|
|
8136
8136
|
deleteUpdateAccountContact: (email: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8137
|
+
/**
|
|
8138
|
+
* Get Account Contacts
|
|
8139
|
+
* @param {string} id Account Xero ID
|
|
8140
|
+
* @param {*} [options] Override http request option.
|
|
8141
|
+
* @throws {RequiredError}
|
|
8142
|
+
*/
|
|
8143
|
+
getAdminCreateAccountContact: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8137
8144
|
/**
|
|
8138
8145
|
* Get Account
|
|
8139
8146
|
* @summary Get Account
|
|
@@ -8397,6 +8404,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
8397
8404
|
* @throws {RequiredError}
|
|
8398
8405
|
*/
|
|
8399
8406
|
deleteUpdateAccountContact(email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8407
|
+
/**
|
|
8408
|
+
* Get Account Contacts
|
|
8409
|
+
* @param {string} id Account Xero ID
|
|
8410
|
+
* @param {*} [options] Override http request option.
|
|
8411
|
+
* @throws {RequiredError}
|
|
8412
|
+
*/
|
|
8413
|
+
getAdminCreateAccountContact(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountContactModel>>>;
|
|
8400
8414
|
/**
|
|
8401
8415
|
* Get Account
|
|
8402
8416
|
* @summary Get Account
|
|
@@ -8660,6 +8674,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
8660
8674
|
* @throws {RequiredError}
|
|
8661
8675
|
*/
|
|
8662
8676
|
deleteUpdateAccountContact(email: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8677
|
+
/**
|
|
8678
|
+
* Get Account Contacts
|
|
8679
|
+
* @param {string} id Account Xero ID
|
|
8680
|
+
* @param {*} [options] Override http request option.
|
|
8681
|
+
* @throws {RequiredError}
|
|
8682
|
+
*/
|
|
8683
|
+
getAdminCreateAccountContact(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AccountContactModel>>;
|
|
8663
8684
|
/**
|
|
8664
8685
|
* Get Account
|
|
8665
8686
|
* @summary Get Account
|
|
@@ -8923,6 +8944,13 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
8923
8944
|
* @throws {RequiredError}
|
|
8924
8945
|
*/
|
|
8925
8946
|
deleteUpdateAccountContact(email: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
8947
|
+
/**
|
|
8948
|
+
* Get Account Contacts
|
|
8949
|
+
* @param {string} id Account Xero ID
|
|
8950
|
+
* @param {*} [options] Override http request option.
|
|
8951
|
+
* @throws {RequiredError}
|
|
8952
|
+
*/
|
|
8953
|
+
getAdminCreateAccountContact(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountContactModel[], any, {}>>;
|
|
8926
8954
|
/**
|
|
8927
8955
|
* Get Account
|
|
8928
8956
|
* @summary Get Account
|
package/dist/api.js
CHANGED
|
@@ -543,6 +543,43 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
543
543
|
});
|
|
544
544
|
});
|
|
545
545
|
},
|
|
546
|
+
/**
|
|
547
|
+
* Get Account Contacts
|
|
548
|
+
* @param {string} id Account Xero ID
|
|
549
|
+
* @param {*} [options] Override http request option.
|
|
550
|
+
* @throws {RequiredError}
|
|
551
|
+
*/
|
|
552
|
+
getAdminCreateAccountContact: function (id_1) {
|
|
553
|
+
var args_1 = [];
|
|
554
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
555
|
+
args_1[_i - 1] = arguments[_i];
|
|
556
|
+
}
|
|
557
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
558
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
559
|
+
if (options === void 0) { options = {}; }
|
|
560
|
+
return __generator(this, function (_a) {
|
|
561
|
+
// verify required parameter 'id' is not null or undefined
|
|
562
|
+
(0, common_1.assertParamExists)('getAdminCreateAccountContact', 'id', id);
|
|
563
|
+
localVarPath = "/admin/accounts/{id}/contacts/"
|
|
564
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
565
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
566
|
+
if (configuration) {
|
|
567
|
+
baseOptions = configuration.baseOptions;
|
|
568
|
+
}
|
|
569
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
570
|
+
localVarHeaderParameter = {};
|
|
571
|
+
localVarQueryParameter = {};
|
|
572
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
573
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
574
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
575
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
576
|
+
return [2 /*return*/, {
|
|
577
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
578
|
+
options: localVarRequestOptions,
|
|
579
|
+
}];
|
|
580
|
+
});
|
|
581
|
+
});
|
|
582
|
+
},
|
|
546
583
|
/**
|
|
547
584
|
* Get Account
|
|
548
585
|
* @summary Get Account
|
|
@@ -1742,6 +1779,28 @@ var AccountsApiFp = function (configuration) {
|
|
|
1742
1779
|
});
|
|
1743
1780
|
});
|
|
1744
1781
|
},
|
|
1782
|
+
/**
|
|
1783
|
+
* Get Account Contacts
|
|
1784
|
+
* @param {string} id Account Xero ID
|
|
1785
|
+
* @param {*} [options] Override http request option.
|
|
1786
|
+
* @throws {RequiredError}
|
|
1787
|
+
*/
|
|
1788
|
+
getAdminCreateAccountContact: function (id, options) {
|
|
1789
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1790
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1791
|
+
var _a, _b, _c;
|
|
1792
|
+
return __generator(this, function (_d) {
|
|
1793
|
+
switch (_d.label) {
|
|
1794
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getAdminCreateAccountContact(id, options)];
|
|
1795
|
+
case 1:
|
|
1796
|
+
localVarAxiosArgs = _d.sent();
|
|
1797
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1798
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccountsApi.getAdminCreateAccountContact']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1799
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1800
|
+
}
|
|
1801
|
+
});
|
|
1802
|
+
});
|
|
1803
|
+
},
|
|
1745
1804
|
/**
|
|
1746
1805
|
* Get Account
|
|
1747
1806
|
* @summary Get Account
|
|
@@ -2450,6 +2509,15 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
2450
2509
|
deleteUpdateAccountContact: function (email, options) {
|
|
2451
2510
|
return localVarFp.deleteUpdateAccountContact(email, options).then(function (request) { return request(axios, basePath); });
|
|
2452
2511
|
},
|
|
2512
|
+
/**
|
|
2513
|
+
* Get Account Contacts
|
|
2514
|
+
* @param {string} id Account Xero ID
|
|
2515
|
+
* @param {*} [options] Override http request option.
|
|
2516
|
+
* @throws {RequiredError}
|
|
2517
|
+
*/
|
|
2518
|
+
getAdminCreateAccountContact: function (id, options) {
|
|
2519
|
+
return localVarFp.getAdminCreateAccountContact(id, options).then(function (request) { return request(axios, basePath); });
|
|
2520
|
+
},
|
|
2453
2521
|
/**
|
|
2454
2522
|
* Get Account
|
|
2455
2523
|
* @summary Get Account
|
|
@@ -2786,6 +2854,16 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
2786
2854
|
var _this = this;
|
|
2787
2855
|
return (0, exports.AccountsApiFp)(this.configuration).deleteUpdateAccountContact(email, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2788
2856
|
};
|
|
2857
|
+
/**
|
|
2858
|
+
* Get Account Contacts
|
|
2859
|
+
* @param {string} id Account Xero ID
|
|
2860
|
+
* @param {*} [options] Override http request option.
|
|
2861
|
+
* @throws {RequiredError}
|
|
2862
|
+
*/
|
|
2863
|
+
AccountsApi.prototype.getAdminCreateAccountContact = function (id, options) {
|
|
2864
|
+
var _this = this;
|
|
2865
|
+
return (0, exports.AccountsApiFp)(this.configuration).getAdminCreateAccountContact(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2866
|
+
};
|
|
2789
2867
|
/**
|
|
2790
2868
|
* Get Account
|
|
2791
2869
|
* @summary Get Account
|
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
|
|[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
|
|
9
9
|
|[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
|
|
10
|
+
|[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts/ | |
|
|
10
11
|
|[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
|
|
11
12
|
|[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
|
|
12
13
|
|[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
|
|
@@ -202,6 +203,60 @@ No authorization required
|
|
|
202
203
|
|
|
203
204
|
[[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)
|
|
204
205
|
|
|
206
|
+
# **getAdminCreateAccountContact**
|
|
207
|
+
> Array<AccountContactModel> getAdminCreateAccountContact()
|
|
208
|
+
|
|
209
|
+
Get Account Contacts
|
|
210
|
+
|
|
211
|
+
### Example
|
|
212
|
+
|
|
213
|
+
```typescript
|
|
214
|
+
import {
|
|
215
|
+
AccountsApi,
|
|
216
|
+
Configuration
|
|
217
|
+
} from 'yellowgrid-api-ts';
|
|
218
|
+
|
|
219
|
+
const configuration = new Configuration();
|
|
220
|
+
const apiInstance = new AccountsApi(configuration);
|
|
221
|
+
|
|
222
|
+
let id: string; //Account Xero ID (default to undefined)
|
|
223
|
+
|
|
224
|
+
const { status, data } = await apiInstance.getAdminCreateAccountContact(
|
|
225
|
+
id
|
|
226
|
+
);
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Parameters
|
|
230
|
+
|
|
231
|
+
|Name | Type | Description | Notes|
|
|
232
|
+
|------------- | ------------- | ------------- | -------------|
|
|
233
|
+
| **id** | [**string**] | Account Xero ID | defaults to undefined|
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
### Return type
|
|
237
|
+
|
|
238
|
+
**Array<AccountContactModel>**
|
|
239
|
+
|
|
240
|
+
### Authorization
|
|
241
|
+
|
|
242
|
+
No authorization required
|
|
243
|
+
|
|
244
|
+
### HTTP request headers
|
|
245
|
+
|
|
246
|
+
- **Content-Type**: Not defined
|
|
247
|
+
- **Accept**: application/json
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
### HTTP response details
|
|
251
|
+
| Status code | Description | Response headers |
|
|
252
|
+
|-------------|-------------|------------------|
|
|
253
|
+
|**200** | Account | - |
|
|
254
|
+
|**400** | Bad Request | - |
|
|
255
|
+
|**401** | Unauthorised | - |
|
|
256
|
+
|**403** | Access Denied | - |
|
|
257
|
+
|
|
258
|
+
[[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)
|
|
259
|
+
|
|
205
260
|
# **getGetAccount**
|
|
206
261
|
> PortalAccountModel getGetAccount()
|
|
207
262
|
|