yellowgrid-api-ts 3.0.83 → 3.0.85-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.
- package/.openapi-generator/FILES +209 -190
- package/README.md +35 -7
- package/api.ts +1825 -285
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/config.json +3 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1318 -156
- package/dist/api.js +1059 -207
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AbstractOrderRequestDTO.md +33 -0
- package/docs/AccountDetailedSummaryDTO.md +35 -0
- package/docs/AccountsApi.md +103 -0
- package/docs/AdminItemRequestDTO.md +37 -0
- package/docs/AdminOrderRequestDTO.md +41 -0
- package/docs/AdminUserModel.md +31 -0
- package/docs/BasicItemDTO.md +23 -0
- package/docs/BasicProductDTO.md +23 -0
- package/docs/Class3CXApi.md +0 -55
- package/docs/ClientDetailsModel.md +0 -2
- package/docs/CourierPriceEntity.md +39 -0
- package/docs/CustomerItemRequestDTO.md +33 -0
- package/docs/CustomerOrderRequestDTO.md +33 -0
- package/docs/ItemDTO.md +10 -4
- package/docs/LinkedOrderEntity.md +23 -0
- package/docs/NavigationItemModel.md +27 -0
- package/docs/OrderSummaryDTO.md +8 -0
- package/docs/OrderTotalModel.md +2 -0
- package/docs/OrdersApi.md +301 -4
- package/docs/PostGetProductForCustomerRequest.md +24 -0
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/{ProductSummaryModel.md → ProductSummaryDTO.md} +5 -3
- package/docs/ProductsApi.md +164 -43
- package/docs/ProvisioningApi.md +4 -4
- package/docs/{ProvisioningEntity.md → ProvisioningModel.md} +3 -3
- package/docs/ShipmentEntity.md +2 -2
- package/docs/ShippingApi.md +63 -0
- package/docs/ShippingConsignmentModel.md +26 -0
- package/docs/ShippingInformationDTO.md +25 -0
- package/docs/ShippingServiceDTO.md +23 -0
- package/docs/ShippingServiceModel.md +31 -0
- package/docs/{GetGetPasswordHash200Response.md → ShippingServicesModel.md} +5 -5
- package/docs/StockManagementApi.md +2 -2
- package/docs/SubNavigationItemModel.md +25 -0
- package/docs/TcxBackupModel.md +0 -2
- package/docs/TcxSbcDTO.md +31 -0
- package/docs/TcxSbcModel.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/TcxBackupModel.md
CHANGED
|
@@ -24,7 +24,6 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**licence** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
25
25
|
**extLength** | **number** | Extension Length | [optional] [default to undefined]
|
|
26
26
|
**phone** | **string** | 3CX Licence Phone | [optional] [default to undefined]
|
|
27
|
-
**companyName** | **string** | Company Name | [optional] [default to undefined]
|
|
28
27
|
|
|
29
28
|
## Example
|
|
30
29
|
|
|
@@ -50,7 +49,6 @@ const instance: TcxBackupModel = {
|
|
|
50
49
|
licence,
|
|
51
50
|
extLength,
|
|
52
51
|
phone,
|
|
53
|
-
companyName,
|
|
54
52
|
};
|
|
55
53
|
```
|
|
56
54
|
|
|
@@ -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)
|
package/docs/TcxSbcModel.md
CHANGED
package/index.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
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
|
*
|