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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/.openapi-generator/FILES +217 -198
  2. package/README.md +36 -7
  3. package/api.ts +1978 -242
  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 +1478 -159
  9. package/dist/api.js +1139 -196
  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/AbstractOrderRequestDTO.md +33 -0
  19. package/docs/AccountDetailedSummaryDTO.md +39 -0
  20. package/docs/AccountsApi.md +103 -0
  21. package/docs/AddressModel.md +2 -0
  22. package/docs/AdminItemRequestDTO.md +43 -0
  23. package/docs/AdminOrderRequestDTO.md +45 -0
  24. package/docs/AdminUserModel.md +29 -0
  25. package/docs/BasicItemDTO.md +23 -0
  26. package/docs/BasicProductDTO.md +23 -0
  27. package/docs/Class3CXApi.md +0 -55
  28. package/docs/ClientDetailsModel.md +0 -2
  29. package/docs/CourierPriceEntity.md +39 -0
  30. package/docs/CustomerItemRequestDTO.md +37 -0
  31. package/docs/CustomerOrderRequestDTO.md +33 -0
  32. package/docs/DetailedItemRequestDTO.md +43 -0
  33. package/docs/DetailedOrderRequestDTO.md +33 -0
  34. package/docs/ItemDTO.md +12 -4
  35. package/docs/ItemDiscountEntity.md +33 -0
  36. package/docs/ItemEntity.md +4 -2
  37. package/docs/LinkedOrderEntity.md +23 -0
  38. package/docs/OrderSummaryDTO.md +8 -0
  39. package/docs/OrderTotalModel.md +2 -0
  40. package/docs/OrdersApi.md +356 -4
  41. package/docs/PostGetProductForCustomerRequest.md +24 -0
  42. package/docs/ProductSearchResultsModel.md +1 -1
  43. package/docs/{ProductSummaryModel.md → ProductSummaryDTO.md} +5 -3
  44. package/docs/ProductsApi.md +164 -43
  45. package/docs/ProvisioningApi.md +4 -4
  46. package/docs/{ProvisioningEntity.md → ProvisioningModel.md} +3 -3
  47. package/docs/ShipmentEntity.md +2 -2
  48. package/docs/ShippingApi.md +63 -0
  49. package/docs/ShippingConsignmentModel.md +26 -0
  50. package/docs/ShippingInformationDTO.md +25 -0
  51. package/docs/ShippingServiceDTO.md +23 -0
  52. package/docs/ShippingServiceModel.md +31 -0
  53. package/docs/{GetGetPasswordHash200Response.md → ShippingServicesModel.md} +5 -5
  54. package/docs/StockManagementApi.md +2 -2
  55. package/docs/TcxSbcDTO.md +31 -0
  56. package/docs/TcxSbcModel.md +1 -1
  57. package/index.ts +1 -1
  58. package/package.json +1 -1
@@ -1,19 +1,19 @@
1
- # GetGetPasswordHash200Response
1
+ # ShippingServicesModel
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **hash** | **string** | | [optional] [default to undefined]
8
+ **services** | [**Array<ShippingServiceModel>**](ShippingServiceModel.md) | Services | [optional] [default to undefined]
9
9
 
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import { GetGetPasswordHash200Response } from 'yellowgrid-api-ts';
13
+ import { ShippingServicesModel } from 'yellowgrid-api-ts';
14
14
 
15
- const instance: GetGetPasswordHash200Response = {
16
- hash,
15
+ const instance: ShippingServicesModel = {
16
+ services,
17
17
  };
18
18
  ```
19
19
 
@@ -692,7 +692,7 @@ No authorization required
692
692
  [[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)
693
693
 
694
694
  # **getGetStockSupplierProducts**
695
- > Array<ProductSummaryModel> getGetStockSupplierProducts()
695
+ > Array<ProductSummaryDTO> getGetStockSupplierProducts()
696
696
 
697
697
  Get Stock Supplier\'s Products
698
698
 
@@ -723,7 +723,7 @@ const { status, data } = await apiInstance.getGetStockSupplierProducts(
723
723
 
724
724
  ### Return type
725
725
 
726
- **Array<ProductSummaryModel>**
726
+ **Array<ProductSummaryDTO>**
727
727
 
728
728
  ### Authorization
729
729
 
@@ -0,0 +1,31 @@
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)
@@ -1,6 +1,6 @@
1
1
  # TcxSbcModel
2
2
 
3
- 3CX SBC Model
3
+ 3CX Wizard SBC
4
4
 
5
5
  ## Properties
6
6
 
package/index.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Yellowgrid
5
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
5
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
6
6
  *
7
7
  * The version of the OpenAPI document: 0
8
8
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.1.12",
3
+ "version": "3.1.14-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {