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

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 (58) hide show
  1. package/.openapi-generator/FILES +198 -217
  2. package/README.md +7 -36
  3. package/api.ts +236 -1972
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/config.json +3 -3
  7. package/configuration.ts +1 -1
  8. package/dist/api.d.ts +160 -1479
  9. package/dist/api.js +197 -1140
  10. package/dist/base.d.ts +1 -1
  11. package/dist/base.js +1 -1
  12. package/dist/common.d.ts +1 -1
  13. package/dist/common.js +1 -1
  14. package/dist/configuration.d.ts +1 -1
  15. package/dist/configuration.js +1 -1
  16. package/dist/index.d.ts +1 -1
  17. package/dist/index.js +1 -1
  18. package/docs/AccountsApi.md +0 -103
  19. package/docs/AddressModel.md +0 -2
  20. package/docs/Class3CXApi.md +55 -0
  21. package/docs/ClientDetailsModel.md +2 -0
  22. package/docs/{ShippingServicesModel.md → GetGetPasswordHash200Response.md} +5 -5
  23. package/docs/ItemDTO.md +4 -12
  24. package/docs/ItemEntity.md +2 -4
  25. package/docs/OrderSummaryDTO.md +0 -8
  26. package/docs/OrderTotalModel.md +0 -2
  27. package/docs/OrdersApi.md +4 -356
  28. package/docs/ProductSearchResultsModel.md +1 -1
  29. package/docs/{ProductSummaryDTO.md → ProductSummaryModel.md} +3 -5
  30. package/docs/ProductsApi.md +43 -164
  31. package/docs/ProvisioningApi.md +4 -4
  32. package/docs/{ProvisioningModel.md → ProvisioningEntity.md} +3 -3
  33. package/docs/ShipmentEntity.md +2 -2
  34. package/docs/StockManagementApi.md +2 -2
  35. package/docs/TcxSbcModel.md +1 -1
  36. package/index.ts +1 -1
  37. package/package.json +1 -1
  38. package/docs/AbstractOrderRequestDTO.md +0 -33
  39. package/docs/AccountDetailedSummaryDTO.md +0 -39
  40. package/docs/AdminItemRequestDTO.md +0 -43
  41. package/docs/AdminOrderRequestDTO.md +0 -45
  42. package/docs/AdminUserModel.md +0 -29
  43. package/docs/BasicItemDTO.md +0 -23
  44. package/docs/BasicProductDTO.md +0 -23
  45. package/docs/CourierPriceEntity.md +0 -39
  46. package/docs/CustomerItemRequestDTO.md +0 -37
  47. package/docs/CustomerOrderRequestDTO.md +0 -33
  48. package/docs/DetailedItemRequestDTO.md +0 -43
  49. package/docs/DetailedOrderRequestDTO.md +0 -33
  50. package/docs/ItemDiscountEntity.md +0 -33
  51. package/docs/LinkedOrderEntity.md +0 -23
  52. package/docs/PostGetProductForCustomerRequest.md +0 -24
  53. package/docs/ShippingApi.md +0 -63
  54. package/docs/ShippingConsignmentModel.md +0 -26
  55. package/docs/ShippingInformationDTO.md +0 -25
  56. package/docs/ShippingServiceDTO.md +0 -23
  57. package/docs/ShippingServiceModel.md +0 -31
  58. package/docs/TcxSbcDTO.md +0 -31
