yellowgrid-api-ts 3.2.176-dev.0 → 3.2.177-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.
@@ -0,0 +1,25 @@
1
+ # CreditStatusDTO
2
+
3
+ 3CX Credit Status
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **CurrencyCode** | **string** | Currency Code | [optional] [default to undefined]
10
+ **CreditLimit** | **number** | Credit Limit | [optional] [default to undefined]
11
+ **Credit** | **number** | Credit | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { CreditStatusDTO } from 'yellowgrid-api-ts';
17
+
18
+ const instance: CreditStatusDTO = {
19
+ CurrencyCode,
20
+ CreditLimit,
21
+ Credit,
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,20 @@
1
+ # GetCheckMacExists200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **found** | **boolean** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GetCheckMacExists200Response } from 'yellowgrid-api-ts';
14
+
15
+ const instance: GetCheckMacExists200Response = {
16
+ found,
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)
@@ -0,0 +1,23 @@
1
+ # MacAddressDTO
2
+
3
+ MAC Address DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **groupId** | **number** | Group ID | [optional] [default to undefined]
10
+ **macAddress** | **string** | MAC Address | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { MacAddressDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: MacAddressDTO = {
18
+ groupId,
19
+ macAddress,
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)
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
18
18
  **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
19
19
  **aligned** | **boolean** | Aligned | [optional] [default to undefined]
20
+ **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
20
21
 
21
22
  ## Example
22
23
 
@@ -35,6 +36,7 @@ const instance: PartnerDTO = {
35
36
  hostingPriceListId,
36
37
  installationUrl,
37
38
  aligned,
39
+ customer,
38
40
  };
39
41
  ```
40
42
 
@@ -23,7 +23,7 @@ import {
23
23
  const configuration = new Configuration();
24
24
  const apiInstance = new PricingApi(configuration);
25
25
 
26
- let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations'; //Price List Type (default to undefined)
26
+ let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations' | 'Jedware'; //Price List Type (default to undefined)
27
27
  let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
28
28
  let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
29
29
  let customerId: string; //Customer ID (optional) (default to undefined)
@@ -40,7 +40,7 @@ const { status, data } = await apiInstance.getGetPriceList(
40
40
 
41
41
  |Name | Type | Description | Notes|
42
42
  |------------- | ------------- | ------------- | -------------|
43
- | **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39;>** | Price List Type | defaults to undefined|
43
+ | **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39; | &#39;Jedware&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39; &#124; &#39;Jedware&#39;>** | Price List Type | defaults to undefined|
44
44
  | **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
45
45
  | **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
46
46
  | **customerId** | [**string**] | Customer ID | (optional) defaults to undefined|
@@ -88,7 +88,7 @@ const apiInstance = new PricingApi(configuration);
88
88
 
89
89
  let email: string; //Email Address (default to undefined)
90
90
  let customerId: string; //Customer ID (default to undefined)
91
- let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations'; //Price List Type (default to undefined)
91
+ let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations' | 'Jedware'; //Price List Type (default to undefined)
92
92
  let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
93
93
  let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
94
94
 
@@ -107,7 +107,7 @@ const { status, data } = await apiInstance.postSendPriceList(
107
107
  |------------- | ------------- | ------------- | -------------|
108
108
  | **email** | [**string**] | Email Address | defaults to undefined|
109
109
  | **customerId** | [**string**] | Customer ID | defaults to undefined|
110
- | **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39;>** | Price List Type | defaults to undefined|
110
+ | **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39; | &#39;Jedware&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39; &#124; &#39;Jedware&#39;>** | Price List Type | defaults to undefined|
111
111
  | **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
112
112
  | **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
113
113
 
@@ -5,12 +5,15 @@ All URIs are relative to *https://localhost*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**deleteAddFanvilMac**](#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group|
8
+ |[**deleteCheckMacExists**](#deletecheckmacexists) | **DELETE** /admin/provisioning/fanvil/macs/{mac} | |
8
9
  |[**deleteDeleteFanvilGroup**](#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS|
10
+ |[**getCheckMacExists**](#getcheckmacexists) | **GET** /admin/provisioning/fanvil/macs/{mac} | |
9
11
  |[**getGetFanvilEncryptionKey**](#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key|
10
12
  |[**getGetFanvilGroupMacs**](#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS|
11
13
  |[**getGetGroups**](#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID|
12
14
  |[**postAddFanvilGroup**](#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS|
13
15
  |[**postAddFanvilMac**](#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group|
16
+ |[**postCreateMac**](#postcreatemac) | **POST** /admin/provisioning/fanvil/macs/ | |
14
17
 
15
18
  # **deleteAddFanvilMac**
16
19
  > deleteAddFanvilMac()
@@ -69,6 +72,60 @@ No authorization required
69
72
 
70
73
  [[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)
71
74
 
75
+ # **deleteCheckMacExists**
76
+ > deleteCheckMacExists()
77
+
78
+ Delete a MAC address in FDPS
79
+
80
+ ### Example
81
+
82
+ ```typescript
83
+ import {
84
+ ProvisioningApi,
85
+ Configuration
86
+ } from 'yellowgrid-api-ts';
87
+
88
+ const configuration = new Configuration();
89
+ const apiInstance = new ProvisioningApi(configuration);
90
+
91
+ let mac: string; //MAC Address (default to undefined)
92
+
93
+ const { status, data } = await apiInstance.deleteCheckMacExists(
94
+ mac
95
+ );
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ |Name | Type | Description | Notes|
101
+ |------------- | ------------- | ------------- | -------------|
102
+ | **mac** | [**string**] | MAC Address | defaults to undefined|
103
+
104
+
105
+ ### Return type
106
+
107
+ void (empty response body)
108
+
109
+ ### Authorization
110
+
111
+ No authorization required
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: Not defined
117
+
118
+
119
+ ### HTTP response details
120
+ | Status code | Description | Response headers |
121
+ |-------------|-------------|------------------|
122
+ |**204** | No Response | - |
123
+ |**400** | Bad Request | - |
124
+ |**401** | Unauthorised | - |
125
+ |**403** | Access Denied | - |
126
+
127
+ [[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)
128
+
72
129
  # **deleteDeleteFanvilGroup**
73
130
  > deleteDeleteFanvilGroup()
74
131
 
@@ -123,6 +180,60 @@ No authorization required
123
180
 
124
181
  [[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)
125
182
 
183
+ # **getCheckMacExists**
184
+ > GetCheckMacExists200Response getCheckMacExists()
185
+
186
+ Check if a MAC address exists in FDPS
187
+
188
+ ### Example
189
+
190
+ ```typescript
191
+ import {
192
+ ProvisioningApi,
193
+ Configuration
194
+ } from 'yellowgrid-api-ts';
195
+
196
+ const configuration = new Configuration();
197
+ const apiInstance = new ProvisioningApi(configuration);
198
+
199
+ let mac: string; //MAC Address (default to undefined)
200
+
201
+ const { status, data } = await apiInstance.getCheckMacExists(
202
+ mac
203
+ );
204
+ ```
205
+
206
+ ### Parameters
207
+
208
+ |Name | Type | Description | Notes|
209
+ |------------- | ------------- | ------------- | -------------|
210
+ | **mac** | [**string**] | MAC Address | defaults to undefined|
211
+
212
+
213
+ ### Return type
214
+
215
+ **GetCheckMacExists200Response**
216
+
217
+ ### Authorization
218
+
219
+ No authorization required
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: Not defined
224
+ - **Accept**: application/json
225
+
226
+
227
+ ### HTTP response details
228
+ | Status code | Description | Response headers |
229
+ |-------------|-------------|------------------|
230
+ |**200** | MAC Address Found | - |
231
+ |**400** | Bad Request | - |
232
+ |**401** | Unauthorised | - |
233
+ |**403** | Access Denied | - |
234
+
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
+
126
237
  # **getGetFanvilEncryptionKey**
127
238
  > string getGetFanvilEncryptionKey()
128
239
 
@@ -400,3 +511,50 @@ No authorization required
400
511
 
401
512
  [[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)
402
513
 
514
+ # **postCreateMac**
515
+ > MacAddressDTO postCreateMac()
516
+
517
+ Create a MAC address in FDPS
518
+
519
+ ### Example
520
+
521
+ ```typescript
522
+ import {
523
+ ProvisioningApi,
524
+ Configuration
525
+ } from 'yellowgrid-api-ts';
526
+
527
+ const configuration = new Configuration();
528
+ const apiInstance = new ProvisioningApi(configuration);
529
+
530
+ const { status, data } = await apiInstance.postCreateMac();
531
+ ```
532
+
533
+ ### Parameters
534
+ This endpoint does not have any parameters.
535
+
536
+
537
+ ### Return type
538
+
539
+ **MacAddressDTO**
540
+
541
+ ### Authorization
542
+
543
+ No authorization required
544
+
545
+ ### HTTP request headers
546
+
547
+ - **Content-Type**: Not defined
548
+ - **Accept**: application/json
549
+
550
+
551
+ ### HTTP response details
552
+ | Status code | Description | Response headers |
553
+ |-------------|-------------|------------------|
554
+ |**201** | MAC Address Created | - |
555
+ |**400** | Bad Request | - |
556
+ |**401** | Unauthorised | - |
557
+ |**403** | Access Denied | - |
558
+
559
+ [[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)
560
+
@@ -28,6 +28,11 @@ export const UserGroupEnum = {
28
28
  "name": "FINANCE",
29
29
  "value": "Finance",
30
30
  "publicValue": "Finance"
31
+ },
32
+ "TELESALES": {
33
+ "name": "TELESALES",
34
+ "value": "Telesales",
35
+ "publicValue": "Telesales"
31
36
  }
32
37
  } as const;
33
38
 
package/openapitools.json CHANGED
@@ -2,6 +2,6 @@
2
2
  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3
3
  "spaces": 2,
4
4
  "generator-cli": {
5
- "version": "7.22.0"
5
+ "version": "7.23.0"
6
6
  }
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.176-dev.0",
3
+ "version": "3.2.177-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -22,7 +22,7 @@
22
22
  "prepare": "npm run build"
23
23
  },
24
24
  "dependencies": {
25
- "axios": "^1.15.2"
25
+ "axios": "^1.16.0"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@types/node": "12.11.5 - 12.20.42",