yellowgrid-api-ts 3.0.79 → 3.0.80-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 (55) hide show
  1. package/.openapi-generator/FILES +209 -189
  2. package/README.md +34 -7
  3. package/api.ts +1819 -276
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +1379 -170
  8. package/dist/api.js +1013 -254
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/index.d.ts +1 -1
  16. package/dist/index.js +1 -1
  17. package/docs/AbstractOrderRequestDTO.md +33 -0
  18. package/docs/AccountDetailedSummaryDTO.md +35 -0
  19. package/docs/AccountsApi.md +103 -0
  20. package/docs/AdminItemRequestDTO.md +37 -0
  21. package/docs/AdminOrderRequestDTO.md +41 -0
  22. package/docs/AdminUserModel.md +31 -0
  23. package/docs/BasicItemDTO.md +23 -0
  24. package/docs/BasicProductDTO.md +23 -0
  25. package/docs/Class3CXApi.md +0 -55
  26. package/docs/Class3CXInstallationWizardApi.md +13 -13
  27. package/docs/ClientDetailsModel.md +0 -2
  28. package/docs/CourierPriceEntity.md +39 -0
  29. package/docs/CustomerItemRequestDTO.md +33 -0
  30. package/docs/CustomerOrderRequestDTO.md +33 -0
  31. package/docs/ItemDTO.md +10 -4
  32. package/docs/LinkedOrderEntity.md +23 -0
  33. package/docs/NavigationItemModel.md +27 -0
  34. package/docs/OrderSummaryDTO.md +8 -0
  35. package/docs/OrderTotalModel.md +2 -0
  36. package/docs/OrdersApi.md +301 -4
  37. package/docs/ProductSearchResultsModel.md +1 -1
  38. package/docs/{ProductSummaryModel.md → ProductSummaryDTO.md} +5 -3
  39. package/docs/ProductsApi.md +97 -36
  40. package/docs/ProvisioningApi.md +4 -4
  41. package/docs/{ProvisioningEntity.md → ProvisioningModel.md} +3 -3
  42. package/docs/ShipmentEntity.md +2 -2
  43. package/docs/ShippingApi.md +63 -0
  44. package/docs/ShippingConsignmentModel.md +26 -0
  45. package/docs/ShippingInformationDTO.md +25 -0
  46. package/docs/ShippingServiceDTO.md +23 -0
  47. package/docs/ShippingServiceModel.md +31 -0
  48. package/docs/{GetGetPasswordHash200Response.md → ShippingServicesModel.md} +5 -5
  49. package/docs/StockManagementApi.md +2 -2
  50. package/docs/SubNavigationItemModel.md +25 -0
  51. package/docs/TcxSbcDTO.md +31 -0
  52. package/docs/TcxSbcModel.md +51 -0
  53. package/docs/TcxWizardModel.md +1 -1
  54. package/index.ts +1 -1
  55. package/package.json +1 -1
