yellowgrid-api-ts 3.2.138-dev.0 → 3.2.140-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,9 +5,10 @@ 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|
9
10
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
10
- |[**getAdminGetAccountContacts**](#getadmingetaccountcontacts) | **GET** /admin/accounts/{id}/contacts | |
11
+ |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
11
12
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
12
13
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
13
14
  |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
@@ -24,7 +25,10 @@ All URIs are relative to *https://localhost*
24
25
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
25
26
  |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
26
27
  |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
27
- |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts/ | |
28
+ |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
29
+ |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
30
+ |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
31
+ |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
28
32
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
29
33
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
30
34
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
@@ -71,6 +75,60 @@ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
71
75
  | **contactId** | [**number**] | Contact ID | defaults to undefined|
72
76
 
73
77
 
78
+ ### Return type
79
+
80
+ void (empty response body)
81
+
82
+ ### Authorization
83
+
84
+ No authorization required
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: Not defined
89
+ - **Accept**: Not defined
90
+
91
+
92
+ ### HTTP response details
93
+ | Status code | Description | Response headers |
94
+ |-------------|-------------|------------------|
95
+ |**204** | No Response | - |
96
+ |**400** | Bad Request | - |
97
+ |**401** | Unauthorised | - |
98
+ |**403** | Access Denied | - |
99
+
100
+ [[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)
101
+
102
+ # **deleteArchiveAccount**
103
+ > deleteArchiveAccount()
104
+
105
+ Delete Account
106
+
107
+ ### Example
108
+
109
+ ```typescript
110
+ import {
111
+ AccountsApi,
112
+ Configuration
113
+ } from 'yellowgrid-api-ts';
114
+
115
+ const configuration = new Configuration();
116
+ const apiInstance = new AccountsApi(configuration);
117
+
118
+ let id: string; //Account Xero ID (default to undefined)
119
+
120
+ const { status, data } = await apiInstance.deleteArchiveAccount(
121
+ id
122
+ );
123
+ ```
124
+
125
+ ### Parameters
126
+
127
+ |Name | Type | Description | Notes|
128
+ |------------- | ------------- | ------------- | -------------|
129
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
130
+
131
+
74
132
  ### Return type
75
133
 
76
134
  void (empty response body)
@@ -203,8 +261,8 @@ No authorization required
203
261
 
204
262
  [[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)
205
263
 
206
- # **getAdminGetAccountContacts**
207
- > Array<AccountContactModel> getAdminGetAccountContacts()
264
+ # **getAdminCreateAccountContact**
265
+ > Array<AccountContactModel> getAdminCreateAccountContact()
208
266
 
209
267
  Get Account Contacts
210
268
 
@@ -221,7 +279,7 @@ const apiInstance = new AccountsApi(configuration);
221
279
 
222
280
  let id: string; //Account Xero ID (default to undefined)
223
281
 
224
- const { status, data } = await apiInstance.getAdminGetAccountContacts(
282
+ const { status, data } = await apiInstance.getAdminCreateAccountContact(
225
283
  id
226
284
  );
227
285
  ```
@@ -1136,6 +1194,180 @@ No authorization required
1136
1194
 
1137
1195
  [[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
1196
 
1197
+ # **patchUpdateCreditLimit**
1198
+ > AccountFinanceDTO patchUpdateCreditLimit()
1199
+
1200
+ Set Account Credit Limit
1201
+
1202
+ ### Example
1203
+
1204
+ ```typescript
1205
+ import {
1206
+ AccountsApi,
1207
+ Configuration,
1208
+ PatchUpdateCreditLimitRequest
1209
+ } from 'yellowgrid-api-ts';
1210
+
1211
+ const configuration = new Configuration();
1212
+ const apiInstance = new AccountsApi(configuration);
1213
+
1214
+ let id: string; //Xero ID (default to undefined)
1215
+ let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
1216
+
1217
+ const { status, data } = await apiInstance.patchUpdateCreditLimit(
1218
+ id,
1219
+ patchUpdateCreditLimitRequest
1220
+ );
1221
+ ```
1222
+
1223
+ ### Parameters
1224
+
1225
+ |Name | Type | Description | Notes|
1226
+ |------------- | ------------- | ------------- | -------------|
1227
+ | **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
1228
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1229
+
1230
+
1231
+ ### Return type
1232
+
1233
+ **AccountFinanceDTO**
1234
+
1235
+ ### Authorization
1236
+
1237
+ No authorization required
1238
+
1239
+ ### HTTP request headers
1240
+
1241
+ - **Content-Type**: application/json
1242
+ - **Accept**: application/json
1243
+
1244
+
1245
+ ### HTTP response details
1246
+ | Status code | Description | Response headers |
1247
+ |-------------|-------------|------------------|
1248
+ |**200** | Accounts Finance Details | - |
1249
+ |**400** | Bad Request | - |
1250
+ |**401** | Unauthorised | - |
1251
+ |**403** | Access Denied | - |
1252
+
1253
+ [[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)
1254
+
1255
+ # **patchUpdatePriceList**
1256
+ > AccountFinanceDTO patchUpdatePriceList()
1257
+
1258
+ Set Account Price List
1259
+
1260
+ ### Example
1261
+
1262
+ ```typescript
1263
+ import {
1264
+ AccountsApi,
1265
+ Configuration,
1266
+ PatchUpdatePriceListRequest
1267
+ } from 'yellowgrid-api-ts';
1268
+
1269
+ const configuration = new Configuration();
1270
+ const apiInstance = new AccountsApi(configuration);
1271
+
1272
+ let id: string; //Xero ID (default to undefined)
1273
+ let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
1274
+
1275
+ const { status, data } = await apiInstance.patchUpdatePriceList(
1276
+ id,
1277
+ patchUpdatePriceListRequest
1278
+ );
1279
+ ```
1280
+
1281
+ ### Parameters
1282
+
1283
+ |Name | Type | Description | Notes|
1284
+ |------------- | ------------- | ------------- | -------------|
1285
+ | **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
1286
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1287
+
1288
+
1289
+ ### Return type
1290
+
1291
+ **AccountFinanceDTO**
1292
+
1293
+ ### Authorization
1294
+
1295
+ No authorization required
1296
+
1297
+ ### HTTP request headers
1298
+
1299
+ - **Content-Type**: application/json
1300
+ - **Accept**: application/json
1301
+
1302
+
1303
+ ### HTTP response details
1304
+ | Status code | Description | Response headers |
1305
+ |-------------|-------------|------------------|
1306
+ |**200** | Accounts Finance Details | - |
1307
+ |**400** | Bad Request | - |
1308
+ |**401** | Unauthorised | - |
1309
+ |**403** | Access Denied | - |
1310
+
1311
+ [[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)
1312
+
1313
+ # **patchUpdateSipChannelCost**
1314
+ > AccountFinanceDTO patchUpdateSipChannelCost()
1315
+
1316
+ Set Account SIP Channel Cost
1317
+
1318
+ ### Example
1319
+
1320
+ ```typescript
1321
+ import {
1322
+ AccountsApi,
1323
+ Configuration,
1324
+ PatchUpdateSipChannelCostRequest
1325
+ } from 'yellowgrid-api-ts';
1326
+
1327
+ const configuration = new Configuration();
1328
+ const apiInstance = new AccountsApi(configuration);
1329
+
1330
+ let id: string; //Xero ID (default to undefined)
1331
+ let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
1332
+
1333
+ const { status, data } = await apiInstance.patchUpdateSipChannelCost(
1334
+ id,
1335
+ patchUpdateSipChannelCostRequest
1336
+ );
1337
+ ```
1338
+
1339
+ ### Parameters
1340
+
1341
+ |Name | Type | Description | Notes|
1342
+ |------------- | ------------- | ------------- | -------------|
1343
+ | **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
1344
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1345
+
1346
+
1347
+ ### Return type
1348
+
1349
+ **AccountFinanceDTO**
1350
+
1351
+ ### Authorization
1352
+
1353
+ No authorization required
1354
+
1355
+ ### HTTP request headers
1356
+
1357
+ - **Content-Type**: application/json
1358
+ - **Accept**: application/json
1359
+
1360
+
1361
+ ### HTTP response details
1362
+ | Status code | Description | Response headers |
1363
+ |-------------|-------------|------------------|
1364
+ |**200** | Accounts Finance Details | - |
1365
+ |**400** | Bad Request | - |
1366
+ |**401** | Unauthorised | - |
1367
+ |**403** | Access Denied | - |
1368
+
1369
+ [[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)
1370
+
1139
1371
  # **postAdminCreateAccountContact**
1140
1372
  > postAdminCreateAccountContact()
1141
1373
 
@@ -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&lt;TcxSbcDTO&gt;**](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&lt;TcxSbcDTO&gt;**](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&lt;TcxSbcDTO&gt;**](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&lt;TcxSbcDTO&gt;**](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.138-dev.0",
3
+ "version": "3.2.140-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {