yellowgrid-api-ts 3.2.280 → 3.2.282

package/dist/api.d.ts

@@ -9457,35 +9457,35 @@ export interface TcxExtsEntity {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * Extension Number
      */
-    'extNo': string;
+    'extNo'?: string | null;
     /**
      * First Name
      */
-    'firstName': string;
+    'firstName'?: string | null;
     /**
      * Last Name
      */
-    'lastName': string;
+    'lastName'?: string | null;
     /**
      * Email Address
      */
-    'email': string;
+    'email'?: string | null;
     /**
      * DDI
      */
-    'ddi': string;
+    'ddi'?: string | null;
     /**
      * Outbound CLI
      */
-    'cli': string;
+    'cli'?: string | null;
     /**
      * Recording Enabled
      */
-    'recording': boolean;
+    'recording'?: boolean | null;
 }
 /**
  * 3CX Installation
@@ -9892,15 +9892,15 @@ export interface TcxNumbersEntity {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * Number
      */
-    'number': string;
+    'number'?: string | null;
     /**
      * Label
      */
-    'label': string;
+    'label'?: string | null;
 }
 /**
  * 3CX Wizard Office Hours
@@ -9971,27 +9971,27 @@ export interface TcxPhoneModel {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * Phone Model
      */
-    'phone': string;
+    'phone'?: string | null;
     /**
      * MAC Address
      */
-    'mac': string;
+    'mac'?: string | null;
     /**
      * SKU
      */
-    'sku': string;
+    'sku'?: string | null;
     /**
      * Extension Number
      */
-    'extNo': string;
+    'extNo'?: string | null;
     /**
      * SBC ID
      */
-    'sbcId': string;
+    'sbcId'?: string | null;
     /**
      * Phone exists on order
      */
@@ -10004,27 +10004,27 @@ export interface TcxPhonesEntity {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * Phone Model
      */
-    'phone': string;
+    'phone'?: string | null;
     /**
      * MAC Address
      */
-    'mac': string;
+    'mac'?: string | null;
     /**
      * SKU
      */
-    'sku': string;
+    'sku'?: string | null;
     /**
      * Extension Number
      */
-    'extNo': string;
+    'extNo'?: string | null;
     /**
      * SBC ID
      */
-    'sbcId': string;
+    'sbcId'?: string | null;
 }
 /**
  * 3CX Remote Storage
@@ -10091,67 +10091,67 @@ export interface TcxSbcEntity {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * SBC ID
      */
-    'sbcId': number;
+    'sbcId'?: number | null;
     /**
      * 3CX URL
      */
-    'tcxUrl': string;
+    'tcxUrl'?: string | null;
     /**
      * 3CX SBC Auth Key
      */
-    'tcxKey': string;
+    'tcxKey'?: string | null;
     /**
      * Label
      */
-    'label': string;
+    'label'?: string | null;
     /**
      * IP Address
      */
-    'ipAddress': string;
+    'ipAddress'?: string | null;
     /**
      * Subnet Mask
      */
-    'netmask': string;
+    'netmask'?: string | null;
     /**
      * Default Gateway
      */
-    'defaultGateway': string;
+    'defaultGateway'?: string | null;
     /**
      * DNS 1
      */
-    'dns1': string;
+    'dns1'?: string | null;
     /**
      * DNS 2
      */
-    'dns2': string;
+    'dns2'?: string | null;
     /**
      * Site Address Line 1
      */
-    'address1': string;
+    'address1'?: string | null;
     /**
      * Site Address Line 2
      */
-    'address2': string;
+    'address2'?: string | null;
     /**
      * Site City
      */
-    'city': string;
+    'city'?: string | null;
     /**
      * Site Postal Code
      */
-    'postalCode': string;
+    'postalCode'?: string | null;
     /**
      * Site Primary Contact
      */
-    'primaryContact': string;
+    'primaryContact'?: string | null;
     /**
      * Site Technical Contact
      */
-    'technicalContact': string;
+    'technicalContact'?: string | null;
 }
 /**
  * 3CX Wizard SBC
@@ -10160,67 +10160,67 @@ export interface TcxSbcModel {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * SBC ID
      */
