yellowgrid-api-ts 3.2.121-dev.0 → 3.2.122-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/api.ts +33 -24
- package/dist/api.d.ts +33 -24
- package/dist/api.js +27 -19
- package/docs/CRMApi.md +8 -8
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -10123,13 +10123,13 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
10123
10123
|
return {
|
|
10124
10124
|
/**
|
|
10125
10125
|
* Get Customer CRM Activities
|
|
10126
|
-
* @param {
|
|
10127
|
-
* @param {
|
|
10128
|
-
* @param {
|
|
10126
|
+
* @param {number} id Account ID
|
|
10127
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10128
|
+
* @param {number} userId Activity Created By
|
|
10129
10129
|
* @param {*} [options] Override http request option.
|
|
10130
10130
|
* @throws {RequiredError}
|
|
10131
10131
|
*/
|
|
10132
|
-
getGetCrmActivities: async (id:
|
|
10132
|
+
getGetCrmActivities: async (id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10133
10133
|
// verify required parameter 'id' is not null or undefined
|
|
10134
10134
|
assertParamExists('getGetCrmActivities', 'id', id)
|
|
10135
10135
|
// verify required parameter 'type' is not null or undefined
|
|
@@ -10199,12 +10199,12 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
10199
10199
|
},
|
|
10200
10200
|
/**
|
|
10201
10201
|
* Create CRM Note
|
|
10202
|
-
* @param {
|
|
10202
|
+
* @param {number} id Account ID
|
|
10203
10203
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10204
10204
|
* @param {*} [options] Override http request option.
|
|
10205
10205
|
* @throws {RequiredError}
|
|
10206
10206
|
*/
|
|
10207
|
-
postCreateCrmNote: async (id:
|
|
10207
|
+
postCreateCrmNote: async (id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10208
10208
|
// verify required parameter 'id' is not null or undefined
|
|
10209
10209
|
assertParamExists('postCreateCrmNote', 'id', id)
|
|
10210
10210
|
const localVarPath = `/admin/crm/{id}/activities/note`
|
|
@@ -10244,13 +10244,13 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10244
10244
|
return {
|
|
10245
10245
|
/**
|
|
10246
10246
|
* Get Customer CRM Activities
|
|
10247
|
-
* @param {
|
|
10248
|
-
* @param {
|
|
10249
|
-
* @param {
|
|
10247
|
+
* @param {number} id Account ID
|
|
10248
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10249
|
+
* @param {number} userId Activity Created By
|
|
10250
10250
|
* @param {*} [options] Override http request option.
|
|
10251
10251
|
* @throws {RequiredError}
|
|
10252
10252
|
*/
|
|
10253
|
-
async getGetCrmActivities(id:
|
|
10253
|
+
async getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>> {
|
|
10254
10254
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options);
|
|
10255
10255
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10256
10256
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.getGetCrmActivities']?.[localVarOperationServerIndex]?.url;
|
|
@@ -10269,12 +10269,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10269
10269
|
},
|
|
10270
10270
|
/**
|
|
10271
10271
|
* Create CRM Note
|
|
10272
|
-
* @param {
|
|
10272
|
+
* @param {number} id Account ID
|
|
10273
10273
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10274
10274
|
* @param {*} [options] Override http request option.
|
|
10275
10275
|
* @throws {RequiredError}
|
|
10276
10276
|
*/
|
|
10277
|
-
async postCreateCrmNote(id:
|
|
10277
|
+
async postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>> {
|
|
10278
10278
|
const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateCrmNote(id, postCreateCrmNoteRequest, options);
|
|
10279
10279
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10280
10280
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.postCreateCrmNote']?.[localVarOperationServerIndex]?.url;
|
|
@@ -10291,13 +10291,13 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10291
10291
|
return {
|
|
10292
10292
|
/**
|
|
10293
10293
|
* Get Customer CRM Activities
|
|
10294
|
-
* @param {
|
|
10295
|
-
* @param {
|
|
10296
|
-
* @param {
|
|
10294
|
+
* @param {number} id Account ID
|
|
10295
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10296
|
+
* @param {number} userId Activity Created By
|
|
10297
10297
|
* @param {*} [options] Override http request option.
|
|
10298
10298
|
* @throws {RequiredError}
|
|
10299
10299
|
*/
|
|
10300
|
-
getGetCrmActivities(id:
|
|
10300
|
+
getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>> {
|
|
10301
10301
|
return localVarFp.getGetCrmActivities(id, type, userId, options).then((request) => request(axios, basePath));
|
|
10302
10302
|
},
|
|
10303
10303
|
/**
|
|
@@ -10310,12 +10310,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10310
10310
|
},
|
|
10311
10311
|
/**
|
|
10312
10312
|
* Create CRM Note
|
|
10313
|
-
* @param {
|
|
10313
|
+
* @param {number} id Account ID
|
|
10314
10314
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10315
10315
|
* @param {*} [options] Override http request option.
|
|
10316
10316
|
* @throws {RequiredError}
|
|
10317
10317
|
*/
|
|
10318
|
-
postCreateCrmNote(id:
|
|
10318
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto> {
|
|
10319
10319
|
return localVarFp.postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(axios, basePath));
|
|
10320
10320
|
},
|
|
10321
10321
|
};
|
|
@@ -10327,13 +10327,13 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10327
10327
|
export class CRMApi extends BaseAPI {
|
|
10328
10328
|
/**
|
|
10329
10329
|
* Get Customer CRM Activities
|
|
10330
|
-
* @param {
|
|
10331
|
-
* @param {
|
|
10332
|
-
* @param {
|
|
10330
|
+
* @param {number} id Account ID
|
|
10331
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10332
|
+
* @param {number} userId Activity Created By
|
|
10333
10333
|
* @param {*} [options] Override http request option.
|
|
10334
10334
|
* @throws {RequiredError}
|
|
10335
10335
|
*/
|
|
10336
|
-
public getGetCrmActivities(id:
|
|
10336
|
+
public getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig) {
|
|
10337
10337
|
return CRMApiFp(this.configuration).getGetCrmActivities(id, type, userId, options).then((request) => request(this.axios, this.basePath));
|
|
10338
10338
|
}
|
|
10339
10339
|
|
|
@@ -10348,16 +10348,25 @@ export class CRMApi extends BaseAPI {
|
|
|
10348
10348
|
|
|
10349
10349
|
/**
|
|
10350
10350
|
* Create CRM Note
|
|
10351
|
-
* @param {
|
|
10351
|
+
* @param {number} id Account ID
|
|
10352
10352
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10353
10353
|
* @param {*} [options] Override http request option.
|
|
10354
10354
|
* @throws {RequiredError}
|
|
10355
10355
|
*/
|
|
10356
|
-
public postCreateCrmNote(id:
|
|
10356
|
+
public postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) {
|
|
10357
10357
|
return CRMApiFp(this.configuration).postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10358
10358
|
}
|
|
10359
10359
|
}
|
|
10360
10360
|
|
|
10361
|
+
export const GetGetCrmActivitiesTypeEnum = {
|
|
10362
|
+
Alert: 'alert',
|
|
10363
|
+
Call: 'call',
|
|
10364
|
+
Note: 'note',
|
|
10365
|
+
Order: 'order',
|
|
10366
|
+
Quote: 'quote',
|
|
10367
|
+
TcxOrder: 'tcx_order'
|
|
10368
|
+
} as const;
|
|
10369
|
+
export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[keyof typeof GetGetCrmActivitiesTypeEnum];
|
|
10361
10370
|
|
|
10362
10371
|
|
|
10363
10372
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -8943,13 +8943,13 @@ export type PatchSetPrizePromoStateEnum = typeof PatchSetPrizePromoStateEnum[key
|
|
|
8943
8943
|
export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8944
8944
|
/**
|
|
8945
8945
|
* Get Customer CRM Activities
|
|
8946
|
-
* @param {
|
|
8947
|
-
* @param {
|
|
8948
|
-
* @param {
|
|
8946
|
+
* @param {number} id Account ID
|
|
8947
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
8948
|
+
* @param {number} userId Activity Created By
|
|
8949
8949
|
* @param {*} [options] Override http request option.
|
|
8950
8950
|
* @throws {RequiredError}
|
|
8951
8951
|
*/
|
|
8952
|
-
getGetCrmActivities: (id:
|
|
8952
|
+
getGetCrmActivities: (id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8953
8953
|
/**
|
|
8954
8954
|
* Search for contacts by phone number
|
|
8955
8955
|
* @param {*} [options] Override http request option.
|
|
@@ -8958,12 +8958,12 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
8958
8958
|
getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8959
8959
|
/**
|
|
8960
8960
|
* Create CRM Note
|
|
8961
|
-
* @param {
|
|
8961
|
+
* @param {number} id Account ID
|
|
8962
8962
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
8963
8963
|
* @param {*} [options] Override http request option.
|
|
8964
8964
|
* @throws {RequiredError}
|
|
8965
8965
|
*/
|
|
8966
|
-
postCreateCrmNote: (id:
|
|
8966
|
+
postCreateCrmNote: (id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8967
8967
|
};
|
|
8968
8968
|
/**
|
|
8969
8969
|
* CRMApi - functional programming interface
|
|
@@ -8971,13 +8971,13 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
8971
8971
|
export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
8972
8972
|
/**
|
|
8973
8973
|
* Get Customer CRM Activities
|
|
8974
|
-
* @param {
|
|
8975
|
-
* @param {
|
|
8976
|
-
* @param {
|
|
8974
|
+
* @param {number} id Account ID
|
|
8975
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
8976
|
+
* @param {number} userId Activity Created By
|
|
8977
8977
|
* @param {*} [options] Override http request option.
|
|
8978
8978
|
* @throws {RequiredError}
|
|
8979
8979
|
*/
|
|
8980
|
-
getGetCrmActivities(id:
|
|
8980
|
+
getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>>;
|
|
8981
8981
|
/**
|
|
8982
8982
|
* Search for contacts by phone number
|
|
8983
8983
|
* @param {*} [options] Override http request option.
|
|
@@ -8986,12 +8986,12 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
8986
8986
|
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
|
|
8987
8987
|
/**
|
|
8988
8988
|
* Create CRM Note
|
|
8989
|
-
* @param {
|
|
8989
|
+
* @param {number} id Account ID
|
|
8990
8990
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
8991
8991
|
* @param {*} [options] Override http request option.
|
|
8992
8992
|
* @throws {RequiredError}
|
|
8993
8993
|
*/
|
|
8994
|
-
postCreateCrmNote(id:
|
|
8994
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>>;
|
|
8995
8995
|
};
|
|
8996
8996
|
/**
|
|
8997
8997
|
* CRMApi - factory interface
|
|
@@ -8999,13 +8999,13 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
8999
8999
|
export declare const CRMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9000
9000
|
/**
|
|
9001
9001
|
* Get Customer CRM Activities
|
|
9002
|
-
* @param {
|
|
9003
|
-
* @param {
|
|
9004
|
-
* @param {
|
|
9002
|
+
* @param {number} id Account ID
|
|
9003
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
9004
|
+
* @param {number} userId Activity Created By
|
|
9005
9005
|
* @param {*} [options] Override http request option.
|
|
9006
9006
|
* @throws {RequiredError}
|
|
9007
9007
|
*/
|
|
9008
|
-
getGetCrmActivities(id:
|
|
9008
|
+
getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>>;
|
|
9009
9009
|
/**
|
|
9010
9010
|
* Search for contacts by phone number
|
|
9011
9011
|
* @param {*} [options] Override http request option.
|
|
@@ -9014,12 +9014,12 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
9014
9014
|
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
|
|
9015
9015
|
/**
|
|
9016
9016
|
* Create CRM Note
|
|
9017
|
-
* @param {
|
|
9017
|
+
* @param {number} id Account ID
|
|
9018
9018
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
9019
9019
|
* @param {*} [options] Override http request option.
|
|
9020
9020
|
* @throws {RequiredError}
|
|
9021
9021
|
*/
|
|
9022
|
-
postCreateCrmNote(id:
|
|
9022
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto>;
|
|
9023
9023
|
};
|
|
9024
9024
|
/**
|
|
9025
9025
|
* CRMApi - object-oriented interface
|
|
@@ -9027,13 +9027,13 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
9027
9027
|
export declare class CRMApi extends BaseAPI {
|
|
9028
9028
|
/**
|
|
9029
9029
|
* Get Customer CRM Activities
|
|
9030
|
-
* @param {
|
|
9031
|
-
* @param {
|
|
9032
|
-
* @param {
|
|
9030
|
+
* @param {number} id Account ID
|
|
9031
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
9032
|
+
* @param {number} userId Activity Created By
|
|
9033
9033
|
* @param {*} [options] Override http request option.
|
|
9034
9034
|
* @throws {RequiredError}
|
|
9035
9035
|
*/
|
|
9036
|
-
getGetCrmActivities(id:
|
|
9036
|
+
getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDto[], any, {}>>;
|
|
9037
9037
|
/**
|
|
9038
9038
|
* Search for contacts by phone number
|
|
9039
9039
|
* @param {*} [options] Override http request option.
|
|
@@ -9042,13 +9042,22 @@ export declare class CRMApi extends BaseAPI {
|
|
|
9042
9042
|
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}>>;
|
|
9043
9043
|
/**
|
|
9044
9044
|
* Create CRM Note
|
|
9045
|
-
* @param {
|
|
9045
|
+
* @param {number} id Account ID
|
|
9046
9046
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
9047
9047
|
* @param {*} [options] Override http request option.
|
|
9048
9048
|
* @throws {RequiredError}
|
|
9049
9049
|
*/
|
|
9050
|
-
postCreateCrmNote(id:
|
|
9050
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDto, any, {}>>;
|
|
9051
9051
|
}
|
|
9052
|
+
export declare const GetGetCrmActivitiesTypeEnum: {
|
|
9053
|
+
readonly Alert: "alert";
|
|
9054
|
+
readonly Call: "call";
|
|
9055
|
+
readonly Note: "note";
|
|
9056
|
+
readonly Order: "order";
|
|
9057
|
+
readonly Quote: "quote";
|
|
9058
|
+
readonly TcxOrder: "tcx_order";
|
|
9059
|
+
};
|
|
9060
|
+
export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[keyof typeof GetGetCrmActivitiesTypeEnum];
|
|
9052
9061
|
/**
|
|
9053
9062
|
* Class3CXApi - axios parameter creator
|
|
9054
9063
|
*/
|
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 = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = 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 = void 0;
|
|
87
|
+
exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = 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.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
|
|
88
|
+
exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = 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.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = 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 = 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 = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = 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 = void 0;
|
|
90
90
|
var axios_1 = require("axios");
|
|
91
91
|
// Some imports not used depending on template conditions
|
|
92
92
|
// @ts-ignore
|
|
@@ -2860,9 +2860,9 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
2860
2860
|
return {
|
|
2861
2861
|
/**
|
|
2862
2862
|
* Get Customer CRM Activities
|
|
2863
|
-
* @param {
|
|
2864
|
-
* @param {
|
|
2865
|
-
* @param {
|
|
2863
|
+
* @param {number} id Account ID
|
|
2864
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
2865
|
+
* @param {number} userId Activity Created By
|
|
2866
2866
|
* @param {*} [options] Override http request option.
|
|
2867
2867
|
* @throws {RequiredError}
|
|
2868
2868
|
*/
|
|
@@ -2942,7 +2942,7 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
2942
2942
|
},
|
|
2943
2943
|
/**
|
|
2944
2944
|
* Create CRM Note
|
|
2945
|
-
* @param {
|
|
2945
|
+
* @param {number} id Account ID
|
|
2946
2946
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
2947
2947
|
* @param {*} [options] Override http request option.
|
|
2948
2948
|
* @throws {RequiredError}
|
|
@@ -2991,9 +2991,9 @@ var CRMApiFp = function (configuration) {
|
|
|
2991
2991
|
return {
|
|
2992
2992
|
/**
|
|
2993
2993
|
* Get Customer CRM Activities
|
|
2994
|
-
* @param {
|
|
2995
|
-
* @param {
|
|
2996
|
-
* @param {
|
|
2994
|
+
* @param {number} id Account ID
|
|
2995
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
2996
|
+
* @param {number} userId Activity Created By
|
|
2997
2997
|
* @param {*} [options] Override http request option.
|
|
2998
2998
|
* @throws {RequiredError}
|
|
2999
2999
|
*/
|
|
@@ -3036,7 +3036,7 @@ var CRMApiFp = function (configuration) {
|
|
|
3036
3036
|
},
|
|
3037
3037
|
/**
|
|
3038
3038
|
* Create CRM Note
|
|
3039
|
-
* @param {
|
|
3039
|
+
* @param {number} id Account ID
|
|
3040
3040
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
3041
3041
|
* @param {*} [options] Override http request option.
|
|
3042
3042
|
* @throws {RequiredError}
|
|
@@ -3068,9 +3068,9 @@ var CRMApiFactory = function (configuration, basePath, axios) {
|
|
|
3068
3068
|
return {
|
|
3069
3069
|
/**
|
|
3070
3070
|
* Get Customer CRM Activities
|
|
3071
|
-
* @param {
|
|
3072
|
-
* @param {
|
|
3073
|
-
* @param {
|
|
3071
|
+
* @param {number} id Account ID
|
|
3072
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
3073
|
+
* @param {number} userId Activity Created By
|
|
3074
3074
|
* @param {*} [options] Override http request option.
|
|
3075
3075
|
* @throws {RequiredError}
|
|
3076
3076
|
*/
|
|
@@ -3087,7 +3087,7 @@ var CRMApiFactory = function (configuration, basePath, axios) {
|
|
|
3087
3087
|
},
|
|
3088
3088
|
/**
|
|
3089
3089
|
* Create CRM Note
|
|
3090
|
-
* @param {
|
|
3090
|
+
* @param {number} id Account ID
|
|
3091
3091
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
3092
3092
|
* @param {*} [options] Override http request option.
|
|
3093
3093
|
* @throws {RequiredError}
|
|
@@ -3108,9 +3108,9 @@ var CRMApi = /** @class */ (function (_super) {
|
|
|
3108
3108
|
}
|
|
3109
3109
|
/**
|
|
3110
3110
|
* Get Customer CRM Activities
|
|
3111
|
-
* @param {
|
|
3112
|
-
* @param {
|
|
3113
|
-
* @param {
|
|
3111
|
+
* @param {number} id Account ID
|
|
3112
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
3113
|
+
* @param {number} userId Activity Created By
|
|
3114
3114
|
* @param {*} [options] Override http request option.
|
|
3115
3115
|
* @throws {RequiredError}
|
|
3116
3116
|
*/
|
|
@@ -3129,7 +3129,7 @@ var CRMApi = /** @class */ (function (_super) {
|
|
|
3129
3129
|
};
|
|
3130
3130
|
/**
|
|
3131
3131
|
* Create CRM Note
|
|
3132
|
-
* @param {
|
|
3132
|
+
* @param {number} id Account ID
|
|
3133
3133
|
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
3134
3134
|
* @param {*} [options] Override http request option.
|
|
3135
3135
|
* @throws {RequiredError}
|
|
@@ -3141,6 +3141,14 @@ var CRMApi = /** @class */ (function (_super) {
|
|
|
3141
3141
|
return CRMApi;
|
|
3142
3142
|
}(base_1.BaseAPI));
|
|
3143
3143
|
exports.CRMApi = CRMApi;
|
|
3144
|
+
exports.GetGetCrmActivitiesTypeEnum = {
|
|
3145
|
+
Alert: 'alert',
|
|
3146
|
+
Call: 'call',
|
|
3147
|
+
Note: 'note',
|
|
3148
|
+
Order: 'order',
|
|
3149
|
+
Quote: 'quote',
|
|
3150
|
+
TcxOrder: 'tcx_order'
|
|
3151
|
+
};
|
|
3144
3152
|
/**
|
|
3145
3153
|
* Class3CXApi - axios parameter creator
|
|
3146
3154
|
*/
|
package/docs/CRMApi.md
CHANGED
|
@@ -24,9 +24,9 @@ import {
|
|
|
24
24
|
const configuration = new Configuration();
|
|
25
25
|
const apiInstance = new CRMApi(configuration);
|
|
26
26
|
|
|
27
|
-
let id:
|
|
28
|
-
let type:
|
|
29
|
-
let userId:
|
|
27
|
+
let id: number; //Account ID (default to undefined)
|
|
28
|
+
let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (default to undefined)
|
|
29
|
+
let userId: number; //Activity Created By (default to undefined)
|
|
30
30
|
|
|
31
31
|
const { status, data } = await apiInstance.getGetCrmActivities(
|
|
32
32
|
id,
|
|
@@ -39,9 +39,9 @@ const { status, data } = await apiInstance.getGetCrmActivities(
|
|
|
39
39
|
|
|
40
40
|
|Name | Type | Description | Notes|
|
|
41
41
|
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **id** | [**
|
|
43
|
-
| **type** | [**
|
|
44
|
-
| **userId** | [**
|
|
42
|
+
| **id** | [**number**] | Account ID | defaults to undefined|
|
|
43
|
+
| **type** | [**'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'**]**Array<'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'>** | Activity Type | defaults to undefined|
|
|
44
|
+
| **userId** | [**number**] | Activity Created By | defaults to undefined|
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
@@ -132,7 +132,7 @@ import {
|
|
|
132
132
|
const configuration = new Configuration();
|
|
133
133
|
const apiInstance = new CRMApi(configuration);
|
|
134
134
|
|
|
135
|
-
let id:
|
|
135
|
+
let id: number; //Account ID (default to undefined)
|
|
136
136
|
let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //CRM Note Request (optional)
|
|
137
137
|
|
|
138
138
|
const { status, data } = await apiInstance.postCreateCrmNote(
|
|
@@ -146,7 +146,7 @@ const { status, data } = await apiInstance.postCreateCrmNote(
|
|
|
146
146
|
|Name | Type | Description | Notes|
|
|
147
147
|
|------------- | ------------- | ------------- | -------------|
|
|
148
148
|
| **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**| CRM Note Request | |
|
|
149
|
-
| **id** | [**
|
|
149
|
+
| **id** | [**number**] | Account ID | defaults to undefined|
|
|
150
150
|
|
|
151
151
|
|
|
152
152
|
### Return type
|