yellowgrid-api-ts 3.2.122-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.
Files changed (5) hide show
  1. package/api.ts +12 -16
  2. package/dist/api.d.ts +12 -12
  3. package/dist/api.js +8 -12
  4. package/docs/CRMApi.md +4 -4
  5. package/package.json +1 -1
package/api.ts CHANGED
@@ -10124,18 +10124,14 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
10124
10124
  /**
10125
10125
  * Get Customer CRM Activities
10126
10126
  * @param {number} id Account ID
10127
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
10128
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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.
@@ -10245,12 +10241,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
10245
10241
  /**
10246
10242
  * Get Customer CRM Activities
10247
10243
  * @param {number} id Account ID
10248
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
10249
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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;
@@ -10292,12 +10288,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
10292
10288
  /**
10293
10289
  * Get Customer CRM Activities
10294
10290
  * @param {number} id Account ID
10295
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
10296
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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
  /**
@@ -10328,12 +10324,12 @@ export class CRMApi extends BaseAPI {
10328
10324
  /**
10329
10325
  * Get Customer CRM Activities
10330
10326
  * @param {number} id Account ID
10331
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
10332
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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
 
package/dist/api.d.ts CHANGED
@@ -8944,12 +8944,12 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
8944
8944
  /**
8945
8945
  * Get Customer CRM Activities
8946
8946
  * @param {number} id Account ID
8947
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
8948
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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.
@@ -8972,12 +8972,12 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
8972
8972
  /**
8973
8973
  * Get Customer CRM Activities
8974
8974
  * @param {number} id Account ID
8975
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
8976
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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.
@@ -9000,12 +9000,12 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
9000
9000
  /**
9001
9001
  * Get Customer CRM Activities
9002
9002
  * @param {number} id Account ID
9003
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
9004
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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.
@@ -9028,12 +9028,12 @@ export declare class CRMApi extends BaseAPI {
9028
9028
  /**
9029
9029
  * Get Customer CRM Activities
9030
9030
  * @param {number} id Account ID
9031
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
9032
- * @param {number} userId Activity Created By
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: number, type: GetGetCrmActivitiesTypeEnum, userId: number, 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.
package/dist/api.js CHANGED
@@ -2861,8 +2861,8 @@ var CRMApiAxiosParamCreator = function (configuration) {
2861
2861
  /**
2862
2862
  * Get Customer CRM Activities
2863
2863
  * @param {number} id Account ID
2864
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
2865
- * @param {number} userId Activity Created By
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);
@@ -2992,8 +2988,8 @@ var CRMApiFp = function (configuration) {
2992
2988
  /**
2993
2989
  * Get Customer CRM Activities
2994
2990
  * @param {number} id Account ID
2995
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
2996
- * @param {number} userId Activity Created By
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
  */
@@ -3069,8 +3065,8 @@ var CRMApiFactory = function (configuration, basePath, axios) {
3069
3065
  /**
3070
3066
  * Get Customer CRM Activities
3071
3067
  * @param {number} id Account ID
3072
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
3073
- * @param {number} userId Activity Created By
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
  */
@@ -3109,8 +3105,8 @@ var CRMApi = /** @class */ (function (_super) {
3109
3105
  /**
3110
3106
  * Get Customer CRM Activities
3111
3107
  * @param {number} id Account ID
3112
- * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
3113
- * @param {number} userId Activity Created By
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
  */
package/docs/CRMApi.md CHANGED
@@ -25,8 +25,8 @@ const configuration = new Configuration();
25
25
  const apiInstance = new CRMApi(configuration);
26
26
 
27
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)
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,
@@ -40,8 +40,8 @@ const { status, data } = await apiInstance.getGetCrmActivities(
40
40
  |Name | Type | Description | Notes|
41
41
  |------------- | ------------- | ------------- | -------------|
42
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 | defaults to undefined|
44
- | **userId** | [**number**] | Activity Created By | 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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.122-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": {