yellowgrid-api-ts 3.2.90 → 3.2.91
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/.openapi-generator/FILES +1 -1
- package/README.md +4 -1
- package/api.ts +248 -63
- package/dist/api.d.ts +136 -62
- package/dist/api.js +261 -6
- package/docs/Class3CXInstallationsApi.md +175 -4
- package/docs/RemoteStorageDTO.md +27 -0
- package/package.json +1 -1
- package/docs/TcxInstallationDetailsModel.md +0 -45
package/dist/api.d.ts
CHANGED
|
@@ -4387,6 +4387,27 @@ export interface RecordingsBackupInfoDTO {
|
|
|
4387
4387
|
'backup'?: RecordingBackupAzureModel | null;
|
|
4388
4388
|
'storage'?: TcxRemoteStorageModel | null;
|
|
4389
4389
|
}
|
|
4390
|
+
/**
|
|
4391
|
+
* Remote Storage
|
|
4392
|
+
*/
|
|
4393
|
+
export interface RemoteStorageDTO {
|
|
4394
|
+
/**
|
|
4395
|
+
* AWS ID
|
|
4396
|
+
*/
|
|
4397
|
+
'id'?: string;
|
|
4398
|
+
/**
|
|
4399
|
+
* AWS Secret
|
|
4400
|
+
*/
|
|
4401
|
+
'secret'?: string;
|
|
4402
|
+
/**
|
|
4403
|
+
* AWS Bucket Name
|
|
4404
|
+
*/
|
|
4405
|
+
'name'?: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* AWS Region
|
|
4408
|
+
*/
|
|
4409
|
+
'region'?: string;
|
|
4410
|
+
}
|
|
4390
4411
|
/**
|
|
4391
4412
|
* Resource Not Ready
|
|
4392
4413
|
*/
|
|
@@ -6392,57 +6413,6 @@ export interface TcxHostingPricingEntity {
|
|
|
6392
6413
|
*/
|
|
6393
6414
|
'highScDiscount'?: number;
|
|
6394
6415
|
}
|
|
6395
|
-
/**
|
|
6396
|
-
* 3CX Installation Details
|
|
6397
|
-
*/
|
|
6398
|
-
export interface TcxInstallationDetailsModel {
|
|
6399
|
-
/**
|
|
6400
|
-
* PBX IP Address
|
|
6401
|
-
*/
|
|
6402
|
-
'ipAddress'?: string | null;
|
|
6403
|
-
/**
|
|
6404
|
-
* Instance ID
|
|
6405
|
-
*/
|
|
6406
|
-
'instanceId'?: string | null;
|
|
6407
|
-
/**
|
|
6408
|
-
* Project ID
|
|
6409
|
-
*/
|
|
6410
|
-
'project'?: string | null;
|
|
6411
|
-
'privateKey'?: GenericFileModel | null;
|
|
6412
|
-
/**
|
|
6413
|
-
* Root Password
|
|
6414
|
-
*/
|
|
6415
|
-
'rootPassword'?: string | null;
|
|
6416
|
-
'ownerExtension'?: TcxUsersEntity | null;
|
|
6417
|
-
/**
|
|
6418
|
-
* Admin Email
|
|
6419
|
-
*/
|
|
6420
|
-
'adminEmail'?: string | null;
|
|
6421
|
-
/**
|
|
6422
|
-
* Console URL
|
|
6423
|
-
*/
|
|
6424
|
-
'url'?: string | null;
|
|
6425
|
-
/**
|
|
6426
|
-
* Admin Username
|
|
6427
|
-
*/
|
|
6428
|
-
'adminUsername'?: string | null;
|
|
6429
|
-
/**
|
|
6430
|
-
* Admin Password
|
|
6431
|
-
*/
|
|
6432
|
-
'adminPassword'?: string | null;
|
|
6433
|
-
/**
|
|
6434
|
-
* Config Backup FTP Host
|
|
6435
|
-
*/
|
|
6436
|
-
'ftpHost'?: string | null;
|
|
6437
|
-
/**
|
|
6438
|
-
* Config Backup FTP Username
|
|
6439
|
-
*/
|
|
6440
|
-
'ftpUsername'?: string | null;
|
|
6441
|
-
/**
|
|
6442
|
-
* Config Backup FTP Password
|
|
6443
|
-
*/
|
|
6444
|
-
'ftpPassword'?: string | null;
|
|
6445
|
-
}
|
|
6446
6416
|
/**
|
|
6447
6417
|
* 3CX Installation
|
|
6448
6418
|
*/
|
|
@@ -9713,11 +9683,11 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
|
|
|
9713
9683
|
* @summary Extend additional disk on 3CX Instance
|
|
9714
9684
|
* @param {string} instanceId Instance ID
|
|
9715
9685
|
* @param {number} gigabytes Disk Space (GB)
|
|
9716
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
9686
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
9717
9687
|
* @param {*} [options] Override http request option.
|
|
9718
9688
|
* @throws {RequiredError}
|
|
9719
9689
|
*/
|
|
9720
|
-
postExtendDisk: (instanceId: string, gigabytes: number, schedule
|
|
9690
|
+
postExtendDisk: (instanceId: string, gigabytes: number, schedule?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9721
9691
|
/**
|
|
9722
9692
|
* Failover 3CX Instance
|
|
9723
9693
|
* @summary Failover 3CX Instance
|
|
@@ -9753,6 +9723,24 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
|
|
|
9753
9723
|
* @throws {RequiredError}
|
|
9754
9724
|
*/
|
|
9755
9725
|
postResizeInstance: (instanceId: string, size: PostResizeInstanceSizeEnum, schedule?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9726
|
+
/**
|
|
9727
|
+
* Restart 3CX Services
|
|
9728
|
+
* @summary Restart 3CX Services
|
|
9729
|
+
* @param {string} instanceId Instance ID
|
|
9730
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
9731
|
+
* @param {*} [options] Override http request option.
|
|
9732
|
+
* @throws {RequiredError}
|
|
9733
|
+
*/
|
|
9734
|
+
postRestartServices: (instanceId: string, schedule?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9735
|
+
/**
|
|
9736
|
+
* Reboot Instance
|
|
9737
|
+
* @summary Reboot Instance
|
|
9738
|
+
* @param {string} instanceId Instance ID
|
|
9739
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
9740
|
+
* @param {*} [options] Override http request option.
|
|
9741
|
+
* @throws {RequiredError}
|
|
9742
|
+
*/
|
|
9743
|
+
postScheduledReboot: (instanceId: string, schedule?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9756
9744
|
/**
|
|
9757
9745
|
* Suspend 3CX Instance
|
|
9758
9746
|
* @summary Suspend 3CX Instance
|
|
@@ -9762,6 +9750,14 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
|
|
|
9762
9750
|
* @throws {RequiredError}
|
|
9763
9751
|
*/
|
|
9764
9752
|
postSuspendInstance: (instanceId: string, schedule?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9753
|
+
/**
|
|
9754
|
+
* Test 3CX Login Credentials
|
|
9755
|
+
* @summary Test 3CX Login Credentials
|
|
9756
|
+
* @param {string} instanceId Instance ID
|
|
9757
|
+
* @param {*} [options] Override http request option.
|
|
9758
|
+
* @throws {RequiredError}
|
|
9759
|
+
*/
|
|
9760
|
+
postTestLoginCredentials: (instanceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9765
9761
|
/**
|
|
9766
9762
|
* Unsuspend 3CX Instance
|
|
9767
9763
|
* @summary Unsuspend 3CX Instance
|
|
@@ -9791,7 +9787,7 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
|
|
|
9791
9787
|
* @param {*} [options] Override http request option.
|
|
9792
9788
|
* @throws {RequiredError}
|
|
9793
9789
|
*/
|
|
9794
|
-
getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9790
|
+
getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
9795
9791
|
/**
|
|
9796
9792
|
* Get 3CX Installations
|
|
9797
9793
|
* @summary Get 3CX Installations
|
|
@@ -9856,11 +9852,11 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
|
|
|
9856
9852
|
* @summary Extend additional disk on 3CX Instance
|
|
9857
9853
|
* @param {string} instanceId Instance ID
|
|
9858
9854
|
* @param {number} gigabytes Disk Space (GB)
|
|
9859
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
9855
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
9860
9856
|
* @param {*} [options] Override http request option.
|
|
9861
9857
|
* @throws {RequiredError}
|
|
9862
9858
|
*/
|
|
9863
|
-
postExtendDisk(instanceId: string, gigabytes: number, schedule
|
|
9859
|
+
postExtendDisk(instanceId: string, gigabytes: number, schedule?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9864
9860
|
/**
|
|
9865
9861
|
* Failover 3CX Instance
|
|
9866
9862
|
* @summary Failover 3CX Instance
|
|
@@ -9896,6 +9892,24 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
|
|
|
9896
9892
|
* @throws {RequiredError}
|
|
9897
9893
|
*/
|
|
9898
9894
|
postResizeInstance(instanceId: string, size: PostResizeInstanceSizeEnum, schedule?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9895
|
+
/**
|
|
9896
|
+
* Restart 3CX Services
|
|
9897
|
+
* @summary Restart 3CX Services
|
|
9898
|
+
* @param {string} instanceId Instance ID
|
|
9899
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
9900
|
+
* @param {*} [options] Override http request option.
|
|
9901
|
+
* @throws {RequiredError}
|
|
9902
|
+
*/
|
|
9903
|
+
postRestartServices(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9904
|
+
/**
|
|
9905
|
+
* Reboot Instance
|
|
9906
|
+
* @summary Reboot Instance
|
|
9907
|
+
* @param {string} instanceId Instance ID
|
|
9908
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
9909
|
+
* @param {*} [options] Override http request option.
|
|
9910
|
+
* @throws {RequiredError}
|
|
9911
|
+
*/
|
|
9912
|
+
postScheduledReboot(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9899
9913
|
/**
|
|
9900
9914
|
* Suspend 3CX Instance
|
|
9901
9915
|
* @summary Suspend 3CX Instance
|
|
@@ -9905,6 +9919,14 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
|
|
|
9905
9919
|
* @throws {RequiredError}
|
|
9906
9920
|
*/
|
|
9907
9921
|
postSuspendInstance(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9922
|
+
/**
|
|
9923
|
+
* Test 3CX Login Credentials
|
|
9924
|
+
* @summary Test 3CX Login Credentials
|
|
9925
|
+
* @param {string} instanceId Instance ID
|
|
9926
|
+
* @param {*} [options] Override http request option.
|
|
9927
|
+
* @throws {RequiredError}
|
|
9928
|
+
*/
|
|
9929
|
+
postTestLoginCredentials(instanceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9908
9930
|
/**
|
|
9909
9931
|
* Unsuspend 3CX Instance
|
|
9910
9932
|
* @summary Unsuspend 3CX Instance
|
|
@@ -9934,7 +9956,7 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
|
|
|
9934
9956
|
* @param {*} [options] Override http request option.
|
|
9935
9957
|
* @throws {RequiredError}
|
|
9936
9958
|
*/
|
|
9937
|
-
getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
9959
|
+
getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
9938
9960
|
/**
|
|
9939
9961
|
* Get 3CX Installations
|
|
9940
9962
|
* @summary Get 3CX Installations
|
|
@@ -9999,11 +10021,11 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
|
|
|
9999
10021
|
* @summary Extend additional disk on 3CX Instance
|
|
10000
10022
|
* @param {string} instanceId Instance ID
|
|
10001
10023
|
* @param {number} gigabytes Disk Space (GB)
|
|
10002
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
10024
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
10003
10025
|
* @param {*} [options] Override http request option.
|
|
10004
10026
|
* @throws {RequiredError}
|
|
10005
10027
|
*/
|
|
10006
|
-
postExtendDisk(instanceId: string, gigabytes: number, schedule
|
|
10028
|
+
postExtendDisk(instanceId: string, gigabytes: number, schedule?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10007
10029
|
/**
|
|
10008
10030
|
* Failover 3CX Instance
|
|
10009
10031
|
* @summary Failover 3CX Instance
|
|
@@ -10039,6 +10061,24 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
|
|
|
10039
10061
|
* @throws {RequiredError}
|
|
10040
10062
|
*/
|
|
10041
10063
|
postResizeInstance(instanceId: string, size: PostResizeInstanceSizeEnum, schedule?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10064
|
+
/**
|
|
10065
|
+
* Restart 3CX Services
|
|
10066
|
+
* @summary Restart 3CX Services
|
|
10067
|
+
* @param {string} instanceId Instance ID
|
|
10068
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
10069
|
+
* @param {*} [options] Override http request option.
|
|
10070
|
+
* @throws {RequiredError}
|
|
10071
|
+
*/
|
|
10072
|
+
postRestartServices(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10073
|
+
/**
|
|
10074
|
+
* Reboot Instance
|
|
10075
|
+
* @summary Reboot Instance
|
|
10076
|
+
* @param {string} instanceId Instance ID
|
|
10077
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
10078
|
+
* @param {*} [options] Override http request option.
|
|
10079
|
+
* @throws {RequiredError}
|
|
10080
|
+
*/
|
|
10081
|
+
postScheduledReboot(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10042
10082
|
/**
|
|
10043
10083
|
* Suspend 3CX Instance
|
|
10044
10084
|
* @summary Suspend 3CX Instance
|
|
@@ -10048,6 +10088,14 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
|
|
|
10048
10088
|
* @throws {RequiredError}
|
|
10049
10089
|
*/
|
|
10050
10090
|
postSuspendInstance(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10091
|
+
/**
|
|
10092
|
+
* Test 3CX Login Credentials
|
|
10093
|
+
* @summary Test 3CX Login Credentials
|
|
10094
|
+
* @param {string} instanceId Instance ID
|
|
10095
|
+
* @param {*} [options] Override http request option.
|
|
10096
|
+
* @throws {RequiredError}
|
|
10097
|
+
*/
|
|
10098
|
+
postTestLoginCredentials(instanceId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10051
10099
|
/**
|
|
10052
10100
|
* Unsuspend 3CX Instance
|
|
10053
10101
|
* @summary Unsuspend 3CX Instance
|
|
@@ -10077,7 +10125,7 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
|
|
|
10077
10125
|
* @param {*} [options] Override http request option.
|
|
10078
10126
|
* @throws {RequiredError}
|
|
10079
10127
|
*/
|
|
10080
|
-
getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
10128
|
+
getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
10081
10129
|
/**
|
|
10082
10130
|
* Get 3CX Installations
|
|
10083
10131
|
* @summary Get 3CX Installations
|
|
@@ -10142,11 +10190,11 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
|
|
|
10142
10190
|
* @summary Extend additional disk on 3CX Instance
|
|
10143
10191
|
* @param {string} instanceId Instance ID
|
|
10144
10192
|
* @param {number} gigabytes Disk Space (GB)
|
|
10145
|
-
* @param {string} schedule Scheduled Task (Date & Time)
|
|
10193
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
10146
10194
|
* @param {*} [options] Override http request option.
|
|
10147
10195
|
* @throws {RequiredError}
|
|
10148
10196
|
*/
|
|
10149
|
-
postExtendDisk(instanceId: string, gigabytes: number, schedule
|
|
10197
|
+
postExtendDisk(instanceId: string, gigabytes: number, schedule?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10150
10198
|
/**
|
|
10151
10199
|
* Failover 3CX Instance
|
|
10152
10200
|
* @summary Failover 3CX Instance
|
|
@@ -10182,6 +10230,24 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
|
|
|
10182
10230
|
* @throws {RequiredError}
|
|
10183
10231
|
*/
|
|
10184
10232
|
postResizeInstance(instanceId: string, size: PostResizeInstanceSizeEnum, schedule?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10233
|
+
/**
|
|
10234
|
+
* Restart 3CX Services
|
|
10235
|
+
* @summary Restart 3CX Services
|
|
10236
|
+
* @param {string} instanceId Instance ID
|
|
10237
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
10238
|
+
* @param {*} [options] Override http request option.
|
|
10239
|
+
* @throws {RequiredError}
|
|
10240
|
+
*/
|
|
10241
|
+
postRestartServices(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10242
|
+
/**
|
|
10243
|
+
* Reboot Instance
|
|
10244
|
+
* @summary Reboot Instance
|
|
10245
|
+
* @param {string} instanceId Instance ID
|
|
10246
|
+
* @param {string} [schedule] Scheduled Task (Date & Time)
|
|
10247
|
+
* @param {*} [options] Override http request option.
|
|
10248
|
+
* @throws {RequiredError}
|
|
10249
|
+
*/
|
|
10250
|
+
postScheduledReboot(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10185
10251
|
/**
|
|
10186
10252
|
* Suspend 3CX Instance
|
|
10187
10253
|
* @summary Suspend 3CX Instance
|
|
@@ -10191,6 +10257,14 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
|
|
|
10191
10257
|
* @throws {RequiredError}
|
|
10192
10258
|
*/
|
|
10193
10259
|
postSuspendInstance(instanceId: string, schedule?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10260
|
+
/**
|
|
10261
|
+
* Test 3CX Login Credentials
|
|
10262
|
+
* @summary Test 3CX Login Credentials
|
|
10263
|
+
* @param {string} instanceId Instance ID
|
|
10264
|
+
* @param {*} [options] Override http request option.
|
|
10265
|
+
* @throws {RequiredError}
|
|
10266
|
+
*/
|
|
10267
|
+
postTestLoginCredentials(instanceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
10194
10268
|
/**
|
|
10195
10269
|
* Unsuspend 3CX Instance
|
|
10196
10270
|
* @summary Unsuspend 3CX Instance
|