-    'sbcId': number;
+    'sbcId'?: number | null;
     /**
      * 3CX URL
      */
-    'tcxUrl': string;
+    'tcxUrl'?: string | null;
     /**
      * 3CX SBC Auth Key
      */
-    'tcxKey': string;
+    'tcxKey'?: string | null;
     /**
      * Label
      */
-    'label': string;
+    'label'?: string | null;
     /**
      * IP Address
      */
-    'ipAddress': string;
+    'ipAddress'?: string | null;
     /**
      * Subnet Mask
      */
-    'netmask': string;
+    'netmask'?: string | null;
     /**
      * Default Gateway
      */
-    'defaultGateway': string;
+    'defaultGateway'?: string | null;
     /**
      * DNS 1
      */
-    'dns1': string;
+    'dns1'?: string | null;
     /**
      * DNS 2
      */
-    'dns2': string;
+    'dns2'?: string | null;
     /**
      * Site Address Line 1
      */
-    'address1': string;
+    'address1'?: string | null;
     /**
      * Site Address Line 2
      */
-    'address2': string;
+    'address2'?: string | null;
     /**
      * Site City
      */
-    'city': string;
+    'city'?: string | null;
     /**
      * Site Postal Code
      */
-    'postalCode': string;
+    'postalCode'?: string | null;
     /**
      * Site Primary Contact
      */
-    'primaryContact': string;
+    'primaryContact'?: string | null;
     /**
      * Site Technical Contact
      */
-    'technicalContact': string;
+    'technicalContact'?: string | null;
 }
 /**
  * 3CX SBC Response
@@ -10242,7 +10242,7 @@ export interface TcxSetupEntity {
     /**
      * Creation Date
      */
-    'creation': string;
+    'creation'?: string | null;
     /**
      * Install Type
      */
