yellowgrid-api-ts 3.1.5 → 3.1.7
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 +2 -0
- package/README.md +2 -0
- package/api.ts +171 -7
- package/dist/api.d.ts +118 -4
- package/dist/api.js +144 -13
- package/docs/CRMApi.md +55 -0
- package/docs/Class3CXInstallationsApi.md +4 -1
- package/docs/CrmContactDTO.md +33 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -23,6 +23,7 @@ docs/AttachmentModel.md
|
|
|
23
23
|
docs/AttributeSetEnum.md
|
|
24
24
|
docs/AuthCodeResponseModel.md
|
|
25
25
|
docs/BatchEntity.md
|
|
26
|
+
docs/CRMApi.md
|
|
26
27
|
docs/CallBarringModel.md
|
|
27
28
|
docs/Class3CXApi.md
|
|
28
29
|
docs/Class3CXInstallationWizardApi.md
|
|
@@ -35,6 +36,7 @@ docs/CompanyContractModel.md
|
|
|
35
36
|
docs/ContactInfoModel.md
|
|
36
37
|
docs/ConversationModel.md
|
|
37
38
|
docs/CreditAccountEntity.md
|
|
39
|
+
docs/CrmContactDTO.md
|
|
38
40
|
docs/CustomerInformationModel.md
|
|
39
41
|
docs/CustomerPriceListEnum.md
|
|
40
42
|
docs/CustomerSummaryReportDTO.md
|
package/README.md
CHANGED
|
@@ -68,6 +68,7 @@ Class | Method | HTTP request | Description
|
|
|
68
68
|
*AccountsApi* | [**postSendPasswordReset**](docs/AccountsApi.md#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email
|
|
69
69
|
*AccountsApi* | [**postSubmitResellerApplication**](docs/AccountsApi.md#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application
|
|
70
70
|
*AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
|
|
71
|
+
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
71
72
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
72
73
|
*Class3CXApi* | [**getGetPasswordHash**](docs/Class3CXApi.md#getgetpasswordhash) | **GET** /tcx/pwd2hash | Convert a password to a hashed 3CX password
|
|
73
74
|
*Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
|
|
@@ -234,6 +235,7 @@ Class | Method | HTTP request | Description
|
|
|
234
235
|
- [ContactInfoModel](docs/ContactInfoModel.md)
|
|
235
236
|
- [ConversationModel](docs/ConversationModel.md)
|
|
236
237
|
- [CreditAccountEntity](docs/CreditAccountEntity.md)
|
|
238
|
+
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
237
239
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
238
240
|
- [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
|
|
239
241
|
- [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
|
package/api.ts
CHANGED
|
@@ -1258,6 +1258,55 @@ export interface CreditAccountEntity {
|
|
|
1258
1258
|
*/
|
|
1259
1259
|
'prizePromo'?: boolean;
|
|
1260
1260
|
}
|
|
1261
|
+
/**
|
|
1262
|
+
* CRM Contact
|
|
1263
|
+
* @export
|
|
1264
|
+
* @interface CrmContactDTO
|
|
1265
|
+
*/
|
|
1266
|
+
export interface CrmContactDTO {
|
|
1267
|
+
/**
|
|
1268
|
+
* Contact ID
|
|
1269
|
+
* @type {string}
|
|
1270
|
+
* @memberof CrmContactDTO
|
|
1271
|
+
*/
|
|
1272
|
+
'id'?: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* Contact First Name
|
|
1275
|
+
* @type {string}
|
|
1276
|
+
* @memberof CrmContactDTO
|
|
1277
|
+
*/
|
|
1278
|
+
'firstName'?: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Contact Last Name
|
|
1281
|
+
* @type {string}
|
|
1282
|
+
* @memberof CrmContactDTO
|
|
1283
|
+
*/
|
|
1284
|
+
'lastName'?: string;
|
|
1285
|
+
/**
|
|
1286
|
+
* Phone Number
|
|
1287
|
+
* @type {string}
|
|
1288
|
+
* @memberof CrmContactDTO
|
|
1289
|
+
*/
|
|
1290
|
+
'phone'?: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* Company Name
|
|
1293
|
+
* @type {string}
|
|
1294
|
+
* @memberof CrmContactDTO
|
|
1295
|
+
*/
|
|
1296
|
+
'company'?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* Email Address
|
|
1299
|
+
* @type {string}
|
|
1300
|
+
* @memberof CrmContactDTO
|
|
1301
|
+
*/
|
|
1302
|
+
'email'?: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* URL
|
|
1305
|
+
* @type {string}
|
|
1306
|
+
* @memberof CrmContactDTO
|
|
1307
|
+
*/
|
|
1308
|
+
'url'?: string;
|
|
1309
|
+
}
|
|
1261
1310
|
/**
|
|
1262
1311
|
* SIP Trunk Customer
|
|
1263
1312
|
* @export
|
|
@@ -9769,6 +9818,103 @@ export class AccountsApi extends BaseAPI {
|
|
|
9769
9818
|
|
|
9770
9819
|
|
|
9771
9820
|
|
|
9821
|
+
/**
|
|
9822
|
+
* CRMApi - axios parameter creator
|
|
9823
|
+
* @export
|
|
9824
|
+
*/
|
|
9825
|
+
export const CRMApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
9826
|
+
return {
|
|
9827
|
+
/**
|
|
9828
|
+
* Search for contacts by phone number
|
|
9829
|
+
* @param {*} [options] Override http request option.
|
|
9830
|
+
* @throws {RequiredError}
|
|
9831
|
+
*/
|
|
9832
|
+
getSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9833
|
+
const localVarPath = `/crm/contact/search`;
|
|
9834
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9835
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9836
|
+
let baseOptions;
|
|
9837
|
+
if (configuration) {
|
|
9838
|
+
baseOptions = configuration.baseOptions;
|
|
9839
|
+
}
|
|
9840
|
+
|
|
9841
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
9842
|
+
const localVarHeaderParameter = {} as any;
|
|
9843
|
+
const localVarQueryParameter = {} as any;
|
|
9844
|
+
|
|
9845
|
+
|
|
9846
|
+
|
|
9847
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9848
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9849
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9850
|
+
|
|
9851
|
+
return {
|
|
9852
|
+
url: toPathString(localVarUrlObj),
|
|
9853
|
+
options: localVarRequestOptions,
|
|
9854
|
+
};
|
|
9855
|
+
},
|
|
9856
|
+
}
|
|
9857
|
+
};
|
|
9858
|
+
|
|
9859
|
+
/**
|
|
9860
|
+
* CRMApi - functional programming interface
|
|
9861
|
+
* @export
|
|
9862
|
+
*/
|
|
9863
|
+
export const CRMApiFp = function(configuration?: Configuration) {
|
|
9864
|
+
const localVarAxiosParamCreator = CRMApiAxiosParamCreator(configuration)
|
|
9865
|
+
return {
|
|
9866
|
+
/**
|
|
9867
|
+
* Search for contacts by phone number
|
|
9868
|
+
* @param {*} [options] Override http request option.
|
|
9869
|
+
* @throws {RequiredError}
|
|
9870
|
+
*/
|
|
9871
|
+
async getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
|
|
9872
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(options);
|
|
9873
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9874
|
+
const localVarOperationServerBasePath = operationServerMap['CRMApi.getSearchByPhone']?.[localVarOperationServerIndex]?.url;
|
|
9875
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9876
|
+
},
|
|
9877
|
+
}
|
|
9878
|
+
};
|
|
9879
|
+
|
|
9880
|
+
/**
|
|
9881
|
+
* CRMApi - factory interface
|
|
9882
|
+
* @export
|
|
9883
|
+
*/
|
|
9884
|
+
export const CRMApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
9885
|
+
const localVarFp = CRMApiFp(configuration)
|
|
9886
|
+
return {
|
|
9887
|
+
/**
|
|
9888
|
+
* Search for contacts by phone number
|
|
9889
|
+
* @param {*} [options] Override http request option.
|
|
9890
|
+
* @throws {RequiredError}
|
|
9891
|
+
*/
|
|
9892
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
|
|
9893
|
+
return localVarFp.getSearchByPhone(options).then((request) => request(axios, basePath));
|
|
9894
|
+
},
|
|
9895
|
+
};
|
|
9896
|
+
};
|
|
9897
|
+
|
|
9898
|
+
/**
|
|
9899
|
+
* CRMApi - object-oriented interface
|
|
9900
|
+
* @export
|
|
9901
|
+
* @class CRMApi
|
|
9902
|
+
* @extends {BaseAPI}
|
|
9903
|
+
*/
|
|
9904
|
+
export class CRMApi extends BaseAPI {
|
|
9905
|
+
/**
|
|
9906
|
+
* Search for contacts by phone number
|
|
9907
|
+
* @param {*} [options] Override http request option.
|
|
9908
|
+
* @throws {RequiredError}
|
|
9909
|
+
* @memberof CRMApi
|
|
9910
|
+
*/
|
|
9911
|
+
public getSearchByPhone(options?: RawAxiosRequestConfig) {
|
|
9912
|
+
return CRMApiFp(this.configuration).getSearchByPhone(options).then((request) => request(this.axios, this.basePath));
|
|
9913
|
+
}
|
|
9914
|
+
}
|
|
9915
|
+
|
|
9916
|
+
|
|
9917
|
+
|
|
9772
9918
|
/**
|
|
9773
9919
|
* Class3CXApi - axios parameter creator
|
|
9774
9920
|
* @export
|
|
@@ -12450,10 +12596,11 @@ export const Class3CXInstallationsApiAxiosParamCreator = function (configuration
|
|
|
12450
12596
|
* @param {string} [search] Search
|
|
12451
12597
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
12452
12598
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
12599
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
12453
12600
|
* @param {*} [options] Override http request option.
|
|
12454
12601
|
* @throws {RequiredError}
|
|
12455
12602
|
*/
|
|
12456
|
-
getGetInstallations: async (pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12603
|
+
getGetInstallations: async (pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12457
12604
|
const localVarPath = `/tcx/installations`;
|
|
12458
12605
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12459
12606
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -12490,6 +12637,10 @@ export const Class3CXInstallationsApiAxiosParamCreator = function (configuration
|
|
|
12490
12637
|
localVarQueryParameter['hosting'] = hosting;
|
|
12491
12638
|
}
|
|
12492
12639
|
|
|
12640
|
+
if (installType !== undefined) {
|
|
12641
|
+
localVarQueryParameter['installType'] = installType;
|
|
12642
|
+
}
|
|
12643
|
+
|
|
12493
12644
|
|
|
12494
12645
|
|
|
12495
12646
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -12898,11 +13049,12 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
|
|
|
12898
13049
|
* @param {string} [search] Search
|
|
12899
13050
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
12900
13051
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
13052
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
12901
13053
|
* @param {*} [options] Override http request option.
|
|
12902
13054
|
* @throws {RequiredError}
|
|
12903
13055
|
*/
|
|
12904
|
-
async getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationsModel>> {
|
|
12905
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetInstallations(pageSize, page, customerId, search, status, hosting, options);
|
|
13056
|
+
async getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationsModel>> {
|
|
13057
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options);
|
|
12906
13058
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12907
13059
|
const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.getGetInstallations']?.[localVarOperationServerIndex]?.url;
|
|
12908
13060
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -13062,11 +13214,12 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
|
|
|
13062
13214
|
* @param {string} [search] Search
|
|
13063
13215
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
13064
13216
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
13217
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
13065
13218
|
* @param {*} [options] Override http request option.
|
|
13066
13219
|
* @throws {RequiredError}
|
|
13067
13220
|
*/
|
|
13068
|
-
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel> {
|
|
13069
|
-
return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, options).then((request) => request(axios, basePath));
|
|
13221
|
+
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel> {
|
|
13222
|
+
return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then((request) => request(axios, basePath));
|
|
13070
13223
|
},
|
|
13071
13224
|
/**
|
|
13072
13225
|
* Create a root user
|
|
@@ -13198,12 +13351,13 @@ export class Class3CXInstallationsApi extends BaseAPI {
|
|
|
13198
13351
|
* @param {string} [search] Search
|
|
13199
13352
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
13200
13353
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
13354
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
13201
13355
|
* @param {*} [options] Override http request option.
|
|
13202
13356
|
* @throws {RequiredError}
|
|
13203
13357
|
* @memberof Class3CXInstallationsApi
|
|
13204
13358
|
*/
|
|
13205
|
-
public getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig) {
|
|
13206
|
-
return Class3CXInstallationsApiFp(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, options).then((request) => request(this.axios, this.basePath));
|
|
13359
|
+
public getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig) {
|
|
13360
|
+
return Class3CXInstallationsApiFp(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then((request) => request(this.axios, this.basePath));
|
|
13207
13361
|
}
|
|
13208
13362
|
|
|
13209
13363
|
/**
|
|
@@ -13344,6 +13498,16 @@ export const GetGetInstallationsHostingEnum = {
|
|
|
13344
13498
|
All: 'all'
|
|
13345
13499
|
} as const;
|
|
13346
13500
|
export type GetGetInstallationsHostingEnum = typeof GetGetInstallationsHostingEnum[keyof typeof GetGetInstallationsHostingEnum];
|
|
13501
|
+
/**
|
|
13502
|
+
* @export
|
|
13503
|
+
*/
|
|
13504
|
+
export const GetGetInstallationsInstallTypeEnum = {
|
|
13505
|
+
New: 'new',
|
|
13506
|
+
Restore: 'restore',
|
|
13507
|
+
Failover: 'failover',
|
|
13508
|
+
MultiTenant: 'multi-tenant'
|
|
13509
|
+
} as const;
|
|
13510
|
+
export type GetGetInstallationsInstallTypeEnum = typeof GetGetInstallationsInstallTypeEnum[keyof typeof GetGetInstallationsInstallTypeEnum];
|
|
13347
13511
|
/**
|
|
13348
13512
|
* @export
|
|
13349
13513
|
*/
|
package/dist/api.d.ts
CHANGED
|
@@ -1248,6 +1248,55 @@ export interface CreditAccountEntity {
|
|
|
1248
1248
|
*/
|
|
1249
1249
|
'prizePromo'?: boolean;
|
|
1250
1250
|
}
|
|
1251
|
+
/**
|
|
1252
|
+
* CRM Contact
|
|
1253
|
+
* @export
|
|
1254
|
+
* @interface CrmContactDTO
|
|
1255
|
+
*/
|
|
1256
|
+
export interface CrmContactDTO {
|
|
1257
|
+
/**
|
|
1258
|
+
* Contact ID
|
|
1259
|
+
* @type {string}
|
|
1260
|
+
* @memberof CrmContactDTO
|
|
1261
|
+
*/
|
|
1262
|
+
'id'?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* Contact First Name
|
|
1265
|
+
* @type {string}
|
|
1266
|
+
* @memberof CrmContactDTO
|
|
1267
|
+
*/
|
|
1268
|
+
'firstName'?: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* Contact Last Name
|
|
1271
|
+
* @type {string}
|
|
1272
|
+
* @memberof CrmContactDTO
|
|
1273
|
+
*/
|
|
1274
|
+
'lastName'?: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* Phone Number
|
|
1277
|
+
* @type {string}
|
|
1278
|
+
* @memberof CrmContactDTO
|
|
1279
|
+
*/
|
|
1280
|
+
'phone'?: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* Company Name
|
|
1283
|
+
* @type {string}
|
|
1284
|
+
* @memberof CrmContactDTO
|
|
1285
|
+
*/
|
|
1286
|
+
'company'?: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* Email Address
|
|
1289
|
+
* @type {string}
|
|
1290
|
+
* @memberof CrmContactDTO
|
|
1291
|
+
*/
|
|
1292
|
+
'email'?: string;
|
|
1293
|
+
/**
|
|
1294
|
+
* URL
|
|
1295
|
+
* @type {string}
|
|
1296
|
+
* @memberof CrmContactDTO
|
|
1297
|
+
*/
|
|
1298
|
+
'url'?: string;
|
|
1299
|
+
}
|
|
1251
1300
|
/**
|
|
1252
1301
|
* SIP Trunk Customer
|
|
1253
1302
|
* @export
|
|
@@ -9053,6 +9102,57 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
9053
9102
|
*/
|
|
9054
9103
|
putUpdateAccountContact(email: string, accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
9055
9104
|
}
|
|
9105
|
+
/**
|
|
9106
|
+
* CRMApi - axios parameter creator
|
|
9107
|
+
* @export
|
|
9108
|
+
*/
|
|
9109
|
+
export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9110
|
+
/**
|
|
9111
|
+
* Search for contacts by phone number
|
|
9112
|
+
* @param {*} [options] Override http request option.
|
|
9113
|
+
* @throws {RequiredError}
|
|
9114
|
+
*/
|
|
9115
|
+
getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9116
|
+
};
|
|
9117
|
+
/**
|
|
9118
|
+
* CRMApi - functional programming interface
|
|
9119
|
+
* @export
|
|
9120
|
+
*/
|
|
9121
|
+
export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
9122
|
+
/**
|
|
9123
|
+
* Search for contacts by phone number
|
|
9124
|
+
* @param {*} [options] Override http request option.
|
|
9125
|
+
* @throws {RequiredError}
|
|
9126
|
+
*/
|
|
9127
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
|
|
9128
|
+
};
|
|
9129
|
+
/**
|
|
9130
|
+
* CRMApi - factory interface
|
|
9131
|
+
* @export
|
|
9132
|
+
*/
|
|
9133
|
+
export declare const CRMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9134
|
+
/**
|
|
9135
|
+
* Search for contacts by phone number
|
|
9136
|
+
* @param {*} [options] Override http request option.
|
|
9137
|
+
* @throws {RequiredError}
|
|
9138
|
+
*/
|
|
9139
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
|
|
9140
|
+
};
|
|
9141
|
+
/**
|
|
9142
|
+
* CRMApi - object-oriented interface
|
|
9143
|
+
* @export
|
|
9144
|
+
* @class CRMApi
|
|
9145
|
+
* @extends {BaseAPI}
|
|
9146
|
+
*/
|
|
9147
|
+
export declare class CRMApi extends BaseAPI {
|
|
9148
|
+
/**
|
|
9149
|
+
* Search for contacts by phone number
|
|
9150
|
+
* @param {*} [options] Override http request option.
|
|
9151
|
+
* @throws {RequiredError}
|
|
9152
|
+
* @memberof CRMApi
|
|
9153
|
+
*/
|
|
9154
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}>>;
|
|
9155
|
+
}
|
|
9056
9156
|
/**
|
|
9057
9157
|
* Class3CXApi - axios parameter creator
|
|
9058
9158
|
* @export
|
|
@@ -10331,10 +10431,11 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
|
|
|
10331
10431
|
* @param {string} [search] Search
|
|
10332
10432
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
10333
10433
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
10434
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
10334
10435
|
* @param {*} [options] Override http request option.
|
|
10335
10436
|
* @throws {RequiredError}
|
|
10336
10437
|
*/
|
|
10337
|
-
getGetInstallations: (pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10438
|
+
getGetInstallations: (pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10338
10439
|
/**
|
|
10339
10440
|
* Create a root user
|
|
10340
10441
|
* @summary Create a root user
|
|
@@ -10439,10 +10540,11 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
|
|
|
10439
10540
|
* @param {string} [search] Search
|
|
10440
10541
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
10441
10542
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
10543
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
10442
10544
|
* @param {*} [options] Override http request option.
|
|
10443
10545
|
* @throws {RequiredError}
|
|
10444
10546
|
*/
|
|
10445
|
-
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationsModel>>;
|
|
10547
|
+
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationsModel>>;
|
|
10446
10548
|
/**
|
|
10447
10549
|
* Create a root user
|
|
10448
10550
|
* @summary Create a root user
|
|
@@ -10547,10 +10649,11 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
|
|
|
10547
10649
|
* @param {string} [search] Search
|
|
10548
10650
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
10549
10651
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
10652
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
10550
10653
|
* @param {*} [options] Override http request option.
|
|
10551
10654
|
* @throws {RequiredError}
|
|
10552
10655
|
*/
|
|
10553
|
-
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel>;
|
|
10656
|
+
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel>;
|
|
10554
10657
|
/**
|
|
10555
10658
|
* Create a root user
|
|
10556
10659
|
* @summary Create a root user
|
|
@@ -10658,11 +10761,12 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
|
|
|
10658
10761
|
* @param {string} [search] Search
|
|
10659
10762
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
10660
10763
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
10764
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
10661
10765
|
* @param {*} [options] Override http request option.
|
|
10662
10766
|
* @throws {RequiredError}
|
|
10663
10767
|
* @memberof Class3CXInstallationsApi
|
|
10664
10768
|
*/
|
|
10665
|
-
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxInstallationsModel, any, {}>>;
|
|
10769
|
+
getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxInstallationsModel, any, {}>>;
|
|
10666
10770
|
/**
|
|
10667
10771
|
* Create a root user
|
|
10668
10772
|
* @summary Create a root user
|
|
@@ -10774,6 +10878,16 @@ export declare const GetGetInstallationsHostingEnum: {
|
|
|
10774
10878
|
readonly All: "all";
|
|
10775
10879
|
};
|
|
10776
10880
|
export type GetGetInstallationsHostingEnum = typeof GetGetInstallationsHostingEnum[keyof typeof GetGetInstallationsHostingEnum];
|
|
10881
|
+
/**
|
|
10882
|
+
* @export
|
|
10883
|
+
*/
|
|
10884
|
+
export declare const GetGetInstallationsInstallTypeEnum: {
|
|
10885
|
+
readonly New: "new";
|
|
10886
|
+
readonly Restore: "restore";
|
|
10887
|
+
readonly Failover: "failover";
|
|
10888
|
+
readonly MultiTenant: "multi-tenant";
|
|
10889
|
+
};
|
|
10890
|
+
export type GetGetInstallationsInstallTypeEnum = typeof GetGetInstallationsInstallTypeEnum[keyof typeof GetGetInstallationsInstallTypeEnum];
|
|
10777
10891
|
/**
|
|
10778
10892
|
* @export
|
|
10779
10893
|
*/
|
package/dist/api.js
CHANGED
|
@@ -84,9 +84,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
84
84
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
85
|
};
|
|
86
86
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.
|
|
88
|
-
exports.
|
|
89
|
-
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = void 0;
|
|
87
|
+
exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.DivertResponseModelStatusEnum = void 0;
|
|
88
|
+
exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = void 0;
|
|
89
|
+
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = void 0;
|
|
90
90
|
var axios_1 = require("axios");
|
|
91
91
|
// Some imports not used depending on template conditions
|
|
92
92
|
// @ts-ignore
|
|
@@ -1724,6 +1724,121 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
1724
1724
|
return AccountsApi;
|
|
1725
1725
|
}(base_1.BaseAPI));
|
|
1726
1726
|
exports.AccountsApi = AccountsApi;
|
|
1727
|
+
/**
|
|
1728
|
+
* CRMApi - axios parameter creator
|
|
1729
|
+
* @export
|
|
1730
|
+
*/
|
|
1731
|
+
var CRMApiAxiosParamCreator = function (configuration) {
|
|
1732
|
+
var _this = this;
|
|
1733
|
+
return {
|
|
1734
|
+
/**
|
|
1735
|
+
* Search for contacts by phone number
|
|
1736
|
+
* @param {*} [options] Override http request option.
|
|
1737
|
+
* @throws {RequiredError}
|
|
1738
|
+
*/
|
|
1739
|
+
getSearchByPhone: function () {
|
|
1740
|
+
var args_1 = [];
|
|
1741
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
1742
|
+
args_1[_i] = arguments[_i];
|
|
1743
|
+
}
|
|
1744
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
1745
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1746
|
+
if (options === void 0) { options = {}; }
|
|
1747
|
+
return __generator(this, function (_a) {
|
|
1748
|
+
localVarPath = "/crm/contact/search";
|
|
1749
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1750
|
+
if (configuration) {
|
|
1751
|
+
baseOptions = configuration.baseOptions;
|
|
1752
|
+
}
|
|
1753
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
1754
|
+
localVarHeaderParameter = {};
|
|
1755
|
+
localVarQueryParameter = {};
|
|
1756
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1757
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1758
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1759
|
+
return [2 /*return*/, {
|
|
1760
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1761
|
+
options: localVarRequestOptions,
|
|
1762
|
+
}];
|
|
1763
|
+
});
|
|
1764
|
+
});
|
|
1765
|
+
},
|
|
1766
|
+
};
|
|
1767
|
+
};
|
|
1768
|
+
exports.CRMApiAxiosParamCreator = CRMApiAxiosParamCreator;
|
|
1769
|
+
/**
|
|
1770
|
+
* CRMApi - functional programming interface
|
|
1771
|
+
* @export
|
|
1772
|
+
*/
|
|
1773
|
+
var CRMApiFp = function (configuration) {
|
|
1774
|
+
var localVarAxiosParamCreator = (0, exports.CRMApiAxiosParamCreator)(configuration);
|
|
1775
|
+
return {
|
|
1776
|
+
/**
|
|
1777
|
+
* Search for contacts by phone number
|
|
1778
|
+
* @param {*} [options] Override http request option.
|
|
1779
|
+
* @throws {RequiredError}
|
|
1780
|
+
*/
|
|
1781
|
+
getSearchByPhone: function (options) {
|
|
1782
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1783
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1784
|
+
var _a, _b, _c;
|
|
1785
|
+
return __generator(this, function (_d) {
|
|
1786
|
+
switch (_d.label) {
|
|
1787
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(options)];
|
|
1788
|
+
case 1:
|
|
1789
|
+
localVarAxiosArgs = _d.sent();
|
|
1790
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1791
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CRMApi.getSearchByPhone']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1792
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1793
|
+
}
|
|
1794
|
+
});
|
|
1795
|
+
});
|
|
1796
|
+
},
|
|
1797
|
+
};
|
|
1798
|
+
};
|
|
1799
|
+
exports.CRMApiFp = CRMApiFp;
|
|
1800
|
+
/**
|
|
1801
|
+
* CRMApi - factory interface
|
|
1802
|
+
* @export
|
|
1803
|
+
*/
|
|
1804
|
+
var CRMApiFactory = function (configuration, basePath, axios) {
|
|
1805
|
+
var localVarFp = (0, exports.CRMApiFp)(configuration);
|
|
1806
|
+
return {
|
|
1807
|
+
/**
|
|
1808
|
+
* Search for contacts by phone number
|
|
1809
|
+
* @param {*} [options] Override http request option.
|
|
1810
|
+
* @throws {RequiredError}
|
|
1811
|
+
*/
|
|
1812
|
+
getSearchByPhone: function (options) {
|
|
1813
|
+
return localVarFp.getSearchByPhone(options).then(function (request) { return request(axios, basePath); });
|
|
1814
|
+
},
|
|
1815
|
+
};
|
|
1816
|
+
};
|
|
1817
|
+
exports.CRMApiFactory = CRMApiFactory;
|
|
1818
|
+
/**
|
|
1819
|
+
* CRMApi - object-oriented interface
|
|
1820
|
+
* @export
|
|
1821
|
+
* @class CRMApi
|
|
1822
|
+
* @extends {BaseAPI}
|
|
1823
|
+
*/
|
|
1824
|
+
var CRMApi = /** @class */ (function (_super) {
|
|
1825
|
+
__extends(CRMApi, _super);
|
|
1826
|
+
function CRMApi() {
|
|
1827
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* Search for contacts by phone number
|
|
1831
|
+
* @param {*} [options] Override http request option.
|
|
1832
|
+
* @throws {RequiredError}
|
|
1833
|
+
* @memberof CRMApi
|
|
1834
|
+
*/
|
|
1835
|
+
CRMApi.prototype.getSearchByPhone = function (options) {
|
|
1836
|
+
var _this = this;
|
|
1837
|
+
return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1838
|
+
};
|
|
1839
|
+
return CRMApi;
|
|
1840
|
+
}(base_1.BaseAPI));
|
|
1841
|
+
exports.CRMApi = CRMApi;
|
|
1727
1842
|
/**
|
|
1728
1843
|
* Class3CXApi - axios parameter creator
|
|
1729
1844
|
* @export
|
|
@@ -4851,15 +4966,16 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
4851
4966
|
* @param {string} [search] Search
|
|
4852
4967
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
4853
4968
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
4969
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
4854
4970
|
* @param {*} [options] Override http request option.
|
|
4855
4971
|
* @throws {RequiredError}
|
|
4856
4972
|
*/
|
|
4857
|
-
getGetInstallations: function (pageSize_1, page_1, customerId_1, search_1, status_1, hosting_1) {
|
|
4973
|
+
getGetInstallations: function (pageSize_1, page_1, customerId_1, search_1, status_1, hosting_1, installType_1) {
|
|
4858
4974
|
var args_1 = [];
|
|
4859
|
-
for (var _i =
|
|
4860
|
-
args_1[_i -
|
|
4975
|
+
for (var _i = 7; _i < arguments.length; _i++) {
|
|
4976
|
+
args_1[_i - 7] = arguments[_i];
|
|
4861
4977
|
}
|
|
4862
|
-
return __awaiter(_this, __spreadArray([pageSize_1, page_1, customerId_1, search_1, status_1, hosting_1], args_1, true), void 0, function (pageSize, page, customerId, search, status, hosting, options) {
|
|
4978
|
+
return __awaiter(_this, __spreadArray([pageSize_1, page_1, customerId_1, search_1, status_1, hosting_1, installType_1], args_1, true), void 0, function (pageSize, page, customerId, search, status, hosting, installType, options) {
|
|
4863
4979
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
4864
4980
|
if (options === void 0) { options = {}; }
|
|
4865
4981
|
return __generator(this, function (_a) {
|
|
@@ -4889,6 +5005,9 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
|
|
|
4889
5005
|
if (hosting !== undefined) {
|
|
4890
5006
|
localVarQueryParameter['hosting'] = hosting;
|
|
4891
5007
|
}
|
|
5008
|
+
if (installType !== undefined) {
|
|
5009
|
+
localVarQueryParameter['installType'] = installType;
|
|
5010
|
+
}
|
|
4892
5011
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4893
5012
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4894
5013
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -5324,16 +5443,17 @@ var Class3CXInstallationsApiFp = function (configuration) {
|
|
|
5324
5443
|
* @param {string} [search] Search
|
|
5325
5444
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
5326
5445
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
5446
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
5327
5447
|
* @param {*} [options] Override http request option.
|
|
5328
5448
|
* @throws {RequiredError}
|
|
5329
5449
|
*/
|
|
5330
|
-
getGetInstallations: function (pageSize, page, customerId, search, status, hosting, options) {
|
|
5450
|
+
getGetInstallations: function (pageSize, page, customerId, search, status, hosting, installType, options) {
|
|
5331
5451
|
return __awaiter(this, void 0, void 0, function () {
|
|
5332
5452
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
5333
5453
|
var _a, _b, _c;
|
|
5334
5454
|
return __generator(this, function (_d) {
|
|
5335
5455
|
switch (_d.label) {
|
|
5336
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetInstallations(pageSize, page, customerId, search, status, hosting, options)];
|
|
5456
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options)];
|
|
5337
5457
|
case 1:
|
|
5338
5458
|
localVarAxiosArgs = _d.sent();
|
|
5339
5459
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -5588,11 +5708,12 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
|
|
|
5588
5708
|
* @param {string} [search] Search
|
|
5589
5709
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
5590
5710
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
5711
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
5591
5712
|
* @param {*} [options] Override http request option.
|
|
5592
5713
|
* @throws {RequiredError}
|
|
5593
5714
|
*/
|
|
5594
|
-
getGetInstallations: function (pageSize, page, customerId, search, status, hosting, options) {
|
|
5595
|
-
return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, options).then(function (request) { return request(axios, basePath); });
|
|
5715
|
+
getGetInstallations: function (pageSize, page, customerId, search, status, hosting, installType, options) {
|
|
5716
|
+
return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then(function (request) { return request(axios, basePath); });
|
|
5596
5717
|
},
|
|
5597
5718
|
/**
|
|
5598
5719
|
* Create a root user
|
|
@@ -5728,13 +5849,14 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
|
|
|
5728
5849
|
* @param {string} [search] Search
|
|
5729
5850
|
* @param {GetGetInstallationsStatusEnum} [status] Status
|
|
5730
5851
|
* @param {GetGetInstallationsHostingEnum} [hosting] Hosting
|
|
5852
|
+
* @param {GetGetInstallationsInstallTypeEnum} [installType] Install Type
|
|
5731
5853
|
* @param {*} [options] Override http request option.
|
|
5732
5854
|
* @throws {RequiredError}
|
|
5733
5855
|
* @memberof Class3CXInstallationsApi
|
|
5734
5856
|
*/
|
|
5735
|
-
Class3CXInstallationsApi.prototype.getGetInstallations = function (pageSize, page, customerId, search, status, hosting, options) {
|
|
5857
|
+
Class3CXInstallationsApi.prototype.getGetInstallations = function (pageSize, page, customerId, search, status, hosting, installType, options) {
|
|
5736
5858
|
var _this = this;
|
|
5737
|
-
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
5859
|
+
return (0, exports.Class3CXInstallationsApiFp)(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
5738
5860
|
};
|
|
5739
5861
|
/**
|
|
5740
5862
|
* Create a root user
|
|
@@ -5874,6 +5996,15 @@ exports.GetGetInstallationsHostingEnum = {
|
|
|
5874
5996
|
Onprem: 'onprem',
|
|
5875
5997
|
All: 'all'
|
|
5876
5998
|
};
|
|
5999
|
+
/**
|
|
6000
|
+
* @export
|
|
6001
|
+
*/
|
|
6002
|
+
exports.GetGetInstallationsInstallTypeEnum = {
|
|
6003
|
+
New: 'new',
|
|
6004
|
+
Restore: 'restore',
|
|
6005
|
+
Failover: 'failover',
|
|
6006
|
+
MultiTenant: 'multi-tenant'
|
|
6007
|
+
};
|
|
5877
6008
|
/**
|
|
5878
6009
|
* @export
|
|
5879
6010
|
*/
|
package/docs/CRMApi.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# CRMApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://api.yellowgrid.local*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
|
|
8
|
+
|
|
9
|
+
# **getSearchByPhone**
|
|
10
|
+
> CrmContactDTO getSearchByPhone()
|
|
11
|
+
|
|
12
|
+
Search for contacts by phone number
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
CRMApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new CRMApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.getSearchByPhone();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
**CrmContactDTO**
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
No authorization required
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: application/json
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | CRM Contact | - |
|
|
50
|
+
|**400** | Bad Request | - |
|
|
51
|
+
|**401** | Unauthorised | - |
|
|
52
|
+
|**403** | Access Denied | - |
|
|
53
|
+
|
|
54
|
+
[[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)
|
|
55
|
+
|
|
@@ -92,6 +92,7 @@ let customerId: string; //Customer ID (optional) (default to undefined)
|
|
|
92
92
|
let search: string; //Search (optional) (default to undefined)
|
|
93
93
|
let status: 'Completed' | 'Outstanding' | 'Offline' | 'Failed Over'; //Status (optional) (default to undefined)
|
|
94
94
|
let hosting: 'yellowgrid' | 'multi-tenant' | 'onprem' | 'all'; //Hosting (optional) (default to undefined)
|
|
95
|
+
let installType: 'new' | 'restore' | 'failover' | 'multi-tenant'; //Install Type (optional) (default to undefined)
|
|
95
96
|
|
|
96
97
|
const { status, data } = await apiInstance.getGetInstallations(
|
|
97
98
|
pageSize,
|
|
@@ -99,7 +100,8 @@ const { status, data } = await apiInstance.getGetInstallations(
|
|
|
99
100
|
customerId,
|
|
100
101
|
search,
|
|
101
102
|
status,
|
|
102
|
-
hosting
|
|
103
|
+
hosting,
|
|
104
|
+
installType
|
|
103
105
|
);
|
|
104
106
|
```
|
|
105
107
|
|
|
@@ -113,6 +115,7 @@ const { status, data } = await apiInstance.getGetInstallations(
|
|
|
113
115
|
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
114
116
|
| **status** | [**'Completed' | 'Outstanding' | 'Offline' | 'Failed Over'**]**Array<'Completed' | 'Outstanding' | 'Offline' | 'Failed Over'>** | Status | (optional) defaults to undefined|
|
|
115
117
|
| **hosting** | [**'yellowgrid' | 'multi-tenant' | 'onprem' | 'all'**]**Array<'yellowgrid' | 'multi-tenant' | 'onprem' | 'all'>** | Hosting | (optional) defaults to undefined|
|
|
118
|
+
| **installType** | [**'new' | 'restore' | 'failover' | 'multi-tenant'**]**Array<'new' | 'restore' | 'failover' | 'multi-tenant'>** | Install Type | (optional) defaults to undefined|
|
|
116
119
|
|
|
117
120
|
|
|
118
121
|
### Return type
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# CrmContactDTO
|
|
2
|
+
|
|
3
|
+
CRM Contact
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Contact ID | [optional] [default to undefined]
|
|
10
|
+
**firstName** | **string** | Contact First Name | [optional] [default to undefined]
|
|
11
|
+
**lastName** | **string** | Contact Last Name | [optional] [default to undefined]
|
|
12
|
+
**phone** | **string** | Phone Number | [optional] [default to undefined]
|
|
13
|
+
**company** | **string** | Company Name | [optional] [default to undefined]
|
|
14
|
+
**email** | **string** | Email Address | [optional] [default to undefined]
|
|
15
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { CrmContactDTO } from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: CrmContactDTO = {
|
|
23
|
+
id,
|
|
24
|
+
firstName,
|
|
25
|
+
lastName,
|
|
26
|
+
phone,
|
|
27
|
+
company,
|
|
28
|
+
email,
|
|
29
|
+
url,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|