yellowgrid-api-ts 3.2.281 → 3.2.283
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/api.ts +117 -117
- package/dist/api.d.ts +117 -117
- package/docs/TcxExtsEntity.md +8 -8
- package/docs/TcxNumbersEntity.md +3 -3
- package/docs/TcxOfficeHoursEntity.md +15 -15
- package/docs/TcxPhoneModel.md +6 -6
- package/docs/TcxPhonesEntity.md +6 -6
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSetupEntity.md +25 -25
- package/docs/TcxSipTrunksEntity.md +13 -13
- package/docs/TcxWizardModel.md +9 -9
- package/package.json +1 -1
|
@@ -6,21 +6,21 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [default to undefined]
|
|
10
|
-
**mondayFrom** | **string** | Monday Hours From | [default to undefined]
|
|
11
|
-
**mondayTo** | **string** | Monday Hours To | [default to undefined]
|
|
12
|
-
**tuesdayFrom** | **string** | Tuesday Hours From | [default to undefined]
|
|
13
|
-
**tuesdayTo** | **string** | Tuesday Hours To | [default to undefined]
|
|
14
|
-
**wednesdayFrom** | **string** | Wednesday Hours From | [default to undefined]
|
|
15
|
-
**wednesdayTo** | **string** | Wednesday Hours To | [default to undefined]
|
|
16
|
-
**thursdayFrom** | **string** | Thursday Hours From | [default to undefined]
|
|
17
|
-
**thursdayTo** | **string** | Thursday Hours To | [default to undefined]
|
|
18
|
-
**fridayFrom** | **string** | Friday Hours From | [default to undefined]
|
|
19
|
-
**fridayTo** | **string** | Friday Hours To | [default to undefined]
|
|
20
|
-
**saturdayFrom** | **string** | Saturday Hours From | [default to undefined]
|
|
21
|
-
**saturdayTo** | **string** | Saturday Hours To | [default to undefined]
|
|
22
|
-
**sundayFrom** | **string** | Sunday Hours From | [default to undefined]
|
|
23
|
-
**sundayTo** | **string** | Sunday Hours To | [default to undefined]
|
|
9
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
+
**mondayFrom** | **string** | Monday Hours From | [optional] [default to undefined]
|
|
11
|
+
**mondayTo** | **string** | Monday Hours To | [optional] [default to undefined]
|
|
12
|
+
**tuesdayFrom** | **string** | Tuesday Hours From | [optional] [default to undefined]
|
|
13
|
+
**tuesdayTo** | **string** | Tuesday Hours To | [optional] [default to undefined]
|
|
14
|
+
**wednesdayFrom** | **string** | Wednesday Hours From | [optional] [default to undefined]
|
|
15
|
+
**wednesdayTo** | **string** | Wednesday Hours To | [optional] [default to undefined]
|
|
16
|
+
**thursdayFrom** | **string** | Thursday Hours From | [optional] [default to undefined]
|
|
17
|
+
**thursdayTo** | **string** | Thursday Hours To | [optional] [default to undefined]
|
|
18
|
+
**fridayFrom** | **string** | Friday Hours From | [optional] [default to undefined]
|
|
19
|
+
**fridayTo** | **string** | Friday Hours To | [optional] [default to undefined]
|
|
20
|
+
**saturdayFrom** | **string** | Saturday Hours From | [optional] [default to undefined]
|
|
21
|
+
**saturdayTo** | **string** | Saturday Hours To | [optional] [default to undefined]
|
|
22
|
+
**sundayFrom** | **string** | Sunday Hours From | [optional] [default to undefined]
|
|
23
|
+
**sundayTo** | **string** | Sunday Hours To | [optional] [default to undefined]
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
package/docs/TcxPhoneModel.md
CHANGED
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **number** | id | [default to undefined]
|
|
9
|
-
**phone** | **string** | Phone Model | [default to undefined]
|
|
10
|
-
**mac** | **string** | MAC Address | [default to undefined]
|
|
11
|
-
**sku** | **string** | SKU | [default to undefined]
|
|
12
|
-
**extNo** | **string** | Extension Number | [default to undefined]
|
|
13
|
-
**sbcId** | **string** | SBC ID | [default to undefined]
|
|
8
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
9
|
+
**phone** | **string** | Phone Model | [optional] [default to undefined]
|
|
10
|
+
**mac** | **string** | MAC Address | [optional] [default to undefined]
|
|
11
|
+
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
12
|
+
**extNo** | **string** | Extension Number | [optional] [default to undefined]
|
|
13
|
+
**sbcId** | **string** | SBC ID | [optional] [default to undefined]
|
|
14
14
|
**fromOrder** | **boolean** | Phone exists on order | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
package/docs/TcxPhonesEntity.md
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [default to undefined]
|
|
10
|
-
**phone** | **string** | Phone Model | [default to undefined]
|
|
11
|
-
**mac** | **string** | MAC Address | [default to undefined]
|
|
12
|
-
**sku** | **string** | SKU | [default to undefined]
|
|
13
|
-
**extNo** | **string** | Extension Number | [default to undefined]
|
|
14
|
-
**sbcId** | **string** | SBC ID | [default to undefined]
|
|
9
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
+
**phone** | **string** | Phone Model | [optional] [default to undefined]
|
|
11
|
+
**mac** | **string** | MAC Address | [optional] [default to undefined]
|
|
12
|
+
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
13
|
+
**extNo** | **string** | Extension Number | [optional] [default to undefined]
|
|
14
|
+
**sbcId** | **string** | SBC ID | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/docs/TcxSbcEntity.md
CHANGED
|
@@ -6,22 +6,22 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [default to undefined]
|
|
10
|
-
**sbcId** | **number** | SBC ID | [default to undefined]
|
|
11
|
-
**tcxUrl** | **string** | 3CX URL | [default to undefined]
|
|
12
|
-
**tcxKey** | **string** | 3CX SBC Auth Key | [default to undefined]
|
|
13
|
-
**label** | **string** | Label | [default to undefined]
|
|
14
|
-
**ipAddress** | **string** | IP Address | [default to undefined]
|
|
15
|
-
**netmask** | **string** | Subnet Mask | [default to undefined]
|
|
16
|
-
**defaultGateway** | **string** | Default Gateway | [default to undefined]
|
|
17
|
-
**dns1** | **string** | DNS 1 | [default to undefined]
|
|
18
|
-
**dns2** | **string** | DNS 2 | [default to undefined]
|
|
19
|
-
**address1** | **string** | Site Address Line 1 | [default to undefined]
|
|
20
|
-
**address2** | **string** | Site Address Line 2 | [default to undefined]
|
|
21
|
-
**city** | **string** | Site City | [default to undefined]
|
|
22
|
-
**postalCode** | **string** | Site Postal Code | [default to undefined]
|
|
23
|
-
**primaryContact** | **string** | Site Primary Contact | [default to undefined]
|
|
24
|
-
**technicalContact** | **string** | Site Technical Contact | [default to undefined]
|
|
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
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
package/docs/TcxSbcModel.md
CHANGED
|
@@ -6,22 +6,22 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [default to undefined]
|
|
10
|
-
**sbcId** | **number** | SBC ID | [default to undefined]
|
|
11
|
-
**tcxUrl** | **string** | 3CX URL | [default to undefined]
|
|
12
|
-
**tcxKey** | **string** | 3CX SBC Auth Key | [default to undefined]
|
|
13
|
-
**label** | **string** | Label | [default to undefined]
|
|
14
|
-
**ipAddress** | **string** | IP Address | [default to undefined]
|
|
15
|
-
**netmask** | **string** | Subnet Mask | [default to undefined]
|
|
16
|
-
**defaultGateway** | **string** | Default Gateway | [default to undefined]
|
|
17
|
-
**dns1** | **string** | DNS 1 | [default to undefined]
|
|
18
|
-
**dns2** | **string** | DNS 2 | [default to undefined]
|
|
19
|
-
**address1** | **string** | Site Address Line 1 | [default to undefined]
|
|
20
|
-
**address2** | **string** | Site Address Line 2 | [default to undefined]
|
|
21
|
-
**city** | **string** | Site City | [default to undefined]
|
|
22
|
-
**postalCode** | **string** | Site Postal Code | [default to undefined]
|
|
23
|
-
**primaryContact** | **string** | Site Primary Contact | [default to undefined]
|
|
24
|
-
**technicalContact** | **string** | Site Technical Contact | [default to undefined]
|
|
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
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
package/docs/TcxSetupEntity.md
CHANGED
|
@@ -6,32 +6,32 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**creation** | **string** | Creation Date | [default to undefined]
|
|
9
|
+
**creation** | **string** | Creation Date | [optional] [default to undefined]
|
|
10
10
|
**installType** | **string** | Install Type | [optional] [default to undefined]
|
|
11
|
-
**installVersion** | **number** | 3CX Install Version | [default to 20]
|
|
12
|
-
**orderId** | **number** | Linked Order ID | [default to undefined]
|
|
13
|
-
**customerId** | **number** | Customer ID | [default to undefined]
|
|
14
|
-
**username** | **string** | 3CX System Owner Username | [default to undefined]
|
|
15
|
-
**password** | **string** | 3CX System Owner Password | [default to undefined]
|
|
16
|
-
**primaryContactName** | **string** | Primary Contact Name | [default to undefined]
|
|
17
|
-
**primaryContactNumber** | **string** | Primary Contact Number | [default to undefined]
|
|
18
|
-
**technicalContactName** | **string** | Technical Contact Name | [default to undefined]
|
|
19
|
-
**technicalContactNumber** | **string** | Technical Contact Number | [default to undefined]
|
|
20
|
-
**companyName** | **string** | Company Name | [default to undefined]
|
|
21
|
-
**email** | **string** | 3CX Admin Email Address | [default to undefined]
|
|
22
|
-
**phone** | **string** | Contact Phone Number | [default to undefined]
|
|
23
|
-
**additionalDisk** | **number** | Additional Disk Space | [default to undefined]
|
|
24
|
-
**licencekey** | **string** | 3CX Licence Key | [default to undefined]
|
|
25
|
-
**hostname** | **string** | 3CX Hostname | [default to undefined]
|
|
26
|
-
**suffix** | **string** | 3CX DNS Suffix | [default to undefined]
|
|
27
|
-
**extLength** | **number** | Extension Length | [default to undefined]
|
|
28
|
-
**address1** | **string** | Address Line 1 | [default to undefined]
|
|
29
|
-
**address2** | **string** | Address Line 2 | [default to undefined]
|
|
30
|
-
**city** | **string** | City | [default to undefined]
|
|
31
|
-
**postCode** | **string** | Postal Code | [default to undefined]
|
|
32
|
-
**region** | **string** | Region | [default to undefined]
|
|
33
|
-
**status** | **number** | Status | [default to undefined]
|
|
34
|
-
**instanceId** | **string** | Instance ID | [default to undefined]
|
|
11
|
+
**installVersion** | **number** | 3CX Install Version | [optional] [default to 20]
|
|
12
|
+
**orderId** | **number** | Linked Order ID | [optional] [default to undefined]
|
|
13
|
+
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
14
|
+
**username** | **string** | 3CX System Owner Username | [optional] [default to undefined]
|
|
15
|
+
**password** | **string** | 3CX System Owner Password | [optional] [default to undefined]
|
|
16
|
+
**primaryContactName** | **string** | Primary Contact Name | [optional] [default to undefined]
|
|
17
|
+
**primaryContactNumber** | **string** | Primary Contact Number | [optional] [default to undefined]
|
|
18
|
+
**technicalContactName** | **string** | Technical Contact Name | [optional] [default to undefined]
|
|
19
|
+
**technicalContactNumber** | **string** | Technical Contact Number | [optional] [default to undefined]
|
|
20
|
+
**companyName** | **string** | Company Name | [optional] [default to undefined]
|
|
21
|
+
**email** | **string** | 3CX Admin Email Address | [optional] [default to undefined]
|
|
22
|
+
**phone** | **string** | Contact Phone Number | [optional] [default to undefined]
|
|
23
|
+
**additionalDisk** | **number** | Additional Disk Space | [optional] [default to undefined]
|
|
24
|
+
**licencekey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
25
|
+
**hostname** | **string** | 3CX Hostname | [optional] [default to undefined]
|
|
26
|
+
**suffix** | **string** | 3CX DNS Suffix | [optional] [default to undefined]
|
|
27
|
+
**extLength** | **number** | Extension Length | [optional] [default to undefined]
|
|
28
|
+
**address1** | **string** | Address Line 1 | [optional] [default to undefined]
|
|
29
|
+
**address2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
30
|
+
**city** | **string** | City | [optional] [default to undefined]
|
|
31
|
+
**postCode** | **string** | Postal Code | [optional] [default to undefined]
|
|
32
|
+
**region** | **string** | Region | [optional] [default to undefined]
|
|
33
|
+
**status** | **number** | Status | [optional] [default to undefined]
|
|
34
|
+
**instanceId** | **string** | Instance ID | [optional] [default to undefined]
|
|
35
35
|
|
|
36
36
|
## Example
|
|
37
37
|
|
|
@@ -6,19 +6,19 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [default to undefined]
|
|
10
|
-
**provider** | **string** | Provider | [default to undefined]
|
|
11
|
-
**serviceId** | **number** | Service ID (YG Trunks Only) | [default to undefined]
|
|
12
|
-
**authType** | **string** | Auth Type | [default to undefined]
|
|
13
|
-
**server** | **string** | Registrar Address | [default to undefined]
|
|
14
|
-
**username** | **string** | Username | [default to undefined]
|
|
15
|
-
**password** | **string** | Password | [default to undefined]
|
|
16
|
-
**channels** | **number** | Channels | [default to undefined]
|
|
17
|
-
**port** | **number** | SIP Port | [default to undefined]
|
|
18
|
-
**proxy** | **string** | Proxy Address | [default to undefined]
|
|
19
|
-
**password2** | **string** | Secondary Authentication Password | [default to undefined]
|
|
20
|
-
**number** | **string** | Main Trunk Number | [default to undefined]
|
|
21
|
-
**ipAddress** | **string** | PBX IP Address | [default to undefined]
|
|
9
|
+
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
+
**provider** | **string** | Provider | [optional] [default to undefined]
|
|
11
|
+
**serviceId** | **number** | Service ID (YG Trunks Only) | [optional] [default to undefined]
|
|
12
|
+
**authType** | **string** | Auth Type | [optional] [default to undefined]
|
|
13
|
+
**server** | **string** | Registrar Address | [optional] [default to undefined]
|
|
14
|
+
**username** | **string** | Username | [optional] [default to undefined]
|
|
15
|
+
**password** | **string** | Password | [optional] [default to undefined]
|
|
16
|
+
**channels** | **number** | Channels | [optional] [default to undefined]
|
|
17
|
+
**port** | **number** | SIP Port | [optional] [default to undefined]
|
|
18
|
+
**proxy** | **string** | Proxy Address | [optional] [default to undefined]
|
|
19
|
+
**password2** | **string** | Secondary Authentication Password | [optional] [default to undefined]
|
|
20
|
+
**number** | **string** | Main Trunk Number | [optional] [default to undefined]
|
|
21
|
+
**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
package/docs/TcxWizardModel.md
CHANGED
|
@@ -6,20 +6,20 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | 3CX Installation Wizard ID | [default to undefined]
|
|
10
|
-
**config** | [**TcxWizardConfigModel**](TcxWizardConfigModel.md) | | [default to undefined]
|
|
11
|
-
**licenceKey** | **string** | 3CX Licence Key | [default to undefined]
|
|
12
|
-
**installType** | **string** | Install Type | [default to undefined]
|
|
9
|
+
**id** | **number** | 3CX Installation Wizard ID | [optional] [default to undefined]
|
|
10
|
+
**config** | [**TcxWizardConfigModel**](TcxWizardConfigModel.md) | | [optional] [default to undefined]
|
|
11
|
+
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
12
|
+
**installType** | **string** | Install Type | [optional] [default to undefined]
|
|
13
13
|
**backup** | [**TcxBackupModel**](TcxBackupModel.md) | | [optional] [default to undefined]
|
|
14
|
-
**extensions** | [**Array<TcxExtsEntity>**](TcxExtsEntity.md) | | [default to undefined]
|
|
15
|
-
**numbers** | [**Array<TcxNumbersEntity>**](TcxNumbersEntity.md) | | [default to undefined]
|
|
14
|
+
**extensions** | [**Array<TcxExtsEntity>**](TcxExtsEntity.md) | | [optional] [default to undefined]
|
|
15
|
+
**numbers** | [**Array<TcxNumbersEntity>**](TcxNumbersEntity.md) | | [optional] [default to undefined]
|
|
16
16
|
**officeHours** | [**TcxOfficeHoursEntity**](TcxOfficeHoursEntity.md) | | [optional] [default to undefined]
|
|
17
|
-
**phones** | [**Array<TcxPhoneModel>**](TcxPhoneModel.md) | | [default to undefined]
|
|
18
|
-
**sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) | | [default to undefined]
|
|
17
|
+
**phones** | [**Array<TcxPhoneModel>**](TcxPhoneModel.md) | | [optional] [default to undefined]
|
|
18
|
+
**sbcs** | [**Array<TcxSbcModel>**](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]
|
|
22
|
-
**endUserView** | **boolean** | End User Wizard View | [default to undefined]
|
|
22
|
+
**endUserView** | **boolean** | End User Wizard View | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|