yellowgrid-api-ts 3.2.91 → 3.2.92

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.
@@ -83,6 +83,7 @@ docs/GetGetPrice200Response.md
83
83
  docs/GetGetRecording200Response.md
84
84
  docs/HostingChangeResponseModel.md
85
85
  docs/HostingRegionDTO.md
86
+ docs/InstallationDetailsDTO.md
86
87
  docs/InstanceAutoFailoverEntity.md
87
88
  docs/InstanceDeletionScheduleEntity.md
88
89
  docs/InstanceEntity.md
package/README.md CHANGED
@@ -347,6 +347,7 @@ Class | Method | HTTP request | Description
347
347
  - [GetGetRecording200Response](docs/GetGetRecording200Response.md)
348
348
  - [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
349
349
  - [HostingRegionDTO](docs/HostingRegionDTO.md)
350
+ - [InstallationDetailsDTO](docs/InstallationDetailsDTO.md)
350
351
  - [InstanceAutoFailoverEntity](docs/InstanceAutoFailoverEntity.md)
351
352
  - [InstanceDeletionScheduleEntity](docs/InstanceDeletionScheduleEntity.md)
352
353
  - [InstanceEntity](docs/InstanceEntity.md)
package/api.ts CHANGED
@@ -2289,6 +2289,38 @@ export const HostingRegionDTOCodeEnum = {
2289
2289
 
2290
2290
  export type HostingRegionDTOCodeEnum = typeof HostingRegionDTOCodeEnum[keyof typeof HostingRegionDTOCodeEnum];
2291
2291
 
2292
+ /**
2293
+ * Installation Passwords
2294
+ */
2295
+ export interface InstallationDetailsDTO {
2296
+ /**
2297
+ * PBX IP Address
2298
+ */
2299
+ 'ipAddress'?: string | null;
2300
+ /**
2301
+ * Instance ID
2302
+ */
2303
+ 'instanceId'?: string | null;
2304
+ /**
2305
+ * Project ID
2306
+ */
2307
+ 'project'?: string | null;
2308
+ 'sshKey'?: GenericFileModel;
2309
+ /**
2310
+ * Root Password
2311
+ */
2312
+ 'osPassword'?: string | null;
2313
+ 'systemOwner'?: TcxUsersEntity;
2314
+ /**
2315
+ * Admin Email
2316
+ */
2317
+ 'email'?: string | null;
2318
+ /**
2319
+ * 3CX Console URL
2320
+ */
2321
+ 'url'?: string | null;
2322
+ 'backup'?: RemoteStorageDTO;
2323
+ }
2292
2324
  /**
2293
2325
  * InstanceFailoverIpsEntity
2294
2326
  */
@@ -12548,7 +12580,7 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
12548
12580
  * @param {*} [options] Override http request option.
12549
12581
  * @throws {RequiredError}
12550
12582
  */
12551
- async getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
12583
+ async getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstallationDetailsDTO>> {
12552
12584
  const localVarAxiosArgs = await localVarAxiosParamCreator.getGetDetails(wizardId, options);
12553
12585
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12554
12586
  const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.getGetDetails']?.[localVarOperationServerIndex]?.url;
@@ -12811,7 +12843,7 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
12811
12843
  * @param {*} [options] Override http request option.
12812
12844
  * @throws {RequiredError}
12813
12845
  */
12814
- getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): AxiosPromise<any> {
12846
+ getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): AxiosPromise<InstallationDetailsDTO> {
12815
12847
  return localVarFp.getGetDetails(wizardId, options).then((request) => request(axios, basePath));
12816
12848
  },
12817
12849
  /**
package/dist/api.d.ts CHANGED
@@ -2260,6 +2260,38 @@ export declare const HostingRegionDTOCodeEnum: {
2260
2260
  readonly UsWestOr1: "US-WEST-OR-1";
2261
2261
  };
2262
2262
  export type HostingRegionDTOCodeEnum = typeof HostingRegionDTOCodeEnum[keyof typeof HostingRegionDTOCodeEnum];
2263
+ /**
2264
+ * Installation Passwords
2265
+ */
2266
+ export interface InstallationDetailsDTO {
2267
+ /**
2268
+ * PBX IP Address
2269
+ */
2270
+ 'ipAddress'?: string | null;
2271
+ /**
2272
+ * Instance ID
2273
+ */
2274
+ 'instanceId'?: string | null;
2275
+ /**
2276
+ * Project ID
2277
+ */
2278
+ 'project'?: string | null;
2279
+ 'sshKey'?: GenericFileModel;
2280
+ /**
2281
+ * Root Password
2282
+ */
2283
+ 'osPassword'?: string | null;
2284
+ 'systemOwner'?: TcxUsersEntity;
2285
+ /**
2286
+ * Admin Email
2287
+ */
2288
+ 'email'?: string | null;
2289
+ /**
2290
+ * 3CX Console URL
2291
+ */
2292
+ 'url'?: string | null;
2293
+ 'backup'?: RemoteStorageDTO;
2294
+ }
2263
2295
  /**
2264
2296
  * InstanceFailoverIpsEntity
2265
2297
  */
@@ -9787,7 +9819,7 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
9787
9819
  * @param {*} [options] Override http request option.
9788
9820
  * @throws {RequiredError}
9789
9821
  */
9790
- getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
9822
+ getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstallationDetailsDTO>>;
9791
9823
  /**
9792
9824
  * Get 3CX Installations
9793
9825
  * @summary Get 3CX Installations
@@ -9956,7 +9988,7 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
9956
9988
  * @param {*} [options] Override http request option.
9957
9989
  * @throws {RequiredError}
9958
9990
  */
9959
- getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): AxiosPromise<any>;
9991
+ getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): AxiosPromise<InstallationDetailsDTO>;
9960
9992
  /**
9961
9993
  * Get 3CX Installations
9962
9994
  * @summary Get 3CX Installations
@@ -10125,7 +10157,7 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
10125
10157
  * @param {*} [options] Override http request option.
10126
10158
  * @throws {RequiredError}
10127
10159
  */