@@ -10250,99 +10250,99 @@ export interface TcxSetupEntity {
     /**
      * 3CX Install Version
      */
-    'installVersion': number;
+    'installVersion'?: number | null;
     /**
      * Linked Order ID
      */
-    'orderId': number;
+    'orderId'?: number | null;
     /**
      * Customer ID
      */
-    'customerId': number;
+    'customerId'?: number | null;
     /**
      * 3CX System Owner Username
      */
-    'username': string;
+    'username'?: string | null;
     /**
      * 3CX System Owner Password
      */
-    'password': string;
+    'password'?: string | null;
     /**
      * Primary Contact Name
      */
-    'primaryContactName': string;
+    'primaryContactName'?: string | null;
     /**
      * Primary Contact Number
      */
-    'primaryContactNumber': string;
+    'primaryContactNumber'?: string | null;
     /**
      * Technical Contact Name
      */
-    'technicalContactName': string;
+    'technicalContactName'?: string | null;
     /**
      * Technical Contact Number
      */
-    'technicalContactNumber': string;
+    'technicalContactNumber'?: string | null;
     /**
      * Company Name
      */
-    'companyName': string;
+    'companyName'?: string | null;
     /**
      * 3CX Admin Email Address
      */
-    'email': string;
+    'email'?: string | null;
     /**
      * Contact Phone Number
      */
-    'phone': string;
+    'phone'?: string | null;
     /**
      * Additional Disk Space
      */
-    'additionalDisk': number;
+    'additionalDisk'?: number | null;
     /**
      * 3CX Licence Key
      */
-    'licencekey': string;
+    'licencekey'?: string | null;
     /**
      * 3CX Hostname
      */
-    'hostname': string;
+    'hostname'?: string | null;
     /**
      * 3CX DNS Suffix
      */
-    'suffix': string;
+    'suffix'?: string | null;
     /**
      * Extension Length
      */
-    'extLength': number;
+    'extLength'?: number | null;
     /**
      * Address Line 1
      */
-    'address1': string;
+    'address1'?: string | null;
     /**
      * Address Line 2
      */
-    'address2': string;
+    'address2'?: string | null;
     /**
      * City
      */
-    'city': string;
+    'city'?: string | null;
     /**
      * Postal Code
      */
-    'postCode': string;
+    'postCode'?: string | null;
     /**
      * Region
      */
-    'region': TcxSetupEntityRegionEnum;
+    'region'?: TcxSetupEntityRegionEnum | null;
     /**
      * Status
      */
-    'status': number;
+    'status'?: number | null;
     /**
      * Instance ID
      */
-    'instanceId': string;
+    'instanceId'?: string | null;
 }
 export declare const TcxSetupEntityInstallTypeEnum: {
     readonly New: "new";
@@ -10391,55 +10391,55 @@ export interface TcxSipTrunksEntity {
     /**
      * id
      */
-    'id': number;
+    'id'?: number | null;
     /**
      * Provider
      */
-    'provider': string;
+    'provider'?: string | null;
     /**
      * Service ID (YG Trunks Only)
      */
-    'serviceId': number;
+    'serviceId'?: number | null;
     /**
      * Auth Type
      */
-    'authType': string;
+    'authType'?: string | null;
     /**
      * Registrar Address
      */
-    'server': string;
+    'server'?: string | null;
     /**
      * Username
      */
-    'username': string;
+    'username'?: string | null;
     /**
      * Password
      */
-    'password': string;
+    'password'?: string | null;
     /**
      * Channels
      */
-    'channels': number;
+    'channels'?: number | null;
     /**
      * SIP Port
      */
-    'port': number;
+    'port'?: number | null;
     /**
      * Proxy Address
      */
-    'proxy': string;
+    'proxy'?: string | null;
     /**
      * Secondary Authentication Password
      */
-    'password2': string;
+    'password2'?: string | null;
     /**
      * Main Trunk Number
      */
-    'number': string;
+    'number'?: string | null;
     /**
      * PBX IP Address
      */
-    'ipAddress': string;
+    'ipAddress'?: string | null;
 }
 /**
  * 3CX Template
@@ -10500,22 +10500,22 @@ export interface TcxWizardModel {
     /**
      * 3CX Installation Wizard ID
      */
-    'id': number;
-    'config': TcxWizardConfigModel;
+    'id'?: number | null;
+    'config'?: TcxWizardConfigModel | null;
     /**
      * 3CX Licence Key
      */
-    'licenceKey': string;
+    'licenceKey'?: string | null;
     /**
      * Install Type
      */
-    'installType': TcxWizardModelInstallTypeEnum;
+    'installType'?: TcxWizardModelInstallTypeEnum | null;
     'backup'?: TcxBackupModel | null;
-    'extensions': Array<TcxExtsEntity>;
-    'numbers': Array<TcxNumbersEntity>;
+    'extensions'?: Array<TcxExtsEntity> | null;
+    'numbers'?: Array<TcxNumbersEntity> | null;
     'officeHours'?: TcxOfficeHoursEntity | null;
-    'phones': Array<TcxPhoneModel>;
-    'sbcs': Array<TcxSbcModel>;
+    'phones'?: Array<TcxPhoneModel> | null;
+    'sbcs'?: Array<TcxSbcModel> | null;
     'sipTrunk'?: TcxSipTrunksEntity | null;
     'installationStatus'?: TcxWizardModelInstallationStatusEnum | null;
     'setup'?: TcxSetupEntity | null;

package/docs/TcxExtsEntity.md

@@ -6,14 +6,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**extNo** | **string** | Extension Number | [default to undefined]
-**firstName** | **string** | First Name | [default to undefined]
-**lastName** | **string** | Last Name | [default to undefined]
-**email** | **string** | Email Address | [default to undefined]
-**ddi** | **string** | DDI | [default to undefined]
-**cli** | **string** | Outbound CLI | [default to undefined]
-**recording** | **boolean** | Recording Enabled | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**extNo** | **string** | Extension Number | [optional] [default to undefined]
+**firstName** | **string** | First Name | [optional] [default to undefined]
+**lastName** | **string** | Last Name | [optional] [default to undefined]
+**email** | **string** | Email Address | [optional] [default to undefined]
+**ddi** | **string** | DDI | [optional] [default to undefined]
+**cli** | **string** | Outbound CLI | [optional] [default to undefined]
+**recording** | **boolean** | Recording Enabled | [optional] [default to undefined]
 
 ## Example
 

package/docs/TcxNumbersEntity.md

@@ -6,9 +6,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**number** | **string** | Number | [default to undefined]
-**label** | **string** | Label | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**number** | **string** | Number | [optional] [default to undefined]
+**label** | **string** | Label | [optional] [default to undefined]
 
 ## Example
 

package/docs/TcxPhoneModel.md

@@ -5,12 +5,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**phone** | **string** | Phone Model | [default to undefined]
-**mac** | **string** | MAC Address | [default to undefined]
-**sku** | **string** | SKU | [default to undefined]
-**extNo** | **string** | Extension Number | [default to undefined]
-**sbcId** | **string** | SBC ID | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**phone** | **string** | Phone Model | [optional] [default to undefined]
+**mac** | **string** | MAC Address | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**extNo** | **string** | Extension Number | [optional] [default to undefined]
+**sbcId** | **string** | SBC ID | [optional] [default to undefined]
 **fromOrder** | **boolean** | Phone exists on order | [optional] [default to undefined]
 
 ## Example

package/docs/TcxPhonesEntity.md

@@ -6,12 +6,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**phone** | **string** | Phone Model | [default to undefined]
-**mac** | **string** | MAC Address | [default to undefined]
-**sku** | **string** | SKU | [default to undefined]
-**extNo** | **string** | Extension Number | [default to undefined]
-**sbcId** | **string** | SBC ID | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**phone** | **string** | Phone Model | [optional] [default to undefined]
+**mac** | **string** | MAC Address | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**extNo** | **string** | Extension Number | [optional] [default to undefined]
+**sbcId** | **string** | SBC ID | [optional] [default to undefined]
 
 ## Example
 

package/docs/TcxSbcEntity.md

@@ -6,22 +6,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**sbcId** | **number** | SBC ID | [default to undefined]
-**tcxUrl** | **string** | 3CX URL | [default to undefined]
-**tcxKey** | **string** | 3CX SBC Auth Key | [default to undefined]
-**label** | **string** | Label | [default to undefined]
-**ipAddress** | **string** | IP Address | [default to undefined]
-**netmask** | **string** | Subnet Mask | [default to undefined]
-**defaultGateway** | **string** | Default Gateway | [default to undefined]
-**dns1** | **string** | DNS 1 | [default to undefined]
-**dns2** | **string** | DNS 2 | [default to undefined]
-**address1** | **string** | Site Address Line 1 | [default to undefined]
-**address2** | **string** | Site Address Line 2 | [default to undefined]
-**city** | **string** | Site City | [default to undefined]
-**postalCode** | **string** | Site Postal Code | [default to undefined]
-**primaryContact** | **string** | Site Primary Contact | [default to undefined]
-**technicalContact** | **string** | Site Technical Contact | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**sbcId** | **number** | SBC ID | [optional] [default to undefined]
+**tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
+**tcxKey** | **string** | 3CX SBC Auth Key | [optional] [default to undefined]
+**label** | **string** | Label | [optional] [default to undefined]
+**ipAddress** | **string** | IP Address | [optional] [default to undefined]
+**netmask** | **string** | Subnet Mask | [optional] [default to undefined]
+**defaultGateway** | **string** | Default Gateway | [optional] [default to undefined]
+**dns1** | **string** | DNS 1 | [optional] [default to undefined]
+**dns2** | **string** | DNS 2 | [optional] [default to undefined]
+**address1** | **string** | Site Address Line 1 | [optional] [default to undefined]
+**address2** | **string** | Site Address Line 2 | [optional] [default to undefined]
+**city** | **string** | Site City | [optional] [default to undefined]
+**postalCode** | **string** | Site Postal Code | [optional] [default to undefined]
+**primaryContact** | **string** | Site Primary Contact | [optional] [default to undefined]
+**technicalContact** | **string** | Site Technical Contact | [optional] [default to undefined]
 
 ## Example