yellowgrid-api-ts 3.2.139-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.
@@ -5,7 +5,9 @@ All URIs are relative to *https://localhost*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**deleteAdminUpdateAccountContact**](#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
8
+ |[**deleteArchiveAccount**](#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive | |
8
9
  |[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
10
+ |[**deleteGetFinanceSettings**](#deletegetfinancesettings) | **DELETE** /admin/accounts/{id}/finance | |
9
11
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
10
12
  |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
11
13
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
@@ -24,6 +26,9 @@ All URIs are relative to *https://localhost*
24
26
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
25
27
  |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
26
28
  |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
29
+ |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
30
+ |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
31
+ |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
27
32
  |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
28
33
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
29
34
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
@@ -71,6 +76,60 @@ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
71
76
  | **contactId** | [**number**] | Contact ID | defaults to undefined|
72
77
 
73
78
 
79
+ ### Return type
80
+
81
+ void (empty response body)
82
+
83
+ ### Authorization
84
+
85
+ No authorization required
86
+
87
+ ### HTTP request headers
88
+
89
+ - **Content-Type**: Not defined
90
+ - **Accept**: Not defined
91
+
92
+
93
+ ### HTTP response details
94
+ | Status code | Description | Response headers |
95
+ |-------------|-------------|------------------|
96
+ |**204** | No Response | - |
97
+ |**400** | Bad Request | - |
98
+ |**401** | Unauthorised | - |
99
+ |**403** | Access Denied | - |
100
+
101
+ [[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)
102
+
103
+ # **deleteArchiveAccount**
104
+ > deleteArchiveAccount()
105
+
106
+ Delete Account
107
+
108
+ ### Example
109
+
110
+ ```typescript
111
+ import {
112
+ AccountsApi,
113
+ Configuration
114
+ } from 'yellowgrid-api-ts';
115
+
116
+ const configuration = new Configuration();
117
+ const apiInstance = new AccountsApi(configuration);
118
+
119
+ let id: string; //Account Xero ID (default to undefined)
120
+
121
+ const { status, data } = await apiInstance.deleteArchiveAccount(
122
+ id
123
+ );
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ |Name | Type | Description | Notes|
129
+ |------------- | ------------- | ------------- | -------------|
130
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
131
+
132
+
74
133
  ### Return type
75
134
 
76
135
  void (empty response body)
@@ -149,6 +208,60 @@ No authorization required
149
208
 
150
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)
151
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
+
152
265
  # **deleteUpdateAccountContact**
153
266
  > deleteUpdateAccountContact()
154
267
 
@@ -1136,6 +1249,180 @@ No authorization required
1136
1249
 
1137
1250
  [[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)
1138
1251
 
1252
+ # **patchUpdateCreditLimit**
1253
+ > AccountFinanceDTO patchUpdateCreditLimit()
1254
+
1255
+ Set Account Credit Limit
1256
+
1257
+ ### Example
1258
+
1259
+ ```typescript
1260
+ import {
1261
+ AccountsApi,
1262
+ Configuration,
1263
+ PatchUpdateCreditLimitRequest
1264
+ } from 'yellowgrid-api-ts';
1265
+
1266
+ const configuration = new Configuration();
1267
+ const apiInstance = new AccountsApi(configuration);
1268
+
1269
+ let id: string; //Xero ID (default to undefined)
1270
+ let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
1271
+
1272
+ const { status, data } = await apiInstance.patchUpdateCreditLimit(
1273
+ id,
1274
+ patchUpdateCreditLimitRequest
1275
+ );
1276
+ ```
1277
+
1278
+ ### Parameters
1279
+
1280
+ |Name | Type | Description | Notes|
1281
+ |------------- | ------------- | ------------- | -------------|
1282
+ | **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
1283
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1284
+
1285
+
1286
+ ### Return type
1287
+
1288
+ **AccountFinanceDTO**
1289
+
1290
+ ### Authorization
1291
+
1292
+ No authorization required
1293
+
1294
+ ### HTTP request headers
1295
+
1296
+ - **Content-Type**: application/json
1297
+ - **Accept**: application/json
1298
+
1299
+
1300
+ ### HTTP response details
1301
+ | Status code | Description | Response headers |
1302
+ |-------------|-------------|------------------|
1303
+ |**200** | Accounts Finance Details | - |
1304
+ |**400** | Bad Request | - |
1305
+ |**401** | Unauthorised | - |
1306
+ |**403** | Access Denied | - |
1307
+
1308
+ [[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)
1309
+
1310
+ # **patchUpdatePriceList**
1311
+ > AccountFinanceDTO patchUpdatePriceList()
1312
+
1313
+ Set Account Price List
1314
+
1315
+ ### Example
1316
+
1317
+ ```typescript
1318
+ import {
1319
+ AccountsApi,
1320
+ Configuration,
1321
+ PatchUpdatePriceListRequest
1322
+ } from 'yellowgrid-api-ts';
1323
+
1324
+ const configuration = new Configuration();
1325
+ const apiInstance = new AccountsApi(configuration);
1326
+
1327
+ let id: string; //Xero ID (default to undefined)
1328
+ let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
1329
+
1330
+ const { status, data } = await apiInstance.patchUpdatePriceList(
1331
+ id,
1332
+ patchUpdatePriceListRequest
1333
+ );
1334
+ ```
1335
+
1336
+ ### Parameters
1337
+
1338
+ |Name | Type | Description | Notes|
1339
+ |------------- | ------------- | ------------- | -------------|
1340
+ | **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
1341
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1342
+
1343
+
1344
+ ### Return type
1345
+
1346
+ **AccountFinanceDTO**
1347
+
1348
+ ### Authorization
1349
+
1350
+ No authorization required
1351
+
1352
+ ### HTTP request headers
1353
+
1354
+ - **Content-Type**: application/json
1355
+ - **Accept**: application/json
1356
+
1357
+
1358
+ ### HTTP response details
1359
+ | Status code | Description | Response headers |
1360
+ |-------------|-------------|------------------|
1361
+ |**200** | Accounts Finance Details | - |
1362
+ |**400** | Bad Request | - |
1363
+ |**401** | Unauthorised | - |
1364
+ |**403** | Access Denied | - |
1365
+
1366
+ [[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)
1367
+
1368
+ # **patchUpdateSipChannelCost**
1369
+ > AccountFinanceDTO patchUpdateSipChannelCost()
1370
+
1371
+ Set Account SIP Channel Cost
1372
+
1373
+ ### Example
1374
+
1375
+ ```typescript
1376
+ import {
1377
+ AccountsApi,
1378
+ Configuration,
1379
+ PatchUpdateSipChannelCostRequest
1380
+ } from 'yellowgrid-api-ts';
1381
+
1382
+ const configuration = new Configuration();
1383
+ const apiInstance = new AccountsApi(configuration);
1384
+
1385
+ let id: string; //Xero ID (default to undefined)
1386
+ let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
1387
+
1388
+ const { status, data } = await apiInstance.patchUpdateSipChannelCost(
1389
+ id,
1390
+ patchUpdateSipChannelCostRequest
1391
+ );
1392
+ ```
1393
+
1394
+ ### Parameters
1395
+
1396
+ |Name | Type | Description | Notes|
1397
+ |------------- | ------------- | ------------- | -------------|
1398
+ | **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
1399
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1400
+
1401
+
1402
+ ### Return type
1403
+
1404
+ **AccountFinanceDTO**
1405
+
1406
+ ### Authorization
1407
+
1408
+ No authorization required
1409
+
1410
+ ### HTTP request headers
1411
+
1412
+ - **Content-Type**: application/json
1413
+ - **Accept**: application/json
1414
+
1415
+
1416
+ ### HTTP response details
1417
+ | Status code | Description | Response headers |
1418
+ |-------------|-------------|------------------|
1419
+ |**200** | Accounts Finance Details | - |
1420
+ |**400** | Bad Request | - |
1421
+ |**401** | Unauthorised | - |
1422
+ |**403** | Access Denied | - |
1423
+
1424
+ [[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)
1425
+
1139
1426
  # **postAdminCreateAccountContact**
1140
1427
  > postAdminCreateAccountContact()
1141
1428
 
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **id** | **number** | ID | [optional] [default to undefined]
12
12
  **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
13
13
  **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
14
+ **renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
14
15
  **processDate** | **string** | Date Time | [optional] [default to undefined]
15
16
  **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
16
17
  **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
@@ -27,6 +28,7 @@ const instance: CustomerItemRequestDTO = {
27
28
  id,
28
29
  licenceKey,
29
30
  hosting,
31
+ renewalYears,
30
32
  processDate,
31
33
  tcxSalesCode,
32
34
  sbcs,
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **id** | **number** | ID | [optional] [default to undefined]
12
12
  **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
13
13
  **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
14
+ **renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
14
15
  **processDate** | **string** | Date Time | [optional] [default to undefined]
15
16
  **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
16
17
  **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
@@ -30,6 +31,7 @@ const instance: DetailedItemRequestDTO = {
30
31
  id,
31
32
  licenceKey,
32
33
  hosting,
34
+ renewalYears,
33
35
  processDate,
34
36
  tcxSalesCode,
35
37
  sbcs,
package/docs/ItemDTO.md CHANGED
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
16
16
  **licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
17
17
  **processDate** | **string** | Date Time | [optional] [default to undefined]
18
18
  **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
19
+ **renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
19
20
  **promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
20
21
  **refunded** | **number** | Refunded | [optional] [default to undefined]
21
22
  **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
@@ -38,6 +39,7 @@ const instance: ItemDTO = {
38
39
  licenceExpiry,
39
40
  processDate,
40
41
  hosting,
42
+ renewalYears,
41
43
  promoItem,
42
44
  refunded,
43
45
  sbcs,
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
16
16
  **licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
17
17
  **processDate** | **string** | Date Time | [optional] [default to undefined]
18
18
  **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
19
+ **renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
19
20
  **promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
20
21
  **refunded** | **number** | Refunded | [optional] [default to undefined]
21
22
  **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
@@ -41,6 +42,7 @@ const instance: OrderItemDTO = {
41
42
  licenceExpiry,
42
43
  processDate,
43
44
  hosting,
45
+ renewalYears,
44
46
  promoItem,
45
47
  refunded,
46
48
  sbcs,
@@ -0,0 +1,20 @@
1
+ # PatchUpdateCreditLimitRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateCreditLimitRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateCreditLimitRequest = {
16
+ creditLimit,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # PatchUpdatePriceListRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **priceList** | **string** | Price List | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdatePriceListRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdatePriceListRequest = {
16
+ priceList,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # PatchUpdateSipChannelCostRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **channelCost** | **number** | SIP Channel Cost | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateSipChannelCostRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateSipChannelCostRequest = {
16
+ channelCost,
17
+ };
18
+ ```
19
+
20
+ [[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.139-dev.0",
3
+ "version": "3.2.141-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {