yellowgrid-api-ts 3.2.80-dev.0 → 3.2.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +262 -257
- package/.openapi-generator/VERSION +1 -1
- package/README.md +15 -2
- package/api.ts +1020 -4789
- package/base.ts +2 -26
- package/common.ts +16 -39
- package/config.json +3 -3
- package/configuration.ts +25 -19
- package/dist/api.d.ts +428 -4342
- package/dist/api.js +954 -594
- package/dist/base.d.ts +1 -25
- package/dist/base.js +2 -21
- package/dist/common.d.ts +5 -36
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/PortStatusEnum.d.ts +5 -0
- package/dist/models/PortStatusEnum.js +5 -0
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminNumberPortDTO.md +4 -0
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CreditNoteItemModel.md +29 -0
- package/docs/CreditNoteModel.md +2 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +61 -6
- package/docs/OAuth20Api.md +4 -4
- package/docs/OrderDetailsDTO.md +2 -0
- package/docs/OrdersApi.md +294 -66
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductsApi.md +59 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +57 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShippingApi.md +1 -1
- package/docs/ShippingRequestDTO.md +4 -0
- package/docs/SmsAccountDTO.md +31 -0
- package/docs/SmsAccountRequestDTO.md +29 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TcxSbcDTO.md +2 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/models/PortStatusEnum.ts +5 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/docs/NumberPortModel.md +0 -51
- package/docs/TelephonySupportTicketModel.md +0 -41
- package/hs_err_pid16044.log +0 -249
- package/hs_err_pid44560.log +0 -249
- package/hs_err_pid53988.log +0 -249
- package/hs_err_pid58728.log +0 -40
package/docs/NumberPortingApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# NumberPortingApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
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(
|
|
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
|
|
420
|
+
let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
|
|
366
421
|
|
|
367
422
|
const { status, data } = await apiInstance.postAddAdminNote(
|
|
368
423
|
id,
|
|
369
|
-
|
|
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
|
-
| **
|
|
432
|
+
| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
|
|
378
433
|
| **id** | [**number**] | Number Port ID | defaults to undefined|
|
|
379
434
|
|
|
380
435
|
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OAuth20Api
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
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<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
160
|
-
| **scope** | [**string**]**Array<'*' | '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 | (optional) defaults to undefined|
|
|
160
|
+
| **scope** | [**string**]**Array<'*' | '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 | (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** | [**'*' | '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'**]**Array<'*' | '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 | defaults to undefined|
|
|
236
|
+
| **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'**]**Array<'*' | '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 | 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|
|
package/docs/OrderDetailsDTO.md
CHANGED
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**paymentLink** | **string** | Card Payment Link | [optional] [default to undefined]
|
|
29
29
|
**credits** | [**Array<CreditNoteModel>**](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://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -10,14 +10,16 @@ All URIs are relative to *https://api.yellowgrid.local*
|
|
|
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
12
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
13
|
+
|[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
13
14
|
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
15
|
+
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
14
16
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
17
|
+
|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
|
|
15
18
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
16
19
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
17
20
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
18
21
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
19
22
|
|[**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
23
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
22
24
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
23
25
|
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
@@ -26,7 +28,9 @@ All URIs are relative to *https://api.yellowgrid.local*
|
|
|
26
28
|
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
27
29
|
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
28
30
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
31
|
+
|[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
|
|
29
32
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
33
|
+
|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
|
|
30
34
|
|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
|
|
31
35
|
|
|
32
36
|
# **deleteDeleteBatch**
|
|
@@ -362,6 +366,63 @@ No authorization required
|
|
|
362
366
|
|
|
363
367
|
[[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
368
|
|
|
369
|
+
# **getGetItemSerialInfo**
|
|
370
|
+
> ProductSerialInfoModel getGetItemSerialInfo()
|
|
371
|
+
|
|
372
|
+
Get Item Serial Info (Admin)
|
|
373
|
+
|
|
374
|
+
### Example
|
|
375
|
+
|
|
376
|
+
```typescript
|
|
377
|
+
import {
|
|
378
|
+
OrdersApi,
|
|
379
|
+
Configuration
|
|
380
|
+
} from 'yellowgrid-api-ts';
|
|
381
|
+
|
|
382
|
+
const configuration = new Configuration();
|
|
383
|
+
const apiInstance = new OrdersApi(configuration);
|
|
384
|
+
|
|
385
|
+
let id: number; //Order ID (default to undefined)
|
|
386
|
+
let itemId: number; //Shipment Item ID (default to undefined)
|
|
387
|
+
|
|
388
|
+
const { status, data } = await apiInstance.getGetItemSerialInfo(
|
|
389
|
+
id,
|
|
390
|
+
itemId
|
|
391
|
+
);
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### Parameters
|
|
395
|
+
|
|
396
|
+
|Name | Type | Description | Notes|
|
|
397
|
+
|------------- | ------------- | ------------- | -------------|
|
|
398
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
399
|
+
| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
### Return type
|
|
403
|
+
|
|
404
|
+
**ProductSerialInfoModel**
|
|
405
|
+
|
|
406
|
+
### Authorization
|
|
407
|
+
|
|
408
|
+
No authorization required
|
|
409
|
+
|
|
410
|
+
### HTTP request headers
|
|
411
|
+
|
|
412
|
+
- **Content-Type**: Not defined
|
|
413
|
+
- **Accept**: application/json
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
### HTTP response details
|
|
417
|
+
| Status code | Description | Response headers |
|
|
418
|
+
|-------------|-------------|------------------|
|
|
419
|
+
|**200** | Serial Info | - |
|
|
420
|
+
|**400** | Bad Request | - |
|
|
421
|
+
|**401** | Unauthorised | - |
|
|
422
|
+
|**403** | Access Denied | - |
|
|
423
|
+
|
|
424
|
+
[[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)
|
|
425
|
+
|
|
365
426
|
# **getGetOrderPdf**
|
|
366
427
|
> File getGetOrderPdf()
|
|
367
428
|
|
|
@@ -416,6 +477,60 @@ No authorization required
|
|
|
416
477
|
|
|
417
478
|
[[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
479
|
|
|
480
|
+
# **getGetOrderSummary**
|
|
481
|
+
> OrderSummaryDTO getGetOrderSummary()
|
|
482
|
+
|
|
483
|
+
Get Order Summary (Admin)
|
|
484
|
+
|
|
485
|
+
### Example
|
|
486
|
+
|
|
487
|
+
```typescript
|
|
488
|
+
import {
|
|
489
|
+
OrdersApi,
|
|
490
|
+
Configuration
|
|
491
|
+
} from 'yellowgrid-api-ts';
|
|
492
|
+
|
|
493
|
+
const configuration = new Configuration();
|
|
494
|
+
const apiInstance = new OrdersApi(configuration);
|
|
495
|
+
|
|
496
|
+
let id: number; //Order ID (default to undefined)
|
|
497
|
+
|
|
498
|
+
const { status, data } = await apiInstance.getGetOrderSummary(
|
|
499
|
+
id
|
|
500
|
+
);
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Parameters
|
|
504
|
+
|
|
505
|
+
|Name | Type | Description | Notes|
|
|
506
|
+
|------------- | ------------- | ------------- | -------------|
|
|
507
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
### Return type
|
|
511
|
+
|
|
512
|
+
**OrderSummaryDTO**
|
|
513
|
+
|
|
514
|
+
### Authorization
|
|
515
|
+
|
|
516
|
+
No authorization required
|
|
517
|
+
|
|
518
|
+
### HTTP request headers
|
|
519
|
+
|
|
520
|
+
- **Content-Type**: Not defined
|
|
521
|
+
- **Accept**: application/json
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
### HTTP response details
|
|
525
|
+
| Status code | Description | Response headers |
|
|
526
|
+
|-------------|-------------|------------------|
|
|
527
|
+
|**200** | Order Summary | - |
|
|
528
|
+
|**400** | Bad Request | - |
|
|
529
|
+
|**401** | Unauthorised | - |
|
|
530
|
+
|**403** | Access Denied | - |
|
|
531
|
+
|
|
532
|
+
[[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)
|
|
533
|
+
|
|
419
534
|
# **getGetOrders**
|
|
420
535
|
> OrderSummariesModel getGetOrders()
|
|
421
536
|
|
|
@@ -488,6 +603,60 @@ No authorization required
|
|
|
488
603
|
|
|
489
604
|
[[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
605
|
|
|
606
|
+
# **patchCompleteOrder**
|
|
607
|
+
> OrderDetailsDTO patchCompleteOrder()
|
|
608
|
+
|
|
609
|
+
Mark Order As Complete (Admin)
|
|
610
|
+
|
|
611
|
+
### Example
|
|
612
|
+
|
|
613
|
+
```typescript
|
|
614
|
+
import {
|
|
615
|
+
OrdersApi,
|
|
616
|
+
Configuration
|
|
617
|
+
} from 'yellowgrid-api-ts';
|
|
618
|
+
|
|
619
|
+
const configuration = new Configuration();
|
|
620
|
+
const apiInstance = new OrdersApi(configuration);
|
|
621
|
+
|
|
622
|
+
let id: number; //Order ID (default to undefined)
|
|
623
|
+
|
|
624
|
+
const { status, data } = await apiInstance.patchCompleteOrder(
|
|
625
|
+
id
|
|
626
|
+
);
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
### Parameters
|
|
630
|
+
|
|
631
|
+
|Name | Type | Description | Notes|
|
|
632
|
+
|------------- | ------------- | ------------- | -------------|
|
|
633
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
### Return type
|
|
637
|
+
|
|
638
|
+
**OrderDetailsDTO**
|
|
639
|
+
|
|
640
|
+
### Authorization
|
|
641
|
+
|
|
642
|
+
No authorization required
|
|
643
|
+
|
|
644
|
+
### HTTP request headers
|
|
645
|
+
|
|
646
|
+
- **Content-Type**: Not defined
|
|
647
|
+
- **Accept**: application/json
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
### HTTP response details
|
|
651
|
+
| Status code | Description | Response headers |
|
|
652
|
+
|-------------|-------------|------------------|
|
|
653
|
+
|**200** | Order Details | - |
|
|
654
|
+
|**400** | Bad Request | - |
|
|
655
|
+
|**401** | Unauthorised | - |
|
|
656
|
+
|**403** | Access Denied | - |
|
|
657
|
+
|
|
658
|
+
[[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)
|
|
659
|
+
|
|
491
660
|
# **postAddOrderNote**
|
|
492
661
|
> AuditLogEntity postAddOrderNote()
|
|
493
662
|
|
|
@@ -784,69 +953,6 @@ No authorization required
|
|
|
784
953
|
|
|
785
954
|
[[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
955
|
|
|
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
956
|
# **postIssueCredit**
|
|
851
957
|
> CreditNoteModel postIssueCredit()
|
|
852
958
|
|
|
@@ -952,13 +1058,14 @@ No authorization required
|
|
|
952
1058
|
### HTTP request headers
|
|
953
1059
|
|
|
954
1060
|
- **Content-Type**: Not defined
|
|
955
|
-
- **Accept**: text/html
|
|
1061
|
+
- **Accept**: text/html
|
|
956
1062
|
|
|
957
1063
|
|
|
958
1064
|
### HTTP response details
|
|
959
1065
|
| Status code | Description | Response headers |
|
|
960
1066
|
|-------------|-------------|------------------|
|
|
961
1067
|
|**200** | Shipping Label | - |
|
|
1068
|
+
|**204** | No Response | - |
|
|
962
1069
|
|**400** | Bad Request | - |
|
|
963
1070
|
|**401** | Unauthorised | - |
|
|
964
1071
|
|**403** | Access Denied | - |
|
|
@@ -1322,6 +1429,70 @@ No authorization required
|
|
|
1322
1429
|
|
|
1323
1430
|
[[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
1431
|
|
|
1432
|
+
# **putUpdateBatchItem**
|
|
1433
|
+
> OrderedItemModel putUpdateBatchItem()
|
|
1434
|
+
|
|
1435
|
+
Update Batch Item (Admin)
|
|
1436
|
+
|
|
1437
|
+
### Example
|
|
1438
|
+
|
|
1439
|
+
```typescript
|
|
1440
|
+
import {
|
|
1441
|
+
OrdersApi,
|
|
1442
|
+
Configuration,
|
|
1443
|
+
OrderedItemModel
|
|
1444
|
+
} from 'yellowgrid-api-ts';
|
|
1445
|
+
|
|
1446
|
+
const configuration = new Configuration();
|
|
1447
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1448
|
+
|
|
1449
|
+
let id: number; //Order ID (default to undefined)
|
|
1450
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1451
|
+
let itemId: number; //Ordered Item ID (default to undefined)
|
|
1452
|
+
let orderedItemModel: OrderedItemModel; //Batch Item (optional)
|
|
1453
|
+
|
|
1454
|
+
const { status, data } = await apiInstance.putUpdateBatchItem(
|
|
1455
|
+
id,
|
|
1456
|
+
batchId,
|
|
1457
|
+
itemId,
|
|
1458
|
+
orderedItemModel
|
|
1459
|
+
);
|
|
1460
|
+
```
|
|
1461
|
+
|
|
1462
|
+
### Parameters
|
|
1463
|
+
|
|
1464
|
+
|Name | Type | Description | Notes|
|
|
1465
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1466
|
+
| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
|
|
1467
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1468
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1469
|
+
| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
### Return type
|
|
1473
|
+
|
|
1474
|
+
**OrderedItemModel**
|
|
1475
|
+
|
|
1476
|
+
### Authorization
|
|
1477
|
+
|
|
1478
|
+
No authorization required
|
|
1479
|
+
|
|
1480
|
+
### HTTP request headers
|
|
1481
|
+
|
|
1482
|
+
- **Content-Type**: application/json
|
|
1483
|
+
- **Accept**: application/json
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
### HTTP response details
|
|
1487
|
+
| Status code | Description | Response headers |
|
|
1488
|
+
|-------------|-------------|------------------|
|
|
1489
|
+
|**200** | Ordered Item | - |
|
|
1490
|
+
|**400** | Bad Request | - |
|
|
1491
|
+
|**401** | Unauthorised | - |
|
|
1492
|
+
|**403** | Access Denied | - |
|
|
1493
|
+
|
|
1494
|
+
[[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)
|
|
1495
|
+
|
|
1325
1496
|
# **putUpdateOrder**
|
|
1326
1497
|
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
1327
1498
|
|
|
@@ -1383,6 +1554,63 @@ No authorization required
|
|
|
1383
1554
|
|
|
1384
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)
|
|
1385
1556
|
|
|
1557
|
+
# **putUpdatePaymentStatus**
|
|
1558
|
+
> OrderDetailsDTO putUpdatePaymentStatus()
|
|
1559
|
+
|
|
1560
|
+
Change Payment Status (Admin)
|
|
1561
|
+
|
|
1562
|
+
### Example
|
|
1563
|
+
|
|
1564
|
+
```typescript
|
|
1565
|
+
import {
|
|
1566
|
+
OrdersApi,
|
|
1567
|
+
Configuration
|
|
1568
|
+
} from 'yellowgrid-api-ts';
|
|
1569
|
+
|
|
1570
|
+
const configuration = new Configuration();
|
|
1571
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1572
|
+
|
|
1573
|
+
let id: number; //Order ID (default to undefined)
|
|
1574
|
+
let paid: boolean; //Paid (default to undefined)
|
|
1575
|
+
|
|
1576
|
+
const { status, data } = await apiInstance.putUpdatePaymentStatus(
|
|
1577
|
+
id,
|
|
1578
|
+
paid
|
|
1579
|
+
);
|
|
1580
|
+
```
|
|
1581
|
+
|
|
1582
|
+
### Parameters
|
|
1583
|
+
|
|
1584
|
+
|Name | Type | Description | Notes|
|
|
1585
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1586
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1587
|
+
| **paid** | [**boolean**] | Paid | defaults to undefined|
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
### Return type
|
|
1591
|
+
|
|
1592
|
+
**OrderDetailsDTO**
|
|
1593
|
+
|
|
1594
|
+
### Authorization
|
|
1595
|
+
|
|
1596
|
+
No authorization required
|
|
1597
|
+
|
|
1598
|
+
### HTTP request headers
|
|
1599
|
+
|
|
1600
|
+
- **Content-Type**: Not defined
|
|
1601
|
+
- **Accept**: application/json
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
### HTTP response details
|
|
1605
|
+
| Status code | Description | Response headers |
|
|
1606
|
+
|-------------|-------------|------------------|
|
|
1607
|
+
|**200** | Order Details | - |
|
|
1608
|
+
|**400** | Bad Request | - |
|
|
1609
|
+
|**401** | Unauthorised | - |
|
|
1610
|
+
|**403** | Access Denied | - |
|
|
1611
|
+
|
|
1612
|
+
[[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)
|
|
1613
|
+
|
|
1386
1614
|
# **putUpdateShipment**
|
|
1387
1615
|
> ShipmentDTO putUpdateShipment()
|
|
1388
1616
|
|
|
@@ -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)
|