package/docs/BasicItemDTO.md DELETED
@@ -1,23 +0,0 @@
1
- # BasicItemDTO
2
-
3
- Basic Order Item
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **quantity** | **number** | Quantity | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { BasicItemDTO } from 'yellowgrid-api-ts';
16
-
17
- const instance: BasicItemDTO = {
18
- sku,
19
- quantity,
20
- };
21
- ```
22
-
23
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/BasicProductDTO.md DELETED
@@ -1,23 +0,0 @@
1
- # BasicProductDTO
2
-
3
- Basic Product
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **title** | **string** | Title | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { BasicProductDTO } from 'yellowgrid-api-ts';
16
-
17
- const instance: BasicProductDTO = {
18
- sku,
19
- title,
20
- };
21
- ```
22
-
23
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/CourierPriceEntity.md DELETED
@@ -1,39 +0,0 @@
1
- # CourierPriceEntity
2
-
3
- CourierPricesEntity
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **courier** | **string** | courier | [optional] [default to undefined]
11
- **destinationIso** | **string** | destinationIso | [optional] [default to undefined]
12
- **serviceDescription** | **string** | serviceDescription | [optional] [default to undefined]
13
- **flatRate** | **number** | flatRate | [optional] [default to undefined]
14
- **initialBox** | **number** | initialBox | [optional] [default to undefined]
15
- **initialKg** | **number** | initialKg | [optional] [default to undefined]
16
- **perBox** | **number** | perBox | [optional] [default to undefined]
17
- **perKg** | **number** | perKg | [optional] [default to undefined]
18
- **maxKg** | **number** | maxKg | [optional] [default to undefined]
19
-
20
- ## Example
21
-
22
- ```typescript
23
- import { CourierPriceEntity } from 'yellowgrid-api-ts';
24
-
25
- const instance: CourierPriceEntity = {
26
- id,
27
- courier,
28
- destinationIso,
29
- serviceDescription,
30
- flatRate,
31
- initialBox,
32
- initialKg,
33
- perBox,
34
- perKg,
35
- maxKg,
36
- };
37
- ```
38
-
39
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/CustomerItemRequestDTO.md DELETED
@@ -1,37 +0,0 @@
1
- # CustomerItemRequestDTO
2
-
3
- Order Item Request
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **quantity** | **number** | Quantity | [optional] [default to undefined]
11
- **id** | **number** | ID | [optional] [default to undefined]
12
- **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
13
- **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
14
- **processDate** | **string** | Date Time | [optional] [default to undefined]
15
- **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
16
- **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
17
- **readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { CustomerItemRequestDTO } from 'yellowgrid-api-ts';
23
-
24
- const instance: CustomerItemRequestDTO = {
25
- sku,
26
- quantity,
27
- id,
28
- licenceKey,
29
- hosting,
30
- processDate,
31
- tcxSalesCode,
32
- sbcs,
33
- readOnly,
34
- };
35
- ```
36
-
37
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/CustomerOrderRequestDTO.md DELETED
@@ -1,33 +0,0 @@
1
- # CustomerOrderRequestDTO
2
-
3
- Order Request
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
10
- **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
11
- **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
- **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
- **quote** | **boolean** | Quote | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { CustomerOrderRequestDTO } from 'yellowgrid-api-ts';
21
-
22
- const instance: CustomerOrderRequestDTO = {
23
- orderReference,
24
- items,
25
- shippingService,
26
- provisioningUrl,
27
- shippingAddress,
28
- partShip,
29
- quote,
30
- };
31
- ```
32
-
33
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/DetailedItemRequestDTO.md DELETED
@@ -1,43 +0,0 @@
1
- # DetailedItemRequestDTO
2
-
3
- Detailed Order Item Request
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **quantity** | **number** | Quantity | [optional] [default to undefined]
11
- **id** | **number** | ID | [optional] [default to undefined]
12
- **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
13
- **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
14
- **processDate** | **string** | Date Time | [optional] [default to undefined]
15
- **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
16
- **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
17
- **readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
18
- **title** | **string** | Title | [optional] [default to undefined]
19
- **itemPrice** | **number** | Price (£) | [optional] [default to undefined]
20
- **additionalDiscount** | **number** | Additional Discount | [optional] [default to undefined]
21
-
22
- ## Example
23
-
24
- ```typescript
25
- import { DetailedItemRequestDTO } from 'yellowgrid-api-ts';
26
-
27
- const instance: DetailedItemRequestDTO = {
28
- sku,
29
- quantity,
30
- id,
31
- licenceKey,
32
- hosting,
33
- processDate,
34
- tcxSalesCode,
35
- sbcs,
36
- readOnly,
37
- title,
38
- itemPrice,
39
- additionalDiscount,
40
- };
41
- ```
42
-
43
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/DetailedOrderRequestDTO.md DELETED
@@ -1,33 +0,0 @@
1
- # DetailedOrderRequestDTO
2
-
3
- Detailed Order Request
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
10
- **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
11
- **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
- **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
- **quote** | **boolean** | Quote | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { DetailedOrderRequestDTO } from 'yellowgrid-api-ts';
21
-
22
- const instance: DetailedOrderRequestDTO = {
23
- orderReference,
24
- items,
25
- shippingService,
26
- provisioningUrl,
27
- shippingAddress,
28
- partShip,
29
- quote,
30
- };
31
- ```
32
-
33
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/ItemDiscountEntity.md DELETED
@@ -1,33 +0,0 @@
1
- # ItemDiscountEntity
2
-
3
- ItemDiscountsEntity
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **itemId** | **number** | itemId | [optional] [default to undefined]
11
- **priceList** | **string** | priceList | [optional] [default to undefined]
12
- **discount** | **number** | discount | [optional] [default to undefined]
13
- **type** | **string** | type | [optional] [default to undefined]
14
- **description** | **string** | description | [optional] [default to undefined]
15
- **priority** | **number** | priority | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { ItemDiscountEntity } from 'yellowgrid-api-ts';
21
-
22
- const instance: ItemDiscountEntity = {
23
- id,
24
- itemId,
25
- priceList,
26
- discount,
27
- type,
28
- description,
29
- priority,
30
- };
31
- ```
32
-
33
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/LinkedOrderEntity.md DELETED
@@ -1,23 +0,0 @@
1
- # LinkedOrderEntity
2
-
3
- LinkedOrdersEntity
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **orderId** | **number** | orderId | [optional] [default to undefined]
10
- **linkedOrderId** | **number** | linkedOrderId | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { LinkedOrderEntity } from 'yellowgrid-api-ts';
16
-
17
- const instance: LinkedOrderEntity = {
18
- orderId,
19
- linkedOrderId,
20
- };
21
- ```
22
-
23
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/PostGetProductForCustomerRequest.md DELETED
@@ -1,24 +0,0 @@
1
- # PostGetProductForCustomerRequest
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **quantity** | **number** | Quantity | [optional] [default to undefined]
9
- **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
10
- **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { PostGetProductForCustomerRequest } from 'yellowgrid-api-ts';
16
-
17
- const instance: PostGetProductForCustomerRequest = {
18
- quantity,
19
- licenceKey,
20
- hosting,
21
- };
22
- ```
23
-
24
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/ShippingApi.md DELETED
@@ -1,63 +0,0 @@
1
- # ShippingApi
2
-
3
- All URIs are relative to *http://api.yellowgrid.local*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
8
-
9
- # **postGetShippingServices**
10
- > ShippingServicesModel postGetShippingServices()
11
-
12
- Get Shipping Services
13
-
14
- ### Example
15
-
16
- ```typescript
17
- import {
18
- ShippingApi,
19
- Configuration,
20
- ShippingInformationDTO
21
- } from 'yellowgrid-api-ts';
22
-
23
- const configuration = new Configuration();
24
- const apiInstance = new ShippingApi(configuration);
25
-
26
- let shippingInformationDTO: ShippingInformationDTO; //Shipping Information (optional)
27
-
28
- const { status, data } = await apiInstance.postGetShippingServices(
29
- shippingInformationDTO
30
- );
31
- ```
32
-
33
- ### Parameters
34
-
35
- |Name | Type | Description | Notes|
36
- |------------- | ------------- | ------------- | -------------|
37
- | **shippingInformationDTO** | **ShippingInformationDTO**| Shipping Information | |
38
-
39
-
40
- ### Return type
41
-
42
- **ShippingServicesModel**
43
-
44
- ### Authorization
45
-
46
- No authorization required
47
-
48
- ### HTTP request headers
49
-
50
- - **Content-Type**: application/json
51
- - **Accept**: application/json
52
-
53
-
54
- ### HTTP response details
55
- | Status code | Description | Response headers |
56
- |-------------|-------------|------------------|
57
- |**200** | Shipping Services | - |
58
- |**400** | Bad Request | - |
59
- |**401** | Unauthorised | - |
60
- |**403** | Access Denied | - |
61
-
62
- [[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)
63
-
package/docs/ShippingConsignmentModel.md DELETED
@@ -1,26 +0,0 @@
1
- # ShippingConsignmentModel
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [optional] [default to undefined]
9
- **id** | **string** | ID/Number | [optional] [default to undefined]
10
- **trackingNumber** | **string** | Tracking Number | [optional] [default to undefined]
11
- **parcelIds** | **Array<string>** | Parcels | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { ShippingConsignmentModel } from 'yellowgrid-api-ts';
17
-
18
- const instance: ShippingConsignmentModel = {
19
- service,
20
- id,
21
- trackingNumber,
22
- parcelIds,
23
- };
24
- ```
25
-
26
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/ShippingInformationDTO.md DELETED
@@ -1,25 +0,0 @@
1
- # ShippingInformationDTO
2
-
3
- Shipping Information
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [optional] [default to undefined]
10
- **postalCode** | **string** | Destination Post Code | [optional] [default to undefined]
11
- **iso** | **string** | Destination ISO | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { ShippingInformationDTO } from 'yellowgrid-api-ts';
17
-
18
- const instance: ShippingInformationDTO = {
19
- items,
20
- postalCode,
21
- iso,
22
- };
23
- ```
24
-
25
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/ShippingServiceDTO.md DELETED
@@ -1,23 +0,0 @@
1
- # ShippingServiceDTO
2
-
3
- Shipping Service
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **courier** | **string** | Courier | [optional] [default to undefined]
10
- **serviceName** | **string** | Service Name | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { ShippingServiceDTO } from 'yellowgrid-api-ts';
16
-
17
- const instance: ShippingServiceDTO = {
18
- courier,
19
- serviceName,
20
- };
21
- ```
22
-
23
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/ShippingServiceModel.md DELETED
@@ -1,31 +0,0 @@
1
- # ShippingServiceModel
2
-
3
- Shipping Service
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **courier** | **string** | Courier | [optional] [default to undefined]
10
- **code** | **string** | Code | [optional] [default to undefined]
11
- **name** | **string** | Name | [optional] [default to undefined]
12
- **description** | **string** | Description | [optional] [default to undefined]
13
- **label** | **string** | Label | [optional] [default to undefined]
14
- **price** | **number** | Price | [optional] [default to undefined]
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import { ShippingServiceModel } from 'yellowgrid-api-ts';
20
-
21
- const instance: ShippingServiceModel = {
22
- courier,
23
- code,
24
- name,
25
- description,
26
- label,
27
- price,
28
- };
29
- ```
30
-
31
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/TcxSbcDTO.md DELETED
@@ -1,31 +0,0 @@
1
- # TcxSbcDTO
2
-
3
- SBC Data
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **ipAddress** | **string** | LAN IP Address | [optional] [default to undefined]
10
- **defaultGateway** | **string** | LAN Default Gateway | [optional] [default to undefined]
11
- **netmask** | **string** | LAN Subnet Mask | [optional] [default to undefined]
12
- **dns** | **string** | DNS | [optional] [default to undefined]
13
- **tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
14
- **tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import { TcxSbcDTO } from 'yellowgrid-api-ts';
20
-
21
- const instance: TcxSbcDTO = {
22
- ipAddress,
23
- defaultGateway,
24
- netmask,
25
- dns,
26
- tcxUrl,
27
- tcxKey,
28
- };
29
- ```
30
-
31
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)