yellowgrid-api-ts 3.2.121-dev.0 → 3.2.123-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 CHANGED
@@ -10123,19 +10123,15 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
10123
10123
  return {
10124
10124
  /**
10125
10125
  * Get Customer CRM Activities
10126
- * @param {string} id Xero ID
10127
- * @param {string} type Activity Type
10128
- * @param {string} userId Activity Created By
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: string, type: string, userId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
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
- // verify required parameter 'type' is not null or undefined
10136
- assertParamExists('getGetCrmActivities', 'type', type)
10137
- // verify required parameter 'userId' is not null or undefined
10138
- assertParamExists('getGetCrmActivities', 'userId', userId)
10139
10135
  const localVarPath = `/admin/crm/{id}/activities`
10140
10136
  .replace(`{${"id"}}`, encodeURIComponent(String(id)));
10141
10137
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -10199,12 +10195,12 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
10199
10195
  },
10200
10196
  /**
10201
10197
  * Create CRM Note
10202
- * @param {string} id Xero ID
10198
+ * @param {number} id Account ID
10203
10199
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
10204
10200
  * @param {*} [options] Override http request option.
10205
10201
  * @throws {RequiredError}
10206
10202
  */
10207
- postCreateCrmNote: async (id: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10203
+ postCreateCrmNote: async (id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10208
10204
  // verify required parameter 'id' is not null or undefined
10209
10205
  assertParamExists('postCreateCrmNote', 'id', id)
10210
10206
  const localVarPath = `/admin/crm/{id}/activities/note`
@@ -10244,13 +10240,13 @@ export const CRMApiFp = function(configuration?: Configuration) {
10244
10240
  return {
10245
10241
  /**
10246
10242
  * Get Customer CRM Activities
10247
- * @param {string} id Xero ID
10248
- * @param {string} type Activity Type
10249
- * @param {string} userId Activity Created By
10243
+ * @param {number} id Account ID
10244
+ * @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
10245
+ * @param {number} [userId] Activity Created By
10250
10246
  * @param {*} [options] Override http request option.
10251
10247
  * @throws {RequiredError}
10252
10248
  */
10253
- async getGetCrmActivities(id: string, type: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>> {
10249
+ async getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>> {
10254
10250
  const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options);
10255
10251
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10256
10252
  const localVarOperationServerBasePath = operationServerMap['CRMApi.getGetCrmActivities']?.[localVarOperationServerIndex]?.url;
@@ -10269,12 +10265,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
10269
10265
  },
10270
10266
  /**
10271
10267
  * Create CRM Note
10272
- * @param {string} id Xero ID
10268
+ * @param {number} id Account ID
10273
10269
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
10274
10270
  * @param {*} [options] Override http request option.
10275
10271
  * @throws {RequiredError}
10276
10272
  */
10277
- async postCreateCrmNote(id: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>> {
10273
+ async postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>> {
10278
10274
  const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateCrmNote(id, postCreateCrmNoteRequest, options);
10279
10275
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10280
10276
  const localVarOperationServerBasePath = operationServerMap['CRMApi.postCreateCrmNote']?.[localVarOperationServerIndex]?.url;
@@ -10291,13 +10287,13 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
10291
10287
  return {
10292
10288
  /**
10293
10289
  * Get Customer CRM Activities
10294
- * @param {string} id Xero ID
10295
- * @param {string} type Activity Type
10296
- * @param {string} userId Activity Created By
10290
+ * @param {number} id Account ID
10291
+ * @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
10292
+ * @param {number} [userId] Activity Created By
10297
10293
  * @param {*} [options] Override http request option.
10298
10294
  * @throws {RequiredError}
10299
10295
  */
10300
- getGetCrmActivities(id: string, type: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>> {
10296
+ getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>> {
10301
10297
  return localVarFp.getGetCrmActivities(id, type, userId, options).then((request) => request(axios, basePath));
10302
10298
  },
10303
10299
  /**
@@ -10310,12 +10306,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
10310
10306
  },
10311
10307
  /**
10312
10308
  * Create CRM Note
10313
- * @param {string} id Xero ID
10309
+ * @param {number} id Account ID
10314
10310
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
10315
10311
  * @param {*} [options] Override http request option.
10316
10312
  * @throws {RequiredError}
10317
10313
  */
10318
- postCreateCrmNote(id: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto> {
10314
+ postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto> {
10319
10315
  return localVarFp.postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(axios, basePath));
10320
10316
  },
10321
10317
  };
@@ -10327,13 +10323,13 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
10327
10323
  export class CRMApi extends BaseAPI {
10328
10324
  /**
10329
10325
  * Get Customer CRM Activities
10330
- * @param {string} id Xero ID
10331
- * @param {string} type Activity Type
10332
- * @param {string} userId Activity Created By
10326
+ * @param {number} id Account ID
10327
+ * @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
10328
+ * @param {number} [userId] Activity Created By
10333
10329
  * @param {*} [options] Override http request option.
10334
10330
  * @throws {RequiredError}
10335
10331
  */
10336
- public getGetCrmActivities(id: string, type: string, userId: string, options?: RawAxiosRequestConfig) {
10332
+ public getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig) {
10337
10333
  return CRMApiFp(this.configuration).getGetCrmActivities(id, type, userId, options).then((request) => request(this.axios, this.basePath));
10338
10334
  }
10339
10335
 
@@ -10348,16 +10344,25 @@ export class CRMApi extends BaseAPI {
10348
10344
 
10349
10345
  /**
10350
10346
  * Create CRM Note
10351
- * @param {string} id Xero ID
10347
+ * @param {number} id Account ID
10352
10348
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
10353
10349
  * @param {*} [options] Override http request option.
10354
10350
  * @throws {RequiredError}
10355
10351
  */
10356
- public postCreateCrmNote(id: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) {
10352
+ public postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) {
10357
10353
  return CRMApiFp(this.configuration).postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(this.axios, this.basePath));
10358
10354
  }
10359
10355
  }
10360
10356
 
10357
+ export const GetGetCrmActivitiesTypeEnum = {
10358
+ Alert: 'alert',
10359
+ Call: 'call',
10360
+ Note: 'note',
10361
+ Order: 'order',
10362
+ Quote: 'quote',
10363
+ TcxOrder: 'tcx_order'
10364
+ } as const;
10365
+ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[keyof typeof GetGetCrmActivitiesTypeEnum];
10361
10366
 
10362
10367
 
10363
10368
  /**
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 {string} id Xero ID
8947
- * @param {string} type Activity Type
8948
- * @param {string} userId Activity Created By
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: string, type: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
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 {string} id Xero ID
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: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
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 {string} id Xero ID
8975
- * @param {string} type Activity Type
8976
- * @param {string} userId Activity Created By
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: string, type: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>>;
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 {string} id Xero ID
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: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>>;
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 {string} id Xero ID
9003
- * @param {string} type Activity Type
9004
- * @param {string} userId Activity Created By
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: string, type: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>>;
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 {string} id Xero ID
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: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto>;
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 {string} id Xero ID
9031
- * @param {string} type Activity Type
9032
- * @param {string} userId Activity Created By
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: string, type: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDto[], any, {}>>;
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 {string} id Xero ID
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: string, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDto, any, {}>>;
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.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = 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.GetGetPriceListTypeEnum = 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 = 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 = 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 {string} id Xero ID
2864
- * @param {string} type Activity Type
2865
- * @param {string} userId Activity Created By
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
  */
@@ -2877,10 +2877,6 @@ var CRMApiAxiosParamCreator = function (configuration) {
2877
2877
  return __generator(this, function (_a) {
2878
2878
  // verify required parameter 'id' is not null or undefined
2879
2879
  (0, common_1.assertParamExists)('getGetCrmActivities', 'id', id);
2880
- // verify required parameter 'type' is not null or undefined
2881
- (0, common_1.assertParamExists)('getGetCrmActivities', 'type', type);
2882
- // verify required parameter 'userId' is not null or undefined
2883
- (0, common_1.assertParamExists)('getGetCrmActivities', 'userId', userId);
2884
2880
  localVarPath = "/admin/crm/{id}/activities"
2885
2881
  .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
2886
2882
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -2942,7 +2938,7 @@ var CRMApiAxiosParamCreator = function (configuration) {
2942
2938
  },
2943
2939
  /**
2944
2940
  * Create CRM Note
2945
- * @param {string} id Xero ID
2941
+ * @param {number} id Account ID
2946
2942
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
2947
2943
  * @param {*} [options] Override http request option.
2948
2944
  * @throws {RequiredError}
@@ -2991,9 +2987,9 @@ var CRMApiFp = function (configuration) {
2991
2987
  return {
2992
2988
  /**
2993
2989
  * Get Customer CRM Activities
2994
- * @param {string} id Xero ID
2995
- * @param {string} type Activity Type
2996
- * @param {string} userId Activity Created By
2990
+ * @param {number} id Account ID
2991
+ * @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
2992
+ * @param {number} [userId] Activity Created By
2997
2993
  * @param {*} [options] Override http request option.
2998
2994
  * @throws {RequiredError}
2999
2995
  */
@@ -3036,7 +3032,7 @@ var CRMApiFp = function (configuration) {
3036
3032
  },
3037
3033
  /**
3038
3034
  * Create CRM Note
3039
- * @param {string} id Xero ID
3035
+ * @param {number} id Account ID
3040
3036
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
3041
3037
  * @param {*} [options] Override http request option.
3042
3038
  * @throws {RequiredError}
@@ -3068,9 +3064,9 @@ var CRMApiFactory = function (configuration, basePath, axios) {
3068
3064
  return {
3069
3065
  /**
3070
3066
  * Get Customer CRM Activities
3071
- * @param {string} id Xero ID
3072
- * @param {string} type Activity Type
3073
- * @param {string} userId Activity Created By
3067
+ * @param {number} id Account ID
3068
+ * @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
3069
+ * @param {number} [userId] Activity Created By
3074
3070
  * @param {*} [options] Override http request option.
3075
3071
  * @throws {RequiredError}
3076
3072
  */
@@ -3087,7 +3083,7 @@ var CRMApiFactory = function (configuration, basePath, axios) {
3087
3083
  },
3088
3084
  /**
3089
3085
  * Create CRM Note
3090
- * @param {string} id Xero ID
3086
+ * @param {number} id Account ID
3091
3087
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
3092
3088
  * @param {*} [options] Override http request option.
3093
3089
  * @throws {RequiredError}
@@ -3108,9 +3104,9 @@ var CRMApi = /** @class */ (function (_super) {
3108
3104
  }
3109
3105
  /**
3110
3106
  * Get Customer CRM Activities
3111
- * @param {string} id Xero ID
3112
- * @param {string} type Activity Type
3113
- * @param {string} userId Activity Created By
3107
+ * @param {number} id Account ID
3108
+ * @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
3109
+ * @param {number} [userId] Activity Created By
3114
3110
  * @param {*} [options] Override http request option.
3115
3111
  * @throws {RequiredError}
3116
3112
  */
@@ -3129,7 +3125,7 @@ var CRMApi = /** @class */ (function (_super) {
3129
3125
  };
3130
3126
  /**
3131
3127
  * Create CRM Note
3132
- * @param {string} id Xero ID
3128
+ * @param {number} id Account ID
3133
3129
  * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
3134
3130
  * @param {*} [options] Override http request option.
3135
3131
  * @throws {RequiredError}
@@ -3141,6 +3137,14 @@ var CRMApi = /** @class */ (function (_super) {
3141
3137
  return CRMApi;
3142
3138
  }(base_1.BaseAPI));
3143
3139
  exports.CRMApi = CRMApi;
3140
+ exports.GetGetCrmActivitiesTypeEnum = {
3141
+ Alert: 'alert',
3142
+ Call: 'call',
3143
+ Note: 'note',
3144
+ Order: 'order',
3145
+ Quote: 'quote',
3146
+ TcxOrder: 'tcx_order'
3147
+ };
3144
3148
  /**
3145
3149
  * Class3CXApi - axios parameter creator
3146
3150
  */
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: string; //Xero ID (default to undefined)
28
- let type: string; //Activity Type (default to undefined)
29
- let userId: string; //Activity Created By (default to undefined)
27
+ let id: number; //Account ID (default to undefined)
28
+ let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
29
+ let userId: number; //Activity Created By (optional) (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** | [**string**] | Xero ID | defaults to undefined|
43
- | **type** | [**string**] | Activity Type | defaults to undefined|
44
- | **userId** | [**string**] | Activity Created By | defaults to undefined|
42
+ | **id** | [**number**] | Account ID | defaults to undefined|
43
+ | **type** | [**&#39;alert&#39; | &#39;call&#39; | &#39;note&#39; | &#39;order&#39; | &#39;quote&#39; | &#39;tcx_order&#39;**]**Array<&#39;alert&#39; &#124; &#39;call&#39; &#124; &#39;note&#39; &#124; &#39;order&#39; &#124; &#39;quote&#39; &#124; &#39;tcx_order&#39;>** | Activity Type | (optional) defaults to undefined|
44
+ | **userId** | [**number**] | Activity Created By | (optional) 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: string; //Xero ID (default to undefined)
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** | [**string**] | Xero ID | defaults to undefined|
149
+ | **id** | [**number**] | Account ID | defaults to undefined|
150
150
 
151
151
 
152
152
  ### Return type
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.121-dev.0",
3
+ "version": "3.2.123-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {