yellowgrid-api-ts 3.2.87-dev.0 → 3.2.87

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.
Files changed (62) hide show
  1. package/.openapi-generator/FILES +262 -257
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +16 -1
  4. package/api.ts +1100 -4703
  5. package/base.ts +2 -26
  6. package/common.ts +16 -39
  7. package/config.json +3 -3
  8. package/configuration.ts +25 -19
  9. package/dist/api.d.ts +462 -4301
  10. package/dist/api.js +1058 -496
  11. package/dist/base.d.ts +1 -25
  12. package/dist/base.js +2 -21
  13. package/dist/common.d.ts +5 -36
  14. package/dist/common.js +17 -39
  15. package/dist/configuration.d.ts +25 -18
  16. package/dist/configuration.js +2 -2
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/PortStatusEnum.d.ts +5 -0
  20. package/dist/models/PortStatusEnum.js +5 -0
  21. package/docs/AccountsApi.md +1 -1
  22. package/docs/AdminNumberPortDTO.md +4 -0
  23. package/docs/CRMApi.md +1 -1
  24. package/docs/Class3CXApi.md +1 -1
  25. package/docs/Class3CXInstallationWizardApi.md +1 -1
  26. package/docs/Class3CXInstallationsApi.md +59 -1
  27. package/docs/Class3CXIntegrationsApi.md +1 -1
  28. package/docs/Class3CXMultiTenantApi.md +1 -1
  29. package/docs/CreditNoteItemModel.md +29 -0
  30. package/docs/CreditNoteModel.md +2 -0
  31. package/docs/MyPBXToolsApi.md +1 -1
  32. package/docs/NumberPortingApi.md +61 -6
  33. package/docs/OAuth20Api.md +4 -4
  34. package/docs/OrderDetailsDTO.md +2 -0
  35. package/docs/OrdersApi.md +300 -2
  36. package/docs/PostAddAdminNoteRequest.md +20 -0
  37. package/docs/PricingApi.md +1 -1
  38. package/docs/ProductsApi.md +59 -1
  39. package/docs/ProvisioningApi.md +1 -1
  40. package/docs/SIPTrunksApi.md +1 -1
  41. package/docs/SMSApi.md +57 -1
  42. package/docs/ServicesApi.md +1 -1
  43. package/docs/ShippingApi.md +1 -1
  44. package/docs/ShippingRequestDTO.md +2 -0
  45. package/docs/SmsAccountDTO.md +31 -0
  46. package/docs/SmsAccountRequestDTO.md +29 -0
  47. package/docs/StockManagementApi.md +1 -1
  48. package/docs/SystemApi.md +1 -1
  49. package/docs/TcxSbcDTO.md +2 -0
  50. package/docs/TicketsApi.md +1 -1
  51. package/docs/WebhooksApi.md +1 -1
  52. package/getEnums.php +31 -31
  53. package/index.ts +1 -1
  54. package/models/PortStatusEnum.ts +5 -0
  55. package/openapitools.json +1 -1
  56. package/package.json +2 -2
  57. package/docs/NumberPortModel.md +0 -51
  58. package/docs/TelephonySupportTicketModel.md +0 -41
  59. package/hs_err_pid16044.log +0 -249
  60. package/hs_err_pid44560.log +0 -249
  61. package/hs_err_pid53988.log +0 -249
  62. package/hs_err_pid58728.log +0 -40