@@ -5,11 +5,12 @@ All URIs are relative to *http://api.yellowgrid.local*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetAttributeSets**](#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets|
8
- |[**getGetCustomerPriceLists**](#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists|
9
8
  |[**getGetLegacyStockList**](#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing|
10
- |[**getGetProducts**](#getgetproducts) | **GET** /products/search | Get Products|
9
+ |[**getGetProduct**](#getgetproduct) | **GET** /products/{sku} | Get Product|
10
+ |[**getGetProducts**](#getgetproducts) | **GET** /products | Get Products|
11
11
  |[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
12
12
  |[**getGetTcxTemplates**](#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates|
13
+ |[**getSearchProducts**](#getsearchproducts) | **GET** /products/search | Search Products|
13
14
 
14
15
  # **getGetAttributeSets**
15
16
  > Array<AttributeSetEnum> getGetAttributeSets()
@@ -58,10 +59,10 @@ No authorization required
58
59
 
59
60
  [[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)
60
61
 
61
- # **getGetCustomerPriceLists**
62
- > Array<CustomerPriceListEnum> getGetCustomerPriceLists()
62
+ # **getGetLegacyStockList**
63
+ > string getGetLegacyStockList()
63
64
 
64
- Get Customer Price Lists
65
+ Get Current Stock & Pricing
65
66
 
66
67
  ### Example
67
68
 
@@ -74,16 +75,23 @@ import {
74
75
  const configuration = new Configuration();
75
76
  const apiInstance = new ProductsApi(configuration);
76
77
 
77
- const { status, data } = await apiInstance.getGetCustomerPriceLists();
78
+ let format: 'XML' | 'CSV'; //File Format (default to undefined)
79
+
80
+ const { status, data } = await apiInstance.getGetLegacyStockList(
81
+ format
82
+ );
78
83
  ```
79
84
 
80
85
  ### Parameters
81
- This endpoint does not have any parameters.
86
+
87
+ |Name | Type | Description | Notes|
88
+ |------------- | ------------- | ------------- | -------------|
89
+ | **format** | [**&#39;XML&#39; | &#39;CSV&#39;**]**Array<&#39;XML&#39; &#124; &#39;CSV&#39;>** | File Format | defaults to undefined|
82
90
 
83
91
 
84
92
  ### Return type
85
93
 
86
- **Array<CustomerPriceListEnum>**
94
+ **string**
87
95
 
88
96
  ### Authorization
89
97
 
@@ -92,23 +100,23 @@ No authorization required
92
100
  ### HTTP request headers
93
101
 
94
102
  - **Content-Type**: Not defined
95
- - **Accept**: application/json
103
+ - **Accept**: text/csv, application/xml
96
104
 
97
105
 
98
106
  ### HTTP response details
99
107
  | Status code | Description | Response headers |
100
108
  |-------------|-------------|------------------|
101
- |**200** | Price Lists | - |
109
+ |**200** | Products | - |
102
110
  |**400** | Bad Request | - |
103
111
  |**401** | Unauthorised | - |
104
112
  |**403** | Access Denied | - |
105
113
 
106
114
  [[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)
107
115
 
108
- # **getGetLegacyStockList**
109
- > string getGetLegacyStockList()
116
+ # **getGetProduct**
117
+ > ProductSummaryDTO getGetProduct()
110
118
 
111
- Get Current Stock & Pricing
119
+ Get Product
112
120
 
113
121
  ### Example
114
122
 
@@ -121,10 +129,14 @@ import {
121
129
  const configuration = new Configuration();
122
130
  const apiInstance = new ProductsApi(configuration);
123
131
 
124
- let format: 'XML' | 'CSV'; //File Format (default to undefined)
132
+ let sku: string; //Product SKU (default to undefined)
133
+ let quantity: number; //Quantity (optional) (default to undefined)
134
+ let licenceKey: string; //3CX Licence Key (optional) (default to undefined)
125
135
 
126
- const { status, data } = await apiInstance.getGetLegacyStockList(
127
- format
136
+ const { status, data } = await apiInstance.getGetProduct(
137
+ sku,
138
+ quantity,
139
+ licenceKey
128
140
  );
129
141
  ```
130
142
 
@@ -132,12 +144,14 @@ const { status, data } = await apiInstance.getGetLegacyStockList(
132
144
 
133
145
  |Name | Type | Description | Notes|
134
146
  |------------- | ------------- | ------------- | -------------|
135
- | **format** | [**&#39;XML&#39; | &#39;CSV&#39;**]**Array<&#39;XML&#39; &#124; &#39;CSV&#39;>** | File Format | defaults to undefined|
147
+ | **sku** | [**string**] | Product SKU | defaults to undefined|
148
+ | **quantity** | [**number**] | Quantity | (optional) defaults to undefined|
149
+ | **licenceKey** | [**string**] | 3CX Licence Key | (optional) defaults to undefined|
136
150
 
137
151
 
138
152
  ### Return type
139
153
 
140
- **string**
154
+ **ProductSummaryDTO**
141
155
 
142
156
  ### Authorization
143
157
 
@@ -146,7 +160,7 @@ No authorization required
146
160
  ### HTTP request headers
147
161
 
148
162
  - **Content-Type**: Not defined
149
- - **Accept**: text/csv, application/xml
163
+ - **Accept**: application/json
150
164
 
151
165
 
152
166
  ### HTTP response details
@@ -160,7 +174,7 @@ No authorization required
160
174
  [[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)
161
175
 
162
176
  # **getGetProducts**
163
- > ProductSearchResultsModel getGetProducts()
177
+ > Array<BasicProductDTO> getGetProducts()
164
178
 
165
179
  Get Products
166
180
 
@@ -175,29 +189,16 @@ import {
175
189
  const configuration = new Configuration();
176
190
  const apiInstance = new ProductsApi(configuration);
177
191
 
178
- let pageSize: number; //Number Of Results (optional) (default to 20)
179
- let page: number; //Page Number (optional) (default to 1)
180
- let search: string; //Search (optional) (default to undefined)
181
-
182
- const { status, data } = await apiInstance.getGetProducts(
183
- pageSize,
184
- page,
185
- search
186
- );
192
+ const { status, data } = await apiInstance.getGetProducts();
187
193
  ```
188
194
 
189
195
  ### Parameters
190
-
191
- |Name | Type | Description | Notes|
192
- |------------- | ------------- | ------------- | -------------|
193
- | **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
194
- | **page** | [**number**] | Page Number | (optional) defaults to 1|
195
- | **search** | [**string**] | Search | (optional) defaults to undefined|
196
+ This endpoint does not have any parameters.
196
197
 
197
198
 
198
199
  ### Return type
199
200
 
200
- **ProductSearchResultsModel**
201
+ **Array<BasicProductDTO>**
201
202
 
202
203
  ### Authorization
203
204
 
@@ -313,3 +314,63 @@ No authorization required
313
314
 
314
315
  [[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)
315
316
 
317
+ # **getSearchProducts**
318
+ > ProductSearchResultsModel getSearchProducts()
319
+
320
+ Search Products
321
+
322
+ ### Example
323
+
324
+ ```typescript
325
+ import {
326
+ ProductsApi,
327
+ Configuration
328
+ } from 'yellowgrid-api-ts';
329
+
330
+ const configuration = new Configuration();
331
+ const apiInstance = new ProductsApi(configuration);
332
+
333
+ let pageSize: number; //Number Of Results (optional) (default to 20)
334
+ let page: number; //Page Number (optional) (default to 1)
335
+ let search: string; //Search (optional) (default to undefined)
336
+
337
+ const { status, data } = await apiInstance.getSearchProducts(
338
+ pageSize,
339
+ page,
340
+ search
341
+ );
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ |Name | Type | Description | Notes|
347
+ |------------- | ------------- | ------------- | -------------|
348
+ | **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
349
+ | **page** | [**number**] | Page Number | (optional) defaults to 1|
350
+ | **search** | [**string**] | Search | (optional) defaults to undefined|
351
+
352
+
353
+ ### Return type
354
+
355
+ **ProductSearchResultsModel**
356
+
357
+ ### Authorization
358
+
359
+ No authorization required
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: Not defined
364
+ - **Accept**: application/json
365
+
366
+
367
+ ### HTTP response details
368
+ | Status code | Description | Response headers |
369
+ |-------------|-------------|------------------|
370
+ |**200** | Products | - |
371
+ |**400** | Bad Request | - |
372
+ |**401** | Unauthorised | - |
373
+ |**403** | Access Denied | - |
374
+
375
+ [[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)
376
+
@@ -235,7 +235,7 @@ No authorization required
235
235
  [[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)
236
236
 
237
237
  # **getGetGroups**
238
- > Array<ProvisioningEntity> getGetGroups()
238
+ > Array<ProvisioningModel> getGetGroups()
239
239
 
240
240
  Get provisioning groups
241
241
 
@@ -266,7 +266,7 @@ const { status, data } = await apiInstance.getGetGroups(
266
266
 
267
267
  ### Return type
268
268
 
269
- **Array<ProvisioningEntity>**
269
+ **Array<ProvisioningModel>**
270
270
 
271
271
  ### Authorization
272
272
 
@@ -289,7 +289,7 @@ No authorization required
289
289
  [[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)
290
290
 
291
291
  # **postAddFanvilGroup**
292
- > ProvisioningEntity postAddFanvilGroup()
292
+ > ProvisioningModel postAddFanvilGroup()
293
293
 
294
294
  Create a Fanvil provisioning group
295
295
 
@@ -321,7 +321,7 @@ const { status, data } = await apiInstance.postAddFanvilGroup(
321
321
 
322
322
  ### Return type
323
323
 
324
- **ProvisioningEntity**
324
+ **ProvisioningModel**
325
325
 
326
326
  ### Authorization
327
327
 
@@ -1,4 +1,4 @@
1
- # ProvisioningEntity
1
+ # ProvisioningModel
2
2
 
3
3
  Provisioning Group
4
4
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
15
15
  ## Example
16
16
 
17
17
  ```typescript
18
- import { ProvisioningEntity } from 'yellowgrid-api-ts';
18
+ import { ProvisioningModel } from 'yellowgrid-api-ts';
19
19
 
20
- const instance: ProvisioningEntity = {
20
+ const instance: ProvisioningModel = {
21
21
  groupName,
22
22
  provisioningUrl,
23
23
  auth,
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  **courierTracking** | **string** | courierTracking | [optional] [default to undefined]
16
16
  **courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
17
17
  **scannedData** | **string** | mac | [optional] [default to undefined]
18
- **date** | **string** | date | [optional] [default to undefined]
18
+ **dateShipped** | **string** | date | [optional] [default to undefined]
19
19
  **requestDate** | **string** | requestDate | [optional] [default to undefined]
20
20
  **provId** | **number** | provId | [optional] [default to undefined]
21
21
 
@@ -34,7 +34,7 @@ const instance: ShipmentEntity = {
34
34
  courierTracking,
35
35
  courierBoxes,
36
36
  scannedData,
37
- date,
37
+ dateShipped,
38
38
  requestDate,
39
39
  provId,
40
40
  };
@@ -0,0 +1,63 @@
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
+
@@ -0,0 +1,26 @@
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&lt;string&gt;** | 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)
@@ -0,0 +1,25 @@
1
+ # ShippingInformationDTO
2
+
3
+ Shipping Information
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **items** | [**Array&lt;BasicItemDTO&gt;**](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)
@@ -0,0 +1,23 @@
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)
@@ -0,0 +1,31 @@
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)
@@ -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&lt;ShippingServiceModel&gt;**](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,25 @@
1
+ # SubNavigationItemModel
2
+
3
+ POPS Sub Navigation Item
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **title** | **string** | Title | [optional] [default to undefined]
10
+ **url** | **string** | URL | [optional] [default to undefined]
11
+ **icon** | **string** | Icon (Font Awesome) | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { SubNavigationItemModel } from 'yellowgrid-api-ts';
17
+
18
+ const instance: SubNavigationItemModel = {
19
+ title,
20
+ url,
21
+ icon,
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)
@@ -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)
@@ -0,0 +1,51 @@
1
+ # TcxSbcModel
2
+
3
+ 3CX Wizard SBC
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **sbcId** | **number** | SBC ID | [optional] [default to undefined]
11
+ **tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
12
+ **tcxKey** | **string** | 3CX SBC Auth Key | [optional] [default to undefined]
13
+ **label** | **string** | Label | [optional] [default to undefined]
14
+ **ipAddress** | **string** | IP Address | [optional] [default to undefined]
15
+ **netmask** | **string** | Subnet Mask | [optional] [default to undefined]
16
+ **defaultGateway** | **string** | Default Gateway | [optional] [default to undefined]
17
+ **dns1** | **string** | DNS 1 | [optional] [default to undefined]
18
+ **dns2** | **string** | DNS 2 | [optional] [default to undefined]
19
+ **address1** | **string** | Site Address Line 1 | [optional] [default to undefined]
20
+ **address2** | **string** | Site Address Line 2 | [optional] [default to undefined]
21
+ **city** | **string** | Site City | [optional] [default to undefined]
22
+ **postalCode** | **string** | Site Postal Code | [optional] [default to undefined]
23
+ **primaryContact** | **string** | Site Primary Contact | [optional] [default to undefined]
24
+ **technicalContact** | **string** | Site Technical Contact | [optional] [default to undefined]
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import { TcxSbcModel } from 'yellowgrid-api-ts';
30
+
31
+ const instance: TcxSbcModel = {
32
+ id,
33
+ sbcId,
34
+ tcxUrl,
35
+ tcxKey,
36
+ label,
37
+ ipAddress,
38
+ netmask,
39
+ defaultGateway,
40
+ dns1,
41
+ dns2,
42
+ address1,
43
+ address2,
44
+ city,
45
+ postalCode,
46
+ primaryContact,
47
+ technicalContact,
48
+ };
49
+ ```
50
+
51
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  **numbers** | [**Array&lt;TcxNumbersEntity&gt;**](TcxNumbersEntity.md) | | [optional] [default to undefined]
16
16
  **officeHours** | [**TcxOfficeHoursEntity**](TcxOfficeHoursEntity.md) | | [optional] [default to undefined]
17
17
  **phones** | [**Array&lt;TcxPhoneModel&gt;**](TcxPhoneModel.md) | | [optional] [default to undefined]
18
- **sbcs** | [**Array&lt;TcxSbcEntity&gt;**](TcxSbcEntity.md) | | [optional] [default to undefined]
18
+ **sbcs** | [**Array&lt;TcxSbcModel&gt;**](TcxSbcModel.md) | | [optional] [default to undefined]
19
19
  **sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) | | [optional] [default to undefined]
20
20
  **installationStatus** | **string** | | [optional] [default to undefined]
21
21
  **setup** | [**TcxSetupEntity**](TcxSetupEntity.md) | | [optional] [default to undefined]
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.0.79",
3
+ "version": "3.0.80-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {