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/dist/api.d.ts CHANGED
@@ -9457,35 +9457,35 @@ export interface TcxExtsEntity {
9457
9457
  /**
9458
9458
  * id
9459
9459
  */
9460
- 'id': number;
9460
+ 'id'?: number | null;
9461
9461
  /**
9462
9462
  * Extension Number
9463
9463
  */
9464
- 'extNo': string;
9464
+ 'extNo'?: string | null;
9465
9465
  /**
9466
9466
  * First Name
9467
9467
  */
9468
- 'firstName': string;
9468
+ 'firstName'?: string | null;
9469
9469
  /**
9470
9470
  * Last Name
9471
9471
  */
9472
- 'lastName': string;
9472
+ 'lastName'?: string | null;
9473
9473
  /**
9474
9474
  * Email Address
9475
9475
  */
9476
- 'email': string;
9476
+ 'email'?: string | null;
9477
9477
  /**
9478
9478
  * DDI
9479
9479
  */
9480
- 'ddi': string;
9480
+ 'ddi'?: string | null;
9481
9481
  /**
9482
9482
  * Outbound CLI
9483
9483
  */
9484
- 'cli': string;
9484
+ 'cli'?: string | null;
9485
9485
  /**
9486
9486
  * Recording Enabled
9487
9487
  */
9488
- 'recording': boolean;
9488
+ 'recording'?: boolean | null;
9489
9489
  }
9490
9490
  /**
9491
9491
  * 3CX Installation
@@ -9892,15 +9892,15 @@ export interface TcxNumbersEntity {
9892
9892
  /**
9893
9893
  * id
9894
9894
  */
9895
- 'id': number;
9895
+ 'id'?: number | null;
9896
9896
  /**
9897
9897
  * Number
9898
9898
  */
9899
- 'number': string;
9899
+ 'number'?: string | null;
9900
9900
  /**
9901
9901
  * Label
9902
9902
  */
9903
- 'label': string;
9903
+ 'label'?: string | null;
9904
9904
  }
9905
9905
  /**
9906
9906
  * 3CX Wizard Office Hours
@@ -9909,89 +9909,89 @@ export interface TcxOfficeHoursEntity {
9909
9909
  /**
9910
9910
  * id
9911
9911
  */
9912
- 'id': number;
9912
+ 'id'?: number | null;
9913
9913
  /**
9914
9914
  * Monday Hours From
9915
9915
  */
9916
- 'mondayFrom': string;
9916
+ 'mondayFrom'?: string | null;
9917
9917
  /**
9918
9918
  * Monday Hours To
9919
9919
  */
9920
- 'mondayTo': string;
9920
+ 'mondayTo'?: string | null;
9921
9921
  /**
9922
9922
  * Tuesday Hours From
9923
9923
  */
9924
- 'tuesdayFrom': string;
9924
+ 'tuesdayFrom'?: string | null;
9925
9925
  /**
9926
9926
  * Tuesday Hours To
9927
9927
  */
9928
- 'tuesdayTo': string;
9928
+ 'tuesdayTo'?: string | null;
9929
9929
  /**
9930
9930
  * Wednesday Hours From
9931
9931
  */
9932
- 'wednesdayFrom': string;
9932
+ 'wednesdayFrom'?: string | null;
9933
9933
  /**
9934
9934
  * Wednesday Hours To
9935
9935
  */
9936
- 'wednesdayTo': string;
9936
+ 'wednesdayTo'?: string | null;
9937
9937
  /**
9938
9938
  * Thursday Hours From
9939
9939
  */
9940
- 'thursdayFrom': string;
9940
+ 'thursdayFrom'?: string | null;
9941
9941
  /**
9942
9942
  * Thursday Hours To
9943
9943
  */
9944
- 'thursdayTo': string;
9944
+ 'thursdayTo'?: string | null;
9945
9945
  /**
9946
9946
  * Friday Hours From
9947
9947
  */
9948
- 'fridayFrom': string;
9948
+ 'fridayFrom'?: string | null;
9949
9949
  /**
9950
9950
  * Friday Hours To
9951
9951
  */
9952
- 'fridayTo': string;
9952
+ 'fridayTo'?: string | null;
9953
9953
  /**
9954
9954
  * Saturday Hours From
9955
9955
  */
9956
- 'saturdayFrom': string;
9956
+ 'saturdayFrom'?: string | null;
9957
9957
  /**
9958
9958
  * Saturday Hours To
9959
9959
  */
9960
- 'saturdayTo': string;
9960
+ 'saturdayTo'?: string | null;
9961
9961
  /**
9962
9962
  * Sunday Hours From
9963
9963
  */
9964
- 'sundayFrom': string;
9964
+ 'sundayFrom'?: string | null;
9965
9965
  /**
9966
9966
  * Sunday Hours To
9967
9967
  */
9968
- 'sundayTo': string;
9968
+ 'sundayTo'?: string | null;
9969
9969
  }
9970
9970
  export interface TcxPhoneModel {
9971
9971
  /**
9972
9972
  * id
9973
9973
  */
9974
- 'id': number;
9974
+ 'id'?: number | null;
9975
9975
  /**
9976
9976
  * Phone Model
9977
9977
  */
9978
- 'phone': string;
9978
+ 'phone'?: string | null;
9979
9979
  /**
9980
9980
  * MAC Address
9981
9981
  */
9982
- 'mac': string;
9982
+ 'mac'?: string | null;
9983
9983
  /**
9984
9984
  * SKU
9985
9985
  */
9986
- 'sku': string;
9986
+ 'sku'?: string | null;
9987
9987
  /**
9988
9988
  * Extension Number
9989
9989
  */
9990
- 'extNo': string;
9990
+ 'extNo'?: string | null;
9991
9991
  /**
9992
9992
  * SBC ID
9993
9993
  */
9994
- 'sbcId': string;
9994
+ 'sbcId'?: string | null;
9995
9995
  /**
9996
9996
  * Phone exists on order
9997
9997
  */
@@ -10004,27 +10004,27 @@ export interface TcxPhonesEntity {
10004
10004
  /**
10005
10005
  * id
10006
10006
  */
10007
- 'id': number;
10007
+ 'id'?: number | null;
10008
10008
  /**
10009
10009
  * Phone Model
10010
10010
  */
10011
- 'phone': string;
10011
+ 'phone'?: string | null;
10012
10012
  /**
10013
10013
  * MAC Address
10014
10014
  */
10015
- 'mac': string;
10015
+ 'mac'?: string | null;
10016
10016
  /**
10017
10017
  * SKU
10018
10018
  */
10019
- 'sku': string;
10019
+ 'sku'?: string | null;
10020
10020
  /**
10021
10021
  * Extension Number
10022
10022
  */
10023
- 'extNo': string;
10023
+ 'extNo'?: string | null;
10024
10024
  /**
10025
10025
  * SBC ID
10026
10026
  */
10027
- 'sbcId': string;
10027
+ 'sbcId'?: string | null;
10028
10028
  }
10029
10029
  /**
10030
10030
  * 3CX Remote Storage
@@ -10091,67 +10091,67 @@ export interface TcxSbcEntity {
10091
10091
  /**
10092
10092
  * id
10093
10093
  */
10094
- 'id': number;
10094
+ 'id'?: number | null;
10095
10095
  /**
10096
10096
  * SBC ID
10097
10097
  */
10098
- 'sbcId': number;
10098
+ 'sbcId'?: number | null;
10099
10099
  /**
10100
10100
  * 3CX URL
10101
10101
  */
10102
- 'tcxUrl': string;
10102
+ 'tcxUrl'?: string | null;
10103
10103
  /**
10104
10104
  * 3CX SBC Auth Key
10105
10105
  */
10106
- 'tcxKey': string;
10106
+ 'tcxKey'?: string | null;
10107
10107
  /**
10108
10108
  * Label
10109
10109
  */
10110
- 'label': string;
10110
+ 'label'?: string | null;
10111
10111
  /**
10112
10112
  * IP Address
10113
10113
  */
10114
- 'ipAddress': string;
10114
+ 'ipAddress'?: string | null;
10115
10115
  /**
10116
10116
  * Subnet Mask
10117
10117
  */
10118
- 'netmask': string;
10118
+ 'netmask'?: string | null;
10119
10119
  /**
10120
10120
  * Default Gateway
10121
10121
  */
10122
- 'defaultGateway': string;
10122
+ 'defaultGateway'?: string | null;
10123
10123
  /**
10124
10124
  * DNS 1
10125
10125
  */
10126
- 'dns1': string;
10126
+ 'dns1'?: string | null;
10127
10127
  /**
10128
10128
  * DNS 2
10129
10129
  */
10130
- 'dns2': string;
10130
+ 'dns2'?: string | null;
10131
10131
  /**
10132
10132
  * Site Address Line 1
10133
10133
  */
10134
- 'address1': string;
10134
+ 'address1'?: string | null;
10135
10135
  /**
10136
10136
  * Site Address Line 2
10137
10137
  */
10138
- 'address2': string;
10138
+ 'address2'?: string | null;
10139
10139
  /**
10140
10140
  * Site City
10141
10141
  */
10142
- 'city': string;
10142
+ 'city'?: string | null;
10143
10143
  /**
10144
10144
  * Site Postal Code
10145
10145
  */
10146
- 'postalCode': string;
10146
+ 'postalCode'?: string | null;
10147
10147
  /**
10148
10148
  * Site Primary Contact
10149
10149
  */
10150
- 'primaryContact': string;
10150
+ 'primaryContact'?: string | null;
10151
10151
  /**
10152
10152
  * Site Technical Contact
10153
10153
  */
10154
- 'technicalContact': string;
10154
+ 'technicalContact'?: string | null;
10155
10155
  }
10156
10156
  /**
10157
10157
  * 3CX Wizard SBC
@@ -10160,67 +10160,67 @@ export interface TcxSbcModel {
10160
10160
  /**
10161
10161
  * id
10162
10162
  */
10163
- 'id': number;
10163
+ 'id'?: number | null;
10164
10164
  /**
10165
10165
  * SBC ID
10166
10166
  */
10167
- 'sbcId': number;
10167
+ 'sbcId'?: number | null;
10168
10168
  /**
10169
10169
  * 3CX URL
10170
10170
  */
10171
- 'tcxUrl': string;
10171
+ 'tcxUrl'?: string | null;
10172
10172
  /**
10173
10173
  * 3CX SBC Auth Key
10174
10174
  */
10175
- 'tcxKey': string;
10175
+ 'tcxKey'?: string | null;
10176
10176
  /**
10177
10177
  * Label
10178
10178
  */
10179
- 'label': string;
10179
+ 'label'?: string | null;
10180
10180
  /**
10181
10181
  * IP Address
10182
10182
  */
10183
- 'ipAddress': string;
10183
+ 'ipAddress'?: string | null;
10184
10184
  /**
10185
10185
  * Subnet Mask
10186
10186
  */
10187
- 'netmask': string;
10187
+ 'netmask'?: string | null;
10188
10188
  /**
10189
10189
  * Default Gateway
10190
10190
  */
10191
- 'defaultGateway': string;
10191
+ 'defaultGateway'?: string | null;
10192
10192
  /**
10193
10193
  * DNS 1
10194
10194
  */
10195
- 'dns1': string;
10195
+ 'dns1'?: string | null;
10196
10196
  /**
10197
10197
  * DNS 2
10198
10198
  */
10199
- 'dns2': string;
10199
+ 'dns2'?: string | null;
10200
10200
  /**
10201
10201
  * Site Address Line 1
10202
10202
  */
10203
- 'address1': string;
10203
+ 'address1'?: string | null;
10204
10204
  /**
10205
10205
  * Site Address Line 2
10206
10206
  */
10207
- 'address2': string;
10207
+ 'address2'?: string | null;
10208
10208
  /**
10209
10209
  * Site City
10210
10210
  */
10211
- 'city': string;
10211
+ 'city'?: string | null;
10212
10212
  /**
10213
10213
  * Site Postal Code
10214
10214
  */
10215
- 'postalCode': string;
10215
+ 'postalCode'?: string | null;
10216
10216
  /**
10217
10217
  * Site Primary Contact
10218
10218
  */
10219
- 'primaryContact': string;
10219
+ 'primaryContact'?: string | null;
10220
10220
  /**
10221
10221
  * Site Technical Contact
10222
10222
  */
10223
- 'technicalContact': string;
10223
+ 'technicalContact'?: string | null;
10224
10224
  }
10225
10225
  /**
10226
10226
  * 3CX SBC Response
@@ -10242,7 +10242,7 @@ export interface TcxSetupEntity {
10242
10242
  /**
10243
10243
  * Creation Date
10244
10244
  */
10245
- 'creation': string;
10245
+ 'creation'?: string | null;
10246
10246
  /**
10247
10247
  * Install Type
10248
10248
  */
@@ -10250,99 +10250,99 @@ export interface TcxSetupEntity {
10250
10250
  /**
10251
10251
  * 3CX Install Version
10252
10252
  */
10253
- 'installVersion': number;
10253
+ 'installVersion'?: number | null;
10254
10254
  /**
10255
10255
  * Linked Order ID
10256
10256
  */
10257
- 'orderId': number;
10257
+ 'orderId'?: number | null;
10258
10258
  /**
10259
10259
  * Customer ID
10260
10260
  */
10261
- 'customerId': number;
10261
+ 'customerId'?: number | null;
10262
10262
  /**
10263
10263
  * 3CX System Owner Username
10264
10264
  */
10265
- 'username': string;
10265
+ 'username'?: string | null;
10266
10266
  /**
10267
10267
  * 3CX System Owner Password
10268
10268
  */
10269
- 'password': string;
10269
+ 'password'?: string | null;
10270
10270
  /**
10271
10271
  * Primary Contact Name
10272
10272
  */
10273
- 'primaryContactName': string;
10273
+ 'primaryContactName'?: string | null;
10274
10274
  /**
10275
10275
  * Primary Contact Number
10276
10276
  */
10277
- 'primaryContactNumber': string;
10277
+ 'primaryContactNumber'?: string | null;
10278
10278
  /**
10279
10279
  * Technical Contact Name
10280
10280
  */
10281
- 'technicalContactName': string;
10281
+ 'technicalContactName'?: string | null;
10282
10282
  /**
10283
10283
  * Technical Contact Number
10284
10284
  */
10285
- 'technicalContactNumber': string;
10285
+ 'technicalContactNumber'?: string | null;
10286
10286
  /**
10287
10287
  * Company Name
10288
10288
  */
10289
- 'companyName': string;
10289
+ 'companyName'?: string | null;
10290
10290
  /**
10291
10291
  * 3CX Admin Email Address
10292
10292
  */
10293
- 'email': string;
10293
+ 'email'?: string | null;
10294
10294
  /**
10295
10295
  * Contact Phone Number
10296
10296
  */
10297
- 'phone': string;
10297
+ 'phone'?: string | null;
10298
10298
  /**
10299
10299
  * Additional Disk Space
10300
10300
  */
10301
- 'additionalDisk': number;
10301
+ 'additionalDisk'?: number | null;
10302
10302
  /**
10303
10303
  * 3CX Licence Key
10304
10304
  */
10305
- 'licencekey': string;
10305
+ 'licencekey'?: string | null;
10306
10306
  /**
10307
10307
  * 3CX Hostname
10308
10308
  */
10309
- 'hostname': string;
10309
+ 'hostname'?: string | null;
10310
10310
  /**
10311
10311
  * 3CX DNS Suffix
10312
10312
  */
10313
- 'suffix': string;
10313
+ 'suffix'?: string | null;
10314
10314
  /**
10315
10315
  * Extension Length
10316
10316
  */
10317
- 'extLength': number;
10317
+ 'extLength'?: number | null;
10318
10318
  /**
10319
10319
  * Address Line 1
10320
10320
  */
10321
- 'address1': string;
10321
+ 'address1'?: string | null;
10322
10322
  /**
10323
10323
  * Address Line 2
10324
10324
  */
10325
- 'address2': string;
10325
+ 'address2'?: string | null;
10326
10326
  /**
10327
10327
  * City
10328
10328
  */
10329
- 'city': string;
10329
+ 'city'?: string | null;
10330
10330
  /**
10331
10331
  * Postal Code
10332
10332
  */
10333
- 'postCode': string;
10333
+ 'postCode'?: string | null;
10334
10334
  /**
10335
10335
  * Region
10336
10336
  */
10337
- 'region': TcxSetupEntityRegionEnum;
10337
+ 'region'?: TcxSetupEntityRegionEnum | null;
10338
10338
  /**
10339
10339
  * Status
10340
10340
  */
10341
- 'status': number;
10341
+ 'status'?: number | null;
10342
10342
  /**
10343
10343
  * Instance ID
10344
10344
  */
10345
- 'instanceId': string;
10345
+ 'instanceId'?: string | null;
10346
10346
  }
