yellowgrid-api-ts 3.2.80-dev.0 → 3.2.81

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 -2
  4. package/api.ts +1111 -4798
  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 +467 -4341
  10. package/dist/api.js +1047 -591
  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 +1 -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 +355 -66
  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 +4 -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
@@ -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,15 +9,18 @@ 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)|
14
+ |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
13
15
  |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
16
+ |[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
14
17
  |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
18
+ |[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
15
19
  |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
16
20
  |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
17
21
  |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
18
22
  |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
19
23
  |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
20
- |[**postGetShipmentItemSerialInfo**](#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)|
21
24
  |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
22
25
  |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
23
26
  |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
@@ -26,7 +29,9 @@ All URIs are relative to *https://api.yellowgrid.local*
26
29
  |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
27
30
  |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
28
31
  |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
32
+ |[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
29
33
  |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
34
+ |[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
30
35
  |[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
31
36
 
32
37
  # **deleteDeleteBatch**
@@ -308,6 +313,66 @@ No authorization required
308
313
 
309
314
  [[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)
310
315
 
316
+ # **getGetCommercialInvoice**
317
+ > File getGetCommercialInvoice()
318
+
319
+ Get Commercial Invoice PDF
320
+
321
+ ### Example
322
+
323
+ ```typescript
324
+ import {
325
+ OrdersApi,
326
+ Configuration
327
+ } from 'yellowgrid-api-ts';
328
+
329
+ const configuration = new Configuration();
330
+ const apiInstance = new OrdersApi(configuration);
331
+
332
+ let id: number; //Order ID (default to undefined)
333
+ let batchId: number; //Batch ID (default to undefined)
334
+ let shipmentId: number; //Shipment ID (default to undefined)
335
+
336
+ const { status, data } = await apiInstance.getGetCommercialInvoice(
337
+ id,
338
+ batchId,
339
+ shipmentId
340
+ );
341
+ ```
342
+
343
+ ### Parameters
344
+
345
+ |Name | Type | Description | Notes|
346
+ |------------- | ------------- | ------------- | -------------|
347
+ | **id** | [**number**] | Order ID | defaults to undefined|
348
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
349
+ | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
350
+
351
+
352
+ ### Return type
353
+
354
+ **File**
355
+
356
+ ### Authorization
357
+
358
+ No authorization required
359
+
360
+ ### HTTP request headers
361
+
362
+ - **Content-Type**: Not defined
363
+ - **Accept**: application/pdf
364
+
365
+
366
+ ### HTTP response details
367
+ | Status code | Description | Response headers |
368
+ |-------------|-------------|------------------|
369
+ |**200** | Order PDF | - |
370
+ |**400** | Bad Request | - |
371
+ |**401** | Unauthorised | - |
372
+ |**403** | Access Denied | - |
373
+
374
+ [[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)
375
+
311
376
  # **getGetEditableOrder**
312
377
  > DetailedOrderRequestDTO getGetEditableOrder()
313
378
 
@@ -362,6 +427,63 @@ No authorization required
362
427
 
363
428
  [[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)
364
429
 
430
+ # **getGetItemSerialInfo**
431
+ > ProductSerialInfoModel getGetItemSerialInfo()
432
+
433
+ Get Item Serial Info (Admin)
434
+
435
+ ### Example
436
+
437
+ ```typescript
438
+ import {
439
+ OrdersApi,
440
+ Configuration
441
+ } from 'yellowgrid-api-ts';
442
+
443
+ const configuration = new Configuration();
444
+ const apiInstance = new OrdersApi(configuration);
445
+
446
+ let id: number; //Order ID (default to undefined)
447
+ let itemId: number; //Shipment Item ID (default to undefined)
448
+
449
+ const { status, data } = await apiInstance.getGetItemSerialInfo(
450
+ id,
451
+ itemId
452
+ );
453
+ ```
454
+
455
+ ### Parameters
456
+
457
+ |Name | Type | Description | Notes|
458
+ |------------- | ------------- | ------------- | -------------|
459
+ | **id** | [**number**] | Order ID | defaults to undefined|
460
+ | **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
461
+
462
+
463
+ ### Return type
464
+
465
+ **ProductSerialInfoModel**
466
+
467
+ ### Authorization
468
+
469
+ No authorization required
470
+
471
+ ### HTTP request headers
472
+
473
+ - **Content-Type**: Not defined
474
+ - **Accept**: application/json
475
+
476
+
477
+ ### HTTP response details
478
+ | Status code | Description | Response headers |
479
+ |-------------|-------------|------------------|
480
+ |**200** | Serial Info | - |
481
+ |**400** | Bad Request | - |
482
+ |**401** | Unauthorised | - |
483
+ |**403** | Access Denied | - |
484
+
485
+ [[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)
486
+
365
487
  # **getGetOrderPdf**
366
488
  > File getGetOrderPdf()
367
489
 
@@ -416,6 +538,60 @@ No authorization required
416
538
 
417
539
  [[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)
418
540
 
541
+ # **getGetOrderSummary**
542
+ > OrderSummaryDTO getGetOrderSummary()
543
+
544
+ Get Order Summary (Admin)
545
+
546
+ ### Example
547
+
548
+ ```typescript
549
+ import {
550
+ OrdersApi,
551
+ Configuration
552
+ } from 'yellowgrid-api-ts';
553
+
554
+ const configuration = new Configuration();
555
+ const apiInstance = new OrdersApi(configuration);
556
+
557
+ let id: number; //Order ID (default to undefined)
558
+
559
+ const { status, data } = await apiInstance.getGetOrderSummary(
560
+ id
561
+ );
562
+ ```
563
+
564
+ ### Parameters
565
+
566
+ |Name | Type | Description | Notes|
567
+ |------------- | ------------- | ------------- | -------------|
568
+ | **id** | [**number**] | Order ID | defaults to undefined|
569
+
570
+
571
+ ### Return type
572
+
573
+ **OrderSummaryDTO**
574
+
575
+ ### Authorization
576
+
577
+ No authorization required
578
+
579
+ ### HTTP request headers
580
+
581
+ - **Content-Type**: Not defined
582
+ - **Accept**: application/json
583
+
584
+
585
+ ### HTTP response details
586
+ | Status code | Description | Response headers |
587
+ |-------------|-------------|------------------|
588
+ |**200** | Order Summary | - |
589
+ |**400** | Bad Request | - |
590
+ |**401** | Unauthorised | - |
591
+ |**403** | Access Denied | - |
592
+
593
+ [[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)
594
+
419
595
  # **getGetOrders**
420
596
  > OrderSummariesModel getGetOrders()
421
597
 
@@ -488,6 +664,60 @@ No authorization required
488
664
 
489
665
  [[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)
490
666
 
667
+ # **patchCompleteOrder**
668
+ > OrderDetailsDTO patchCompleteOrder()
669
+
670
+ Mark Order As Complete (Admin)
671
+
672
+ ### Example
673
+
674
+ ```typescript
675
+ import {
676
+ OrdersApi,
677
+ Configuration
678
+ } from 'yellowgrid-api-ts';
679
+
680
+ const configuration = new Configuration();
681
+ const apiInstance = new OrdersApi(configuration);
682
+
683
+ let id: number; //Order ID (default to undefined)
684
+
685
+ const { status, data } = await apiInstance.patchCompleteOrder(
686
+ id
687
+ );
688
+ ```
689
+
690
+ ### Parameters
691
+
692
+ |Name | Type | Description | Notes|
693
+ |------------- | ------------- | ------------- | -------------|
694
+ | **id** | [**number**] | Order ID | defaults to undefined|
695
+
696
+
697
+ ### Return type
698
+
699
+ **OrderDetailsDTO**
700
+
701
+ ### Authorization
702
+
703
+ No authorization required
704
+
705
+ ### HTTP request headers
706
+
707
+ - **Content-Type**: Not defined
708
+ - **Accept**: application/json
709
+
710
+
711
+ ### HTTP response details
712
+ | Status code | Description | Response headers |
713
+ |-------------|-------------|------------------|
714
+ |**200** | Order Details | - |
715
+ |**400** | Bad Request | - |
716
+ |**401** | Unauthorised | - |
717
+ |**403** | Access Denied | - |
718
+
719
+ [[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)
720
+
491
721
  # **postAddOrderNote**
492
722
  > AuditLogEntity postAddOrderNote()
493
723
 
@@ -784,69 +1014,6 @@ No authorization required
784
1014
 
785
1015
  [[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)
786
1016
 
787
- # **postGetShipmentItemSerialInfo**
788
- > ProductSerialInfoModel postGetShipmentItemSerialInfo()
789
-
790
- Get Shipment Item Serial Info (Admin)
791
-
792
- ### Example
793
-
794
- ```typescript
795
- import {
796
- OrdersApi,
797
- Configuration
798
- } from 'yellowgrid-api-ts';
799
-
800
- const configuration = new Configuration();
801
- const apiInstance = new OrdersApi(configuration);
802
-
803
- let id: number; //Order ID (default to undefined)
804
- let batchId: number; //Batch ID (default to undefined)
805
- let shipmentId: number; //Shipment ID (default to undefined)
806
- let itemId: number; //Shipment Item ID (default to undefined)
807
-
808
- const { status, data } = await apiInstance.postGetShipmentItemSerialInfo(
809
- id,
810
- batchId,
811
- shipmentId,
812
- itemId
813
- );
814
- ```
815
-
816
- ### Parameters
817
-
818
- |Name | Type | Description | Notes|
819
- |------------- | ------------- | ------------- | -------------|
820
- | **id** | [**number**] | Order ID | defaults to undefined|
821
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
822
- | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
823
- | **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
824
-
825
-
826
- ### Return type
827
-
828
- **ProductSerialInfoModel**
829
-
830
- ### Authorization
831
-
832
- No authorization required
833
-
834
- ### HTTP request headers
835
-
836
- - **Content-Type**: Not defined
837
- - **Accept**: application/json
838
-
839
-
840
- ### HTTP response details
841
- | Status code | Description | Response headers |
842
- |-------------|-------------|------------------|
843
- |**200** | Serial Info | - |
844
- |**400** | Bad Request | - |
845
- |**401** | Unauthorised | - |
846
- |**403** | Access Denied | - |
847
-
848
- [[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)
849
-
850
1017
  # **postIssueCredit**
851
1018
  > CreditNoteModel postIssueCredit()
852
1019
 
@@ -952,13 +1119,14 @@ No authorization required
952
1119
  ### HTTP request headers
953
1120
 
954
1121
  - **Content-Type**: Not defined
955
- - **Accept**: text/html, application/json
1122
+ - **Accept**: text/html
956
1123
 
957
1124
 
958
1125
  ### HTTP response details
959
1126
  | Status code | Description | Response headers |
960
1127
  |-------------|-------------|------------------|
961
1128
  |**200** | Shipping Label | - |
1129
+ |**204** | No Response | - |
962
1130
  |**400** | Bad Request | - |
963
1131
  |**401** | Unauthorised | - |
964
1132
  |**403** | Access Denied | - |
@@ -1322,6 +1490,70 @@ No authorization required
1322
1490
 
1323
1491
  [[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)
1324
1492
 
1493
+ # **putUpdateBatchItem**
1494
+ > OrderedItemModel putUpdateBatchItem()
1495
+
1496
+ Update Batch Item (Admin)
1497
+
1498
+ ### Example
1499
+
1500
+ ```typescript
1501
+ import {
1502
+ OrdersApi,
1503
+ Configuration,
1504
+ OrderedItemModel
1505
+ } from 'yellowgrid-api-ts';
1506
+
1507
+ const configuration = new Configuration();
1508
+ const apiInstance = new OrdersApi(configuration);
1509
+
1510
+ let id: number; //Order ID (default to undefined)
1511
+ let batchId: number; //Batch ID (default to undefined)
1512
+ let itemId: number; //Ordered Item ID (default to undefined)
1513
+ let orderedItemModel: OrderedItemModel; //Batch Item (optional)
1514
+
1515
+ const { status, data } = await apiInstance.putUpdateBatchItem(
1516
+ id,
1517
+ batchId,
1518
+ itemId,
1519
+ orderedItemModel
1520
+ );
1521
+ ```
1522
+
1523
+ ### Parameters
1524
+
1525
+ |Name | Type | Description | Notes|
1526
+ |------------- | ------------- | ------------- | -------------|
1527
+ | **orderedItemModel** | **OrderedItemModel**| Batch Item | |
1528
+ | **id** | [**number**] | Order ID | defaults to undefined|
1529
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
1530
+ | **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
1531
+
1532
+
1533
+ ### Return type
1534
+
1535
+ **OrderedItemModel**
1536
+
1537
+ ### Authorization
1538
+
1539
+ No authorization required
1540
+
1541
+ ### HTTP request headers
1542
+
1543
+ - **Content-Type**: application/json
1544
+ - **Accept**: application/json
1545
+
1546
+
1547
+ ### HTTP response details
1548
+ | Status code | Description | Response headers |
1549
+ |-------------|-------------|------------------|
1550
+ |**200** | Ordered Item | - |
1551
+ |**400** | Bad Request | - |
1552
+ |**401** | Unauthorised | - |
1553
+ |**403** | Access Denied | - |
1554
+
1555
+ [[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)
1556
+
1325
1557
  # **putUpdateOrder**
1326
1558
  > Array<OrderSummaryDTO> putUpdateOrder()
1327
1559
 
@@ -1383,6 +1615,63 @@ No authorization required
1383
1615
 
1384
1616
  [[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)
1385
1617
 
1618
+ # **putUpdatePaymentStatus**
1619
+ > OrderDetailsDTO putUpdatePaymentStatus()
1620
+
1621
+ Change Payment Status (Admin)
1622
+
1623
+ ### Example
1624
+
1625
+ ```typescript
1626
+ import {
1627
+ OrdersApi,
1628
+ Configuration
1629
+ } from 'yellowgrid-api-ts';
1630
+
1631
+ const configuration = new Configuration();
1632
+ const apiInstance = new OrdersApi(configuration);
1633
+
1634
+ let id: number; //Order ID (default to undefined)
1635
+ let paid: boolean; //Paid (default to undefined)
1636
+
1637
+ const { status, data } = await apiInstance.putUpdatePaymentStatus(
1638
+ id,
1639
+ paid
1640
+ );
1641
+ ```
1642
+
1643
+ ### Parameters
1644
+
1645
+ |Name | Type | Description | Notes|
1646
+ |------------- | ------------- | ------------- | -------------|
1647
+ | **id** | [**number**] | Order ID | defaults to undefined|
1648
+ | **paid** | [**boolean**] | Paid | defaults to undefined|
1649
+
1650
+
1651
+ ### Return type
1652
+
1653
+ **OrderDetailsDTO**
1654
+
1655
+ ### Authorization
1656
+
1657
+ No authorization required
1658
+
1659
+ ### HTTP request headers
1660
+
1661
+ - **Content-Type**: Not defined
1662
+ - **Accept**: application/json
1663
+
1664
+
1665
+ ### HTTP response details
1666
+ | Status code | Description | Response headers |
1667
+ |-------------|-------------|------------------|
1668
+ |**200** | Order Details | - |
1669
+ |**400** | Bad Request | - |
1670
+ |**401** | Unauthorised | - |
1671
+ |**403** | Access Denied | - |
1672
+
1673
+ [[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)
1674
+
1386
1675
  # **putUpdateShipment**
1387
1676
  > ShipmentDTO putUpdateShipment()
1388
1677