10128
- getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
10160
+ getGetDetails(wizardId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InstallationDetailsDTO, any, {}>>;
10129
10161
  /**
10130
10162
  * Get 3CX Installations
10131
10163
  * @summary Get 3CX Installations
@@ -24,7 +24,7 @@ All URIs are relative to *https://bitbucket.org*
24
24
  |[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
25
25
 
26
26
  # **getGetDetails**
27
- > any getGetDetails()
27
+ > InstallationDetailsDTO getGetDetails()
28
28
 
29
29
  Get 3CX Installation Details
30
30
 
@@ -55,7 +55,7 @@ const { status, data } = await apiInstance.getGetDetails(
55
55
 
56
56
  ### Return type
57
57
 
58
- **any**
58
+ **InstallationDetailsDTO**
59
59
 
60
60
  ### Authorization
61
61
 
@@ -0,0 +1,37 @@
1
+ # InstallationDetailsDTO
2
+
3
+ Installation Passwords
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
10
+ **instanceId** | **string** | Instance ID | [optional] [default to undefined]
11
+ **project** | **string** | Project ID | [optional] [default to undefined]
12
+ **sshKey** | [**GenericFileModel**](GenericFileModel.md) | | [optional] [default to undefined]
13
+ **osPassword** | **string** | Root Password | [optional] [default to undefined]
14
+ **systemOwner** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [optional] [default to undefined]
15
+ **email** | **string** | Admin Email | [optional] [default to undefined]
16
+ **url** | **string** | 3CX Console URL | [optional] [default to undefined]
17
+ **backup** | [**RemoteStorageDTO**](RemoteStorageDTO.md) | | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { InstallationDetailsDTO } from 'yellowgrid-api-ts';
23
+
24
+ const instance: InstallationDetailsDTO = {
25
+ ipAddress,
26
+ instanceId,
27
+ project,
28
+ sshKey,
29
+ osPassword,
30
+ systemOwner,
31
+ email,
32
+ url,
33
+ backup,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.91",
3
+ "version": "3.2.92",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {