yellowgrid-api-ts 3.2.125-dev.0 → 3.2.126-dev.0
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 -0
- package/README.md +2 -0
- package/api.ts +93 -2
- package/dist/api.d.ts +56 -3
- package/dist/api.js +88 -0
- package/docs/AdminUserModel.md +2 -0
- package/docs/CRMApi.md +2 -2
- package/docs/Class3CXInstallationsApi.md +59 -0
- package/docs/CrmActivitiesResponseDto.md +23 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/README.md
CHANGED
|
@@ -137,6 +137,7 @@ Class | Method | HTTP request | Description
|
|
|
137
137
|
*Class3CXInstallationsApi* | [**postTestLoginCredentials**](docs/Class3CXInstallationsApi.md#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials
|
|
138
138
|
*Class3CXInstallationsApi* | [**postUnsuspendInstance**](docs/Class3CXInstallationsApi.md#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance
|
|
139
139
|
*Class3CXInstallationsApi* | [**postUpgradeDebian**](docs/Class3CXInstallationsApi.md#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance
|
|
140
|
+
*Class3CXInstallationsApi* | [**putGetDetails**](docs/Class3CXInstallationsApi.md#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details
|
|
140
141
|
*Class3CXIntegrationsApi* | [**getGetPrice**](docs/Class3CXIntegrationsApi.md#getgetprice) | **GET** /tcx/integrations/edtechpro/prices |
|
|
141
142
|
*Class3CXIntegrationsApi* | [**getGetSchools**](docs/Class3CXIntegrationsApi.md#getgetschools) | **GET** /tcx/integrations/edtechpro/schools |
|
|
142
143
|
*Class3CXIntegrationsApi* | [**getGetTrusts**](docs/Class3CXIntegrationsApi.md#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts |
|
|
@@ -330,6 +331,7 @@ Class | Method | HTTP request | Description
|
|
|
330
331
|
- [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
|
|
331
332
|
- [CreditNoteItemModel](docs/CreditNoteItemModel.md)
|
|
332
333
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
334
|
+
- [CrmActivitiesResponseDto](docs/CrmActivitiesResponseDto.md)
|
|
333
335
|
- [CrmActivityDto](docs/CrmActivityDto.md)
|
|
334
336
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
335
337
|
- [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
|
package/api.ts
CHANGED
|
@@ -660,6 +660,10 @@ export interface AdminOrderRequestDTO {
|
|
|
660
660
|
* Admin User
|
|
661
661
|
*/
|
|
662
662
|
export interface AdminUserModel {
|
|
663
|
+
/**
|
|
664
|
+
* ID
|
|
665
|
+
*/
|
|
666
|
+
'id'?: number;
|
|
663
667
|
/**
|
|
664
668
|
* First Name
|
|
665
669
|
*/
|
|
@@ -1598,6 +1602,19 @@ export interface CreditNoteModel {
|
|
|
1598
1602
|
*/
|
|
1599
1603
|
'items'?: Array<CreditNoteItemModel>;
|
|
1600
1604
|
}
|
|
1605
|
+
/**
|
|
1606
|
+
* CRM Activities Response
|
|
1607
|
+
*/
|
|
1608
|
+
export interface CrmActivitiesResponseDto {
|
|
1609
|
+
/**
|
|
1610
|
+
* Dates
|
|
1611
|
+
*/
|
|
1612
|
+
'dates'?: Array<CrmDateActivitiesDTO>;
|
|
1613
|
+
/**
|
|
1614
|
+
* Agents
|
|
1615
|
+
*/
|
|
1616
|
+
'agents'?: Array<AdminUserModel>;
|
|
1617
|
+
}
|
|
1601
1618
|
/**
|
|
1602
1619
|
* CRM Activity
|
|
1603
1620
|
*/
|
|
@@ -10259,7 +10276,7 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10259
10276
|
* @param {*} [options] Override http request option.
|
|
10260
10277
|
* @throws {RequiredError}
|
|
10261
10278
|
*/
|
|
10262
|
-
async getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10279
|
+
async getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDto>> {
|
|
10263
10280
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options);
|
|
10264
10281
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10265
10282
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.getGetCrmActivities']?.[localVarOperationServerIndex]?.url;
|
|
@@ -10306,7 +10323,7 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10306
10323
|
* @param {*} [options] Override http request option.
|
|
10307
10324
|
* @throws {RequiredError}
|
|
10308
10325
|
*/
|
|
10309
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10326
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDto> {
|
|
10310
10327
|
return localVarFp.getGetCrmActivities(id, type, userId, options).then((request) => request(axios, basePath));
|
|
10311
10328
|
},
|
|
10312
10329
|
/**
|
|
@@ -13652,6 +13669,43 @@ export const Class3CXInstallationsApiAxiosParamCreator = function (configuration
|
|
|
13652
13669
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13653
13670
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13654
13671
|
|
|
13672
|
+
return {
|
|
13673
|
+
url: toPathString(localVarUrlObj),
|
|
13674
|
+
options: localVarRequestOptions,
|
|
13675
|
+
};
|
|
13676
|
+
},
|
|
13677
|
+
/**
|
|
13678
|
+
* Update 3CX Installation Details
|
|
13679
|
+
* @summary Update 3CX Installation Details
|
|
13680
|
+
* @param {number} wizardId Wizard ID
|
|
13681
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
13682
|
+
* @param {*} [options] Override http request option.
|
|
13683
|
+
* @throws {RequiredError}
|
|
13684
|
+
*/
|
|
13685
|
+
putGetDetails: async (wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13686
|
+
// verify required parameter 'wizardId' is not null or undefined
|
|
13687
|
+
assertParamExists('putGetDetails', 'wizardId', wizardId)
|
|
13688
|
+
const localVarPath = `/tcx/installations/{wizard_id}/details`
|
|
13689
|
+
.replace(`{${"wizard_id"}}`, encodeURIComponent(String(wizardId)));
|
|
13690
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13691
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13692
|
+
let baseOptions;
|
|
13693
|
+
if (configuration) {
|
|
13694
|
+
baseOptions = configuration.baseOptions;
|
|
13695
|
+
}
|
|
13696
|
+
|
|
13697
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
13698
|
+
const localVarHeaderParameter = {} as any;
|
|
13699
|
+
const localVarQueryParameter = {} as any;
|
|
13700
|
+
|
|
13701
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13702
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
13703
|
+
|
|
13704
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13705
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13706
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
13707
|
+
localVarRequestOptions.data = serializeDataIfNeeded(installationDetailsDTO, localVarRequestOptions, configuration)
|
|
13708
|
+
|
|
13655
13709
|
return {
|
|
13656
13710
|
url: toPathString(localVarUrlObj),
|
|
13657
13711
|
options: localVarRequestOptions,
|
|
@@ -13920,6 +13974,20 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
|
|
|
13920
13974
|
const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.postUpgradeDebian']?.[localVarOperationServerIndex]?.url;
|
|
13921
13975
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13922
13976
|
},
|
|
13977
|
+
/**
|
|
13978
|
+
* Update 3CX Installation Details
|
|
13979
|
+
* @summary Update 3CX Installation Details
|
|
13980
|
+
* @param {number} wizardId Wizard ID
|
|
13981
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
13982
|
+
* @param {*} [options] Override http request option.
|
|
13983
|
+
* @throws {RequiredError}
|
|
13984
|
+
*/
|
|
13985
|
+
async putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstallationDetailsDTO>> {
|
|
13986
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.putGetDetails(wizardId, installationDetailsDTO, options);
|
|
13987
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13988
|
+
const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.putGetDetails']?.[localVarOperationServerIndex]?.url;
|
|
13989
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13990
|
+
},
|
|
13923
13991
|
}
|
|
13924
13992
|
};
|
|
13925
13993
|
|
|
@@ -14129,6 +14197,17 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
|
|
|
14129
14197
|
postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
14130
14198
|
return localVarFp.postUpgradeDebian(instanceId, schedule, options).then((request) => request(axios, basePath));
|
|
14131
14199
|
},
|
|
14200
|
+
/**
|
|
14201
|
+
* Update 3CX Installation Details
|
|
14202
|
+
* @summary Update 3CX Installation Details
|
|
14203
|
+
* @param {number} wizardId Wizard ID
|
|
14204
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
14205
|
+
* @param {*} [options] Override http request option.
|
|
14206
|
+
* @throws {RequiredError}
|
|
14207
|
+
*/
|
|
14208
|
+
putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): AxiosPromise<InstallationDetailsDTO> {
|
|
14209
|
+
return localVarFp.putGetDetails(wizardId, installationDetailsDTO, options).then((request) => request(axios, basePath));
|
|
14210
|
+
},
|
|
14132
14211
|
};
|
|
14133
14212
|
};
|
|
14134
14213
|
|
|
@@ -14353,6 +14432,18 @@ export class Class3CXInstallationsApi extends BaseAPI {
|
|
|
14353
14432
|
public postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig) {
|
|
14354
14433
|
return Class3CXInstallationsApiFp(this.configuration).postUpgradeDebian(instanceId, schedule, options).then((request) => request(this.axios, this.basePath));
|
|
14355
14434
|
}
|
|
14435
|
+
|
|
14436
|
+
/**
|
|
14437
|
+
* Update 3CX Installation Details
|
|
14438
|
+
* @summary Update 3CX Installation Details
|
|
14439
|
+
* @param {number} wizardId Wizard ID
|
|
14440
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
14441
|
+
* @param {*} [options] Override http request option.
|
|
14442
|
+
* @throws {RequiredError}
|
|
14443
|
+
*/
|
|
14444
|
+
public putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig) {
|
|
14445
|
+
return Class3CXInstallationsApiFp(this.configuration).putGetDetails(wizardId, installationDetailsDTO, options).then((request) => request(this.axios, this.basePath));
|
|
14446
|
+
}
|
|
14356
14447
|
}
|
|
14357
14448
|
|
|
14358
14449
|
export const GetGetInstallationsStatusEnum = {
|
package/dist/api.d.ts
CHANGED
|
@@ -650,6 +650,10 @@ export interface AdminOrderRequestDTO {
|
|
|
650
650
|
* Admin User
|
|
651
651
|
*/
|
|
652
652
|
export interface AdminUserModel {
|
|
653
|
+
/**
|
|
654
|
+
* ID
|
|
655
|
+
*/
|
|
656
|
+
'id'?: number;
|
|
653
657
|
/**
|
|
654
658
|
* First Name
|
|
655
659
|
*/
|
|
@@ -1581,6 +1585,19 @@ export interface CreditNoteModel {
|
|
|
1581
1585
|
*/
|
|
1582
1586
|
'items'?: Array<CreditNoteItemModel>;
|
|
1583
1587
|
}
|
|
1588
|
+
/**
|
|
1589
|
+
* CRM Activities Response
|
|
1590
|
+
*/
|
|
1591
|
+
export interface CrmActivitiesResponseDto {
|
|
1592
|
+
/**
|
|
1593
|
+
* Dates
|
|
1594
|
+
*/
|
|
1595
|
+
'dates'?: Array<CrmDateActivitiesDTO>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Agents
|
|
1598
|
+
*/
|
|
1599
|
+
'agents'?: Array<AdminUserModel>;
|
|
1600
|
+
}
|
|
1584
1601
|
/**
|
|
1585
1602
|
* CRM Activity
|
|
1586
1603
|
*/
|
|
@@ -8990,7 +9007,7 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
8990
9007
|
* @param {*} [options] Override http request option.
|
|
8991
9008
|
* @throws {RequiredError}
|
|
8992
9009
|
*/
|
|
8993
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9010
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDto>>;
|
|
8994
9011
|
/**
|
|
8995
9012
|
* Search for contacts by phone number
|
|
8996
9013
|
* @param {*} [options] Override http request option.
|
|
@@ -9018,7 +9035,7 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
9018
9035
|
* @param {*} [options] Override http request option.
|
|
9019
9036
|
* @throws {RequiredError}
|
|
9020
9037
|
*/
|
|
9021
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
9038
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDto>;
|
|
9022
9039
|
/**
|
|
9023
9040
|
* Search for contacts by phone number
|
|
9024
9041
|
* @param {*} [options] Override http request option.
|
|
@@ -9046,7 +9063,7 @@ export declare class CRMApi extends BaseAPI {
|
|
|
9046
9063
|
* @param {*} [options] Override http request option.
|
|
9047
9064
|
* @throws {RequiredError}
|
|
9048
9065
|
*/
|
|
9049
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
9066
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivitiesResponseDto, any, {}>>;
|
|
9050
9067
|
/**
|
|
9051
9068
|
* Search for contacts by phone number
|
|
9052
9069
|
* @param {*} [options] Override http request option.
|
|
@@ -10447,6 +10464,15 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
|
|
|
10447
10464
|
* @throws {RequiredError}
|
|
10448
10465
|
*/
|
|
10449
10466
|
postUpgradeDebian: (instanceId: string, schedule: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10467
|
+
/**
|
|
10468
|
+
* Update 3CX Installation Details
|
|
10469
|
+
* @summary Update 3CX Installation Details
|
|
10470
|
+
* @param {number} wizardId Wizard ID
|
|
10471
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
10472
|
+
* @param {*} [options] Override http request option.
|
|
10473
|
+
* @throws {RequiredError}
|
|
10474
|
+
*/
|
|
10475
|
+
putGetDetails: (wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10450
10476
|
};
|
|
10451
10477
|
/**
|
|
10452
10478
|
* Class3CXInstallationsApi - functional programming interface
|
|
@@ -10616,6 +10642,15 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
|
|
|
10616
10642
|
* @throws {RequiredError}
|
|
10617
10643
|
*/
|
|
10618
10644
|
postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10645
|
+
/**
|
|
10646
|
+
* Update 3CX Installation Details
|
|
10647
|
+
* @summary Update 3CX Installation Details
|
|
10648
|
+
* @param {number} wizardId Wizard ID
|
|
10649
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
10650
|
+
* @param {*} [options] Override http request option.
|
|
10651
|
+
* @throws {RequiredError}
|
|
10652
|
+
*/
|
|
10653
|
+
putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstallationDetailsDTO>>;
|
|
10619
10654
|
};
|
|
10620
10655
|
/**
|
|
10621
10656
|
* Class3CXInstallationsApi - factory interface
|
|
@@ -10785,6 +10820,15 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
|
|
|
10785
10820
|
* @throws {RequiredError}
|
|
10786
10821
|
*/
|
|
10787
10822
|
postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10823
|
+
/**
|
|
10824
|
+
* Update 3CX Installation Details
|
|
10825
|
+
* @summary Update 3CX Installation Details
|
|
10826
|
+
* @param {number} wizardId Wizard ID
|
|
10827
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
10828
|
+
* @param {*} [options] Override http request option.
|
|
10829
|
+
* @throws {RequiredError}
|
|
10830
|
+
*/
|
|
10831
|
+
putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): AxiosPromise<InstallationDetailsDTO>;
|
|
10788
10832
|
};
|
|
10789
10833
|
/**
|
|
10790
10834
|
* Class3CXInstallationsApi - object-oriented interface
|
|
@@ -10954,6 +10998,15 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
|
|
|
10954
10998
|
* @throws {RequiredError}
|
|
10955
10999
|
*/
|
|
10956
11000
|
postUpgradeDebian(instanceId: string, schedule: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
11001
|
+
/**
|
|
11002
|
+
* Update 3CX Installation Details
|
|
11003
|
+
* @summary Update 3CX Installation Details
|
|
11004
|
+
* @param {number} wizardId Wizard ID
|
|
11005
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
11006
|
+
* @param {*} [options] Override http request option.
|
|
11007
|
+
* @throws {RequiredError}
|
|
11008
|
+
*/
|
|
11009
|
+
putGetDetails(wizardId: number, installationDetailsDTO?: InstallationDetailsDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InstallationDetailsDTO, any, {}>>;
|
|
10957
11010
|
}
|
|
10958
11011
|
export declare const GetGetInstallationsStatusEnum: {
|
|
10959
11012
|
readonly Completed: "Completed";
|
package/dist/api.js
CHANGED
|
@@ -6973,6 +6973,47 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
6973
6973
|
});
|
|
6974
6974
|
});
|
|
6975
6975
|
},
|
|
6976
|
+
/**
|
|
6977
|
+
* Update 3CX Installation Details
|
|
6978
|
+
* @summary Update 3CX Installation Details
|
|
6979
|
+
* @param {number} wizardId Wizard ID
|
|
6980
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
6981
|
+
* @param {*} [options] Override http request option.
|
|
6982
|
+
* @throws {RequiredError}
|
|
6983
|
+
*/
|
|
6984
|
+
putGetDetails: function (wizardId_1, installationDetailsDTO_1) {
|
|
6985
|
+
var args_1 = [];
|
|
6986
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
6987
|
+
args_1[_i - 2] = arguments[_i];
|
|
6988
|
+
}
|
|
6989
|
+
return __awaiter(_this, __spreadArray([wizardId_1, installationDetailsDTO_1], args_1, true), void 0, function (wizardId, installationDetailsDTO, options) {
|
|
6990
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
6991
|
+
if (options === void 0) { options = {}; }
|
|
6992
|
+
return __generator(this, function (_a) {
|
|
6993
|
+
// verify required parameter 'wizardId' is not null or undefined
|
|
6994
|
+
(0, common_1.assertParamExists)('putGetDetails', 'wizardId', wizardId);
|
|
6995
|
+
localVarPath = "/tcx/installations/{wizard_id}/details"
|
|
6996
|
+
.replace("{".concat("wizard_id", "}"), encodeURIComponent(String(wizardId)));
|
|
6997
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6998
|
+
if (configuration) {
|
|
6999
|
+
baseOptions = configuration.baseOptions;
|
|
7000
|
+
}
|
|
7001
|
+
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
|
|
7002
|
+
localVarHeaderParameter = {};
|
|
7003
|
+
localVarQueryParameter = {};
|
|
7004
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7005
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7006
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
7007
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7008
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7009
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(installationDetailsDTO, localVarRequestOptions, configuration);
|
|
7010
|
+
return [2 /*return*/, {
|
|
7011
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
7012
|
+
options: localVarRequestOptions,
|
|
7013
|
+
}];
|
|
7014
|
+
});
|
|
7015
|
+
});
|
|
7016
|
+
},
|
|
6976
7017
|
};
|
|
6977
7018
|
};
|
|
6978
7019
|
exports.Class3CXInstallationsApiAxiosParamCreator = Class3CXInstallationsApiAxiosParamCreator;
|
|
@@ -7416,6 +7457,30 @@ var Class3CXInstallationsApiFp = function (configuration) {
|
|
|
7416
7457
|
});
|
|
7417
7458
|
});
|
|
7418
7459
|
},
|
|
7460
|
+
/**
|
|
7461
|
+
* Update 3CX Installation Details
|
|
7462
|
+
* @summary Update 3CX Installation Details
|
|
7463
|
+
* @param {number} wizardId Wizard ID
|
|
7464
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
7465
|
+
* @param {*} [options] Override http request option.
|
|
7466
|
+
* @throws {RequiredError}
|
|
7467
|
+
*/
|
|
7468
|
+
putGetDetails: function (wizardId, installationDetailsDTO, options) {
|
|
7469
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
7470
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
7471
|
+
var _a, _b, _c;
|
|
7472
|
+
return __generator(this, function (_d) {
|
|
7473
|
+
switch (_d.label) {
|
|
7474
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.putGetDetails(wizardId, installationDetailsDTO, options)];
|
|
7475
|
+
case 1:
|
|
7476
|
+
localVarAxiosArgs = _d.sent();
|
|
7477
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7478
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXInstallationsApi.putGetDetails']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7479
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
7480
|
+
}
|
|
7481
|
+
});
|
|
7482
|
+
});
|
|
7483
|
+
},
|
|
7419
7484
|
};
|
|
7420
7485
|
};
|
|
7421
7486
|
exports.Class3CXInstallationsApiFp = Class3CXInstallationsApiFp;
|
|
@@ -7625,6 +7690,17 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
|
|
|
7625
7690
|
postUpgradeDebian: function (instanceId, schedule, options) {
|
|
7626
7691
|
return localVarFp.postUpgradeDebian(instanceId, schedule, options).then(function (request) { return request(axios, basePath); });
|
|
7627
7692
|
},
|
|
7693
|
+
/**
|
|
7694
|
+
* Update 3CX Installation Details
|
|
7695
|
+
* @summary Update 3CX Installation Details
|
|
7696
|
+
* @param {number} wizardId Wizard ID
|
|
7697
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
7698
|
+
* @param {*} [options] Override http request option.
|
|
7699
|
+
* @throws {RequiredError}
|
|
7700
|
+
*/
|
|
7701
|
+
putGetDetails: function (wizardId, installationDetailsDTO, options) {
|
|
7702
|
+
return localVarFp.putGetDetails(wizardId, installationDetailsDTO, options).then(function (request) { return request(axios, basePath); });
|
|
7703
|
+
},
|
|
7628
7704
|
};
|
|
7629
7705
|
};
|
|
7630
7706
|
exports.Class3CXInstallationsApiFactory = Class3CXInstallationsApiFactory;
|
|
@@ -7854,6 +7930,18 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
|
|
|
7854
7930
|
var _this = this;
|
|
7855
7931
|
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postUpgradeDebian(instanceId, schedule, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
7856
7932
|
};
|
|
7933
|
+
/**
|
|
7934
|
+
* Update 3CX Installation Details
|
|
7935
|
+
* @summary Update 3CX Installation Details
|
|
7936
|
+
* @param {number} wizardId Wizard ID
|
|
7937
|
+
* @param {InstallationDetailsDTO} [installationDetailsDTO] Installation Details
|
|
7938
|
+
* @param {*} [options] Override http request option.
|
|
7939
|
+
* @throws {RequiredError}
|
|
7940
|
+
*/
|
|
7941
|
+
Class3CXInstallationsApi.prototype.putGetDetails = function (wizardId, installationDetailsDTO, options) {
|
|
7942
|
+
var _this = this;
|
|
7943
|
+
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).putGetDetails(wizardId, installationDetailsDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
7944
|
+
};
|
|
7857
7945
|
return Class3CXInstallationsApi;
|
|
7858
7946
|
}(base_1.BaseAPI));
|
|
7859
7947
|
exports.Class3CXInstallationsApi = Class3CXInstallationsApi;
|
package/docs/AdminUserModel.md
CHANGED
|
@@ -6,6 +6,7 @@ Admin User
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [optional] [default to undefined]
|
|
9
10
|
**firstName** | **string** | First Name | [optional] [default to undefined]
|
|
10
11
|
**lastName** | **string** | Last Name | [optional] [default to undefined]
|
|
11
12
|
**avatar** | **string** | Avatar | [optional] [default to undefined]
|
|
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
20
21
|
import { AdminUserModel } from 'yellowgrid-api-ts';
|
|
21
22
|
|
|
22
23
|
const instance: AdminUserModel = {
|
|
24
|
+
id,
|
|
23
25
|
firstName,
|
|
24
26
|
lastName,
|
|
25
27
|
avatar,
|
package/docs/CRMApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://localhost*
|
|
|
9
9
|
|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
|
|
10
10
|
|
|
11
11
|
# **getGetCrmActivities**
|
|
12
|
-
>
|
|
12
|
+
> CrmActivitiesResponseDto getGetCrmActivities()
|
|
13
13
|
|
|
14
14
|
Get Customer CRM Activities
|
|
15
15
|
|
|
@@ -46,7 +46,7 @@ const { status, data } = await apiInstance.getGetCrmActivities(
|
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
48
48
|
|
|
49
|
-
**
|
|
49
|
+
**CrmActivitiesResponseDto**
|
|
50
50
|
|
|
51
51
|
### Authorization
|
|
52
52
|
|
|
@@ -22,6 +22,7 @@ All URIs are relative to *https://localhost*
|
|
|
22
22
|
|[**postTestLoginCredentials**](#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials|
|
|
23
23
|
|[**postUnsuspendInstance**](#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance|
|
|
24
24
|
|[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
|
|
25
|
+
|[**putGetDetails**](#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details|
|
|
25
26
|
|
|
26
27
|
# **getGetDetails**
|
|
27
28
|
> InstallationDetailsDTO getGetDetails()
|
|
@@ -1052,3 +1053,61 @@ No authorization required
|
|
|
1052
1053
|
|
|
1053
1054
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1054
1055
|
|
|
1056
|
+
# **putGetDetails**
|
|
1057
|
+
> InstallationDetailsDTO putGetDetails()
|
|
1058
|
+
|
|
1059
|
+
Update 3CX Installation Details
|
|
1060
|
+
|
|
1061
|
+
### Example
|
|
1062
|
+
|
|
1063
|
+
```typescript
|
|
1064
|
+
import {
|
|
1065
|
+
Class3CXInstallationsApi,
|
|
1066
|
+
Configuration,
|
|
1067
|
+
InstallationDetailsDTO
|
|
1068
|
+
} from 'yellowgrid-api-ts';
|
|
1069
|
+
|
|
1070
|
+
const configuration = new Configuration();
|
|
1071
|
+
const apiInstance = new Class3CXInstallationsApi(configuration);
|
|
1072
|
+
|
|
1073
|
+
let wizardId: number; //Wizard ID (default to undefined)
|
|
1074
|
+
let installationDetailsDTO: InstallationDetailsDTO; //Installation Details (optional)
|
|
1075
|
+
|
|
1076
|
+
const { status, data } = await apiInstance.putGetDetails(
|
|
1077
|
+
wizardId,
|
|
1078
|
+
installationDetailsDTO
|
|
1079
|
+
);
|
|
1080
|
+
```
|
|
1081
|
+
|
|
1082
|
+
### Parameters
|
|
1083
|
+
|
|
1084
|
+
|Name | Type | Description | Notes|
|
|
1085
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1086
|
+
| **installationDetailsDTO** | **InstallationDetailsDTO**| Installation Details | |
|
|
1087
|
+
| **wizardId** | [**number**] | Wizard ID | defaults to undefined|
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
### Return type
|
|
1091
|
+
|
|
1092
|
+
**InstallationDetailsDTO**
|
|
1093
|
+
|
|
1094
|
+
### Authorization
|
|
1095
|
+
|
|
1096
|
+
No authorization required
|
|
1097
|
+
|
|
1098
|
+
### HTTP request headers
|
|
1099
|
+
|
|
1100
|
+
- **Content-Type**: application/json
|
|
1101
|
+
- **Accept**: application/json
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
### HTTP response details
|
|
1105
|
+
| Status code | Description | Response headers |
|
|
1106
|
+
|-------------|-------------|------------------|
|
|
1107
|
+
|**200** | Installation Details | - |
|
|
1108
|
+
|**400** | Bad Request | - |
|
|
1109
|
+
|**401** | Unauthorised | - |
|
|
1110
|
+
|**403** | Access Denied | - |
|
|
1111
|
+
|
|
1112
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1113
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CrmActivitiesResponseDto
|
|
2
|
+
|
|
3
|
+
CRM Activities Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**dates** | [**Array<CrmDateActivitiesDTO>**](CrmDateActivitiesDTO.md) | Dates | [optional] [default to undefined]
|
|
10
|
+
**agents** | [**Array<AdminUserModel>**](AdminUserModel.md) | Agents | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CrmActivitiesResponseDto } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: CrmActivitiesResponseDto = {
|
|
18
|
+
dates,
|
|
19
|
+
agents,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|