10347
10347
  export declare const TcxSetupEntityInstallTypeEnum: {
10348
10348
  readonly New: "new";
@@ -10391,55 +10391,55 @@ export interface TcxSipTrunksEntity {
10391
10391
  /**
10392
10392
  * id
10393
10393
  */
10394
- 'id': number;
10394
+ 'id'?: number | null;
10395
10395
  /**
10396
10396
  * Provider
10397
10397
  */
10398
- 'provider': string;
10398
+ 'provider'?: string | null;
10399
10399
  /**
10400
10400
  * Service ID (YG Trunks Only)
10401
10401
  */
10402
- 'serviceId': number;
10402
+ 'serviceId'?: number | null;
10403
10403
  /**
10404
10404
  * Auth Type
10405
10405
  */
10406
- 'authType': string;
10406
+ 'authType'?: string | null;
10407
10407
  /**
10408
10408
  * Registrar Address
10409
10409
  */
10410
- 'server': string;
10410
+ 'server'?: string | null;
10411
10411
  /**
10412
10412
  * Username
10413
10413
  */
10414
- 'username': string;
10414
+ 'username'?: string | null;
10415
10415
  /**
10416
10416
  * Password
10417
10417
  */
10418
- 'password': string;
10418
+ 'password'?: string | null;
10419
10419
  /**
10420
10420
  * Channels
10421
10421
  */
10422
- 'channels': number;
10422
+ 'channels'?: number | null;
10423
10423
  /**
10424
10424
  * SIP Port
10425
10425
  */
10426
- 'port': number;
10426
+ 'port'?: number | null;
10427
10427
  /**
10428
10428
  * Proxy Address
10429
10429
  */
10430
- 'proxy': string;
10430
+ 'proxy'?: string | null;
10431
10431
  /**
10432
10432
  * Secondary Authentication Password
10433
10433
  */
10434
- 'password2': string;
10434
+ 'password2'?: string | null;
10435
10435
  /**
10436
10436
  * Main Trunk Number
10437
10437
  */
10438
- 'number': string;
10438
+ 'number'?: string | null;
10439
10439
  /**
10440
10440
  * PBX IP Address
10441
10441
  */
10442
- 'ipAddress': string;
10442
+ 'ipAddress'?: string | null;
10443
10443
  }
10444
10444
  /**
10445
10445
  * 3CX Template
@@ -10500,29 +10500,29 @@ export interface TcxWizardModel {
10500
10500
  /**
10501
10501
  * 3CX Installation Wizard ID
10502
10502
  */
10503
- 'id': number;
10504
- 'config': TcxWizardConfigModel;
10503
+ 'id'?: number | null;
10504
+ 'config'?: TcxWizardConfigModel | null;
10505
10505
  /**
10506
10506
  * 3CX Licence Key
10507
10507
  */
10508
- 'licenceKey': string;
10508
+ 'licenceKey'?: string | null;
10509
10509
  /**
10510
10510
  * Install Type
10511
10511
  */
10512
- 'installType': TcxWizardModelInstallTypeEnum;
10512
+ 'installType'?: TcxWizardModelInstallTypeEnum | null;
10513
10513
  'backup'?: TcxBackupModel | null;
10514
- 'extensions': Array<TcxExtsEntity>;
10515
- 'numbers': Array<TcxNumbersEntity>;
10514
+ 'extensions'?: Array<TcxExtsEntity> | null;
10515
+ 'numbers'?: Array<TcxNumbersEntity> | null;
10516
10516
  'officeHours'?: TcxOfficeHoursEntity | null;
10517
- 'phones': Array<TcxPhoneModel>;
10518
- 'sbcs': Array<TcxSbcModel>;
10517
+ 'phones'?: Array<TcxPhoneModel> | null;
10518
+ 'sbcs'?: Array<TcxSbcModel> | null;
10519
10519
  'sipTrunk'?: TcxSipTrunksEntity | null;
10520
10520
  'installationStatus'?: TcxWizardModelInstallationStatusEnum | null;
10521
10521
  'setup'?: TcxSetupEntity | null;
10522
10522
  /**
10523
10523
  * End User Wizard View
10524
10524
  */
10525
- 'endUserView': boolean;
10525
+ 'endUserView'?: boolean | null;
10526
10526
  }
10527
10527
  export declare const TcxWizardModelInstallTypeEnum: {
10528
10528
  readonly New: "new";
@@ -6,14 +6,14 @@
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [default to undefined]
10
- **extNo** | **string** | Extension Number | [default to undefined]
11
- **firstName** | **string** | First Name | [default to undefined]
12
- **lastName** | **string** | Last Name | [default to undefined]
13
- **email** | **string** | Email Address | [default to undefined]
14
- **ddi** | **string** | DDI | [default to undefined]
15
- **cli** | **string** | Outbound CLI | [default to undefined]
16
- **recording** | **boolean** | Recording Enabled | [default to undefined]
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **extNo** | **string** | Extension Number | [optional] [default to undefined]
11
+ **firstName** | **string** | First Name | [optional] [default to undefined]
12
+ **lastName** | **string** | Last Name | [optional] [default to undefined]
13
+ **email** | **string** | Email Address | [optional] [default to undefined]
14
+ **ddi** | **string** | DDI | [optional] [default to undefined]
15
+ **cli** | **string** | Outbound CLI | [optional] [default to undefined]
16
+ **recording** | **boolean** | Recording Enabled | [optional] [default to undefined]
17
17
 
18
18
  ## Example
19
19
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [default to undefined]
10
- **number** | **string** | Number | [default to undefined]
11
- **label** | **string** | Label | [default to undefined]
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **number** | **string** | Number | [optional] [default to undefined]
11
+ **label** | **string** | Label | [optional] [default to undefined]
12
12
 
13
13
  ## Example
14
14