@@ -0,0 +1,29 @@
1
+ # CreditNoteItemModel
2
+
3
+ Credit Note Item
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
11
+ **orderId** | **number** | orderId | [optional] [default to undefined]
12
+ **itemId** | **number** | itemId | [optional] [default to undefined]
13
+ **amount** | **number** | amount | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { CreditNoteItemModel } from 'yellowgrid-api-ts';
19
+
20
+ const instance: CreditNoteItemModel = {
21
+ id,
22
+ creditNoteId,
23
+ orderId,
24
+ itemId,
25
+ amount,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **transactionId** | **string** | transactionId | [optional] [default to undefined]
12
12
  **amount** | **number** | amount | [optional] [default to undefined]
13
13
  **timestamp** | **string** | timestamp | [optional] [default to undefined]
14
+ **items** | [**Array<CreditNoteItemModel>**](CreditNoteItemModel.md) | Credit Note Items | [optional] [default to undefined]
14
15
 
15
16
  ## Example
16
17
 
@@ -23,6 +24,7 @@ const instance: CreditNoteModel = {
23
24
  transactionId,
24
25
  amount,
25
26
  timestamp,
27
+ items,
26
28
  };
27
29
  ```
28
30
 
@@ -1,6 +1,6 @@
1
1
  # MyPBXToolsApi
2
2
 
3
- All URIs are relative to *https://api.yellowgrid.local*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # NumberPortingApi
2
2
 
3
- All URIs are relative to *https://api.yellowgrid.local*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.yellowgrid.local*
9
9
  |[**getGetAdminNumberPort**](#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | |
10
10
  |[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
11
11
  |[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
12
+ |[**patchCancelAdminNumberPort**](#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel | |
12
13
  |[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
13
14
  |[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
14
15
  |[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
@@ -283,6 +284,59 @@ No authorization required
283
284
  - **Accept**: application/json
284
285
 
285
286
 
287
+ ### HTTP response details
288
+ | Status code | Description | Response headers |
289
+ |-------------|-------------|------------------|
290
+ |**200** | NumberPortResponseDTO | - |
291
+ |**400** | Bad Request | - |
292
+ |**401** | Unauthorised | - |
293
+ |**403** | Access Denied | - |
294
+
295
+ [[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)
296
+
297
+ # **patchCancelAdminNumberPort**
298
+ > AdminNumberPortDTO patchCancelAdminNumberPort()
299
+
300
+
301
+ ### Example
302
+
303
+ ```typescript
304
+ import {
305
+ NumberPortingApi,
306
+ Configuration
307
+ } from 'yellowgrid-api-ts';
308
+
309
+ const configuration = new Configuration();
310
+ const apiInstance = new NumberPortingApi(configuration);
311
+
312
+ let id: number; //Number Port ID (default to undefined)
313
+
314
+ const { status, data } = await apiInstance.patchCancelAdminNumberPort(
315
+ id
316
+ );
317
+ ```
318
+
319
+ ### Parameters
320
+
321
+ |Name | Type | Description | Notes|
322
+ |------------- | ------------- | ------------- | -------------|
323
+ | **id** | [**number**] | Number Port ID | defaults to undefined|
324
+
325
+
326
+ ### Return type
327
+
328
+ **AdminNumberPortDTO**
329
+
330
+ ### Authorization
331
+
332
+ No authorization required
333
+
334
+ ### HTTP request headers
335
+
336
+ - **Content-Type**: Not defined
337
+ - **Accept**: application/json
338
+
339
+
286
340
  ### HTTP response details
287
341
  | Status code | Description | Response headers |
288
342
  |-------------|-------------|------------------|
@@ -347,7 +401,7 @@ No authorization required
347
401
  [[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)
348
402
 
349
403
  # **postAddAdminNote**
350
- > AdminNumberPortDTO postAddAdminNote(body)
404
+ > AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
351
405
 
352
406
 
353
407
  ### Example
@@ -355,18 +409,19 @@ No authorization required
355
409
  ```typescript
356
410
  import {
357
411
  NumberPortingApi,
358
- Configuration
412
+ Configuration,
413
+ PostAddAdminNoteRequest
359
414
  } from 'yellowgrid-api-ts';
360
415
 
361
416
  const configuration = new Configuration();
362
417
  const apiInstance = new NumberPortingApi(configuration);
363
418
 
364
419
  let id: number; //Number Port ID (default to undefined)
365
- let body: string; //
420
+ let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
366
421
 
367
422
  const { status, data } = await apiInstance.postAddAdminNote(
368
423
  id,
369
- body
424
+ postAddAdminNoteRequest
370
425
  );
371
426
  ```
372
427
 
@@ -374,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
374
429
 
375
430
  |Name | Type | Description | Notes|
376
431
  |------------- | ------------- | ------------- | -------------|
377
- | **body** | **string**| | |
432
+ | **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
378
433
  | **id** | [**number**] | Number Port ID | defaults to undefined|
379
434
 
380
435
 
@@ -1,6 +1,6 @@
1
1
  # OAuth20Api
2
2
 
3
- All URIs are relative to *https://api.yellowgrid.local*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
157
157
  | **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
158
158
  | **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
159
159
  | **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
160
- | **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
160
+ | **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
161
161
  | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
162
162
  | **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
163
163
  | **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
210
210
 
211
211
  let clientId: string; //OAuth 2.0 Client ID (default to undefined)
212
212
  let responseType: string; //OAuth 2.0 Response Type (default to 'code')
213
- let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
213
+ let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
214
214
  let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
215
215
  let state: string; //OAuth 2.0 State (optional) (default to undefined)
216
216
  let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
233
233
  |------------- | ------------- | ------------- | -------------|
234
234
  | **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
235
235
  | **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
236
- | **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
236
+ | **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;sms.read&#39; | &#39;sms.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
237
237
  | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
238
238
  | **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
239
239
  | **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
28
28
  **paymentLink** | **string** | Card Payment Link | [optional] [default to undefined]
29
29
  **credits** | [**Array&lt;CreditNoteModel&gt;**](CreditNoteModel.md) | Credits | [optional] [default to undefined]
30
30
  **customerEmail** | **string** | Customer Email | [optional] [default to undefined]
31
+ **totals** | [**OrderTotalModel**](OrderTotalModel.md) | | [optional] [default to undefined]
31
32
 
32
33
  ## Example
33
34
 
@@ -57,6 +58,7 @@ const instance: OrderDetailsDTO = {
57
58
  paymentLink,
58
59
  credits,
59
60
  customerEmail,
61
+ totals,
60
62
  };
61
63
  ```
62
64
 
package/docs/OrdersApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://api.yellowgrid.local*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -9,11 +9,13 @@ All URIs are relative to *https://api.yellowgrid.local*
9
9
  |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
10
10
  |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
11
11
  |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
12
+ |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
12
13
  |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
13
14
  |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
14
15
  |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
15
16
  |[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
16
17
  |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
18
+ |[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
17
19
  |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
18
20
  |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
19
21
  |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
@@ -21,13 +23,16 @@ All URIs are relative to *https://api.yellowgrid.local*
21
23
  |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
22
24
  |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
23
25
  |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
26
+ |[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
24
27
  |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
25
28
  |[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
26
29
  |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
27
30
  |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
28
31
  |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
29
32
  |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
33
+ |[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
30
34
  |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
35
+ |[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
31
36
  |[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
32
37
 
33
38
  # **deleteDeleteBatch**
@@ -309,6 +314,66 @@ No authorization required
309
314
 
310
315
  [[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)
311
316
 
317
+ # **getGetCommercialInvoice**
318
+ > File getGetCommercialInvoice()
319
+
320
+ Get Commercial Invoice PDF
321
+
322
+ ### Example
323
+
324
+ ```typescript
325
+ import {
326
+ OrdersApi,
327
+ Configuration
328
+ } from 'yellowgrid-api-ts';
329
+
330
+ const configuration = new Configuration();
331
+ const apiInstance = new OrdersApi(configuration);
332
+
333
+ let id: number; //Order ID (default to undefined)
334
+ let batchId: number; //Batch ID (default to undefined)
335
+ let shipmentId: number; //Shipment ID (default to undefined)
336
+
337
+ const { status, data } = await apiInstance.getGetCommercialInvoice(
338
+ id,
339
+ batchId,
340
+ shipmentId
341
+ );
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ |Name | Type | Description | Notes|
347
+ |------------- | ------------- | ------------- | -------------|
348
+ | **id** | [**number**] | Order ID | defaults to undefined|
349
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
350
+ | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
351
+
352
+
353
+ ### Return type
354
+
355
+ **File**
356
+
357
+ ### Authorization
358
+
359
+ No authorization required
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: Not defined
364
+ - **Accept**: application/pdf
365
+
366
+
367
+ ### HTTP response details
368
+ | Status code | Description | Response headers |
369
+ |-------------|-------------|------------------|
370
+ |**200** | Order PDF | - |
371
+ |**400** | Bad Request | - |
372
+ |**401** | Unauthorised | - |
373
+ |**403** | Access Denied | - |
374
+
375
+ [[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)
376
+
312
377
  # **getGetEditableOrder**
313
378
  > DetailedOrderRequestDTO getGetEditableOrder()
314
379
 
@@ -600,6 +665,60 @@ No authorization required
600
665
 
601
666
  [[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)
602
667
 
668
+ # **patchCompleteOrder**
669
+ > OrderDetailsDTO patchCompleteOrder()
670
+
671
+ Mark Order As Complete (Admin)
672
+
673
+ ### Example
674
+
675
+ ```typescript
676
+ import {
677
+ OrdersApi,
678
+ Configuration
679
+ } from 'yellowgrid-api-ts';
680
+
681
+ const configuration = new Configuration();
682
+ const apiInstance = new OrdersApi(configuration);
683
+
684
+ let id: number; //Order ID (default to undefined)
685
+
686
+ const { status, data } = await apiInstance.patchCompleteOrder(
687
+ id
688
+ );
689
+ ```
690
+
691
+ ### Parameters
692
+
693
+ |Name | Type | Description | Notes|
694
+ |------------- | ------------- | ------------- | -------------|
695
+ | **id** | [**number**] | Order ID | defaults to undefined|
696
+
697
+
698
+ ### Return type
699
+
700
+ **OrderDetailsDTO**
701
+
702
+ ### Authorization
703
+
704
+ No authorization required
705
+
706
+ ### HTTP request headers
707
+
708
+ - **Content-Type**: Not defined
709
+ - **Accept**: application/json
710
+
711
+
712
+ ### HTTP response details
713
+ | Status code | Description | Response headers |
714
+ |-------------|-------------|------------------|
715
+ |**200** | Order Details | - |
716
+ |**400** | Bad Request | - |
717
+ |**401** | Unauthorised | - |
718
+ |**403** | Access Denied | - |
719
+
720
+ [[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)
721
+
603
722
  # **postAddOrderNote**
604
723
  > AuditLogEntity postAddOrderNote()
605
724
 
@@ -1001,13 +1120,71 @@ No authorization required
1001
1120
  ### HTTP request headers
1002
1121
 
1003
1122
  - **Content-Type**: Not defined
1004
- - **Accept**: text/html, application/json
1123
+ - **Accept**: text/html
1005
1124
 
1006
1125
 
1007
1126
  ### HTTP response details
1008
1127
  | Status code | Description | Response headers |
1009
1128
  |-------------|-------------|------------------|
1010
1129
  |**200** | Shipping Label | - |
1130
+ |**204** | No Response | - |
1131
+ |**400** | Bad Request | - |
1132
+ |**401** | Unauthorised | - |
1133
+ |**403** | Access Denied | - |
1134
+
1135
+ [[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)
1136
+
1137
+ # **postProcessTcxLicences**
1138
+ > OrderDetailsDTO postProcessTcxLicences()
1139
+
1140
+ Process 3CX Licences (Admin)
1141
+
1142
+ ### Example
1143
+
1144
+ ```typescript
1145
+ import {
1146
+ OrdersApi,
1147
+ Configuration
1148
+ } from 'yellowgrid-api-ts';
1149
+
1150
+ const configuration = new Configuration();
1151
+ const apiInstance = new OrdersApi(configuration);
1152
+
1153
+ let id: number; //Order ID (default to undefined)
1154
+ let batchId: number; //Batch ID (default to undefined)
1155
+
1156
+ const { status, data } = await apiInstance.postProcessTcxLicences(
1157
+ id,
1158
+ batchId
1159
+ );
1160
+ ```
1161
+
1162
+ ### Parameters
1163
+
1164
+ |Name | Type | Description | Notes|
1165
+ |------------- | ------------- | ------------- | -------------|
1166
+ | **id** | [**number**] | Order ID | defaults to undefined|
1167
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
1168
+
1169
+
1170
+ ### Return type
1171
+
1172
+ **OrderDetailsDTO**
1173
+
1174
+ ### Authorization
1175
+
1176
+ No authorization required
1177
+
1178
+ ### HTTP request headers
1179
+
1180
+ - **Content-Type**: Not defined
1181
+ - **Accept**: application/json
1182
+
1183
+
1184
+ ### HTTP response details
1185
+ | Status code | Description | Response headers |
1186
+ |-------------|-------------|------------------|
1187
+ |**200** | Order Details | - |
1011
1188
  |**400** | Bad Request | - |
1012
1189
  |**401** | Unauthorised | - |
1013
1190
  |**403** | Access Denied | - |
@@ -1371,6 +1548,70 @@ No authorization required
1371
1548
 
1372
1549
  [[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)
1373
1550
 
1551
+ # **putUpdateBatchItem**
1552
+ > OrderedItemModel putUpdateBatchItem()
1553
+
1554
+ Update Batch Item (Admin)
1555
+
1556
+ ### Example
1557
+
1558
+ ```typescript
1559
+ import {
1560
+ OrdersApi,
1561
+ Configuration,
1562
+ OrderedItemModel
1563
+ } from 'yellowgrid-api-ts';
1564
+
1565
+ const configuration = new Configuration();
1566
+ const apiInstance = new OrdersApi(configuration);
1567
+
1568
+ let id: number; //Order ID (default to undefined)
1569
+ let batchId: number; //Batch ID (default to undefined)
1570
+ let itemId: number; //Ordered Item ID (default to undefined)
1571
+ let orderedItemModel: OrderedItemModel; //Batch Item (optional)
1572
+
1573
+ const { status, data } = await apiInstance.putUpdateBatchItem(
1574
+ id,
1575
+ batchId,
1576
+ itemId,
1577
+ orderedItemModel
1578
+ );
1579
+ ```
1580
+
1581
+ ### Parameters
1582
+
1583
+ |Name | Type | Description | Notes|
1584
+ |------------- | ------------- | ------------- | -------------|
1585
+ | **orderedItemModel** | **OrderedItemModel**| Batch Item | |
1586
+ | **id** | [**number**] | Order ID | defaults to undefined|
1587
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
1588
+ | **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
1589
+
1590
+
1591
+ ### Return type
1592
+
1593
+ **OrderedItemModel**
1594
+
1595
+ ### Authorization
1596
+
1597
+ No authorization required
1598
+
1599
+ ### HTTP request headers
1600
+
1601
+ - **Content-Type**: application/json
1602
+ - **Accept**: application/json
1603
+
1604
+
1605
+ ### HTTP response details
1606
+ | Status code | Description | Response headers |
1607
+ |-------------|-------------|------------------|
1608
+ |**200** | Ordered Item | - |
1609
+ |**400** | Bad Request | - |
1610
+ |**401** | Unauthorised | - |
1611
+ |**403** | Access Denied | - |
1612
+
1613
+ [[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)
1614
+
1374
1615
  # **putUpdateOrder**
1375
1616
  > Array<OrderSummaryDTO> putUpdateOrder()
1376
1617
 
@@ -1432,6 +1673,63 @@ No authorization required
1432
1673
 
1433
1674
  [[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)
1434
1675
 
1676
+ # **putUpdatePaymentStatus**
1677
+ > OrderDetailsDTO putUpdatePaymentStatus()
1678
+
1679
+ Change Payment Status (Admin)
1680
+
1681
+ ### Example
1682
+
1683
+ ```typescript
1684
+ import {
1685
+ OrdersApi,
1686
+ Configuration
1687
+ } from 'yellowgrid-api-ts';
1688
+
1689
+ const configuration = new Configuration();
1690
+ const apiInstance = new OrdersApi(configuration);
1691
+
1692
+ let id: number; //Order ID (default to undefined)
1693
+ let paid: boolean; //Paid (default to undefined)
1694
+
1695
+ const { status, data } = await apiInstance.putUpdatePaymentStatus(
1696
+ id,
1697
+ paid
1698
+ );
1699
+ ```
1700
+
1701
+ ### Parameters
1702
+
1703
+ |Name | Type | Description | Notes|
1704
+ |------------- | ------------- | ------------- | -------------|
1705
+ | **id** | [**number**] | Order ID | defaults to undefined|
1706
+ | **paid** | [**boolean**] | Paid | defaults to undefined|
1707
+
1708
+
1709
+ ### Return type
1710
+
1711
+ **OrderDetailsDTO**
1712
+
1713
+ ### Authorization
1714
+
1715
+ No authorization required
1716
+
1717
+ ### HTTP request headers
1718
+
1719
+ - **Content-Type**: Not defined
1720
+ - **Accept**: application/json
1721
+
1722
+
1723
+ ### HTTP response details
1724
+ | Status code | Description | Response headers |
1725
+ |-------------|-------------|------------------|
1726
+ |**200** | Order Details | - |
1727
+ |**400** | Bad Request | - |
1728
+ |**401** | Unauthorised | - |
1729
+ |**403** | Access Denied | - |
1730
+
1731
+ [[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)
1732
+
1435
1733
  # **putUpdateShipment**
1436
1734
  > ShipmentDTO putUpdateShipment()
1437
1735
 
@@ -0,0 +1,20 @@
1
+ # PostAddAdminNoteRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **note** | **string** | Note | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PostAddAdminNoteRequest = {
16
+ note,
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)
@@ -1,6 +1,6 @@
1
1
  # PricingApi
2
2
 
3
- All URIs are relative to *https://api.yellowgrid.local*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|