yellowgrid-api-ts 3.2.346 → 3.2.347

package/api.ts

@@ -20423,10 +20423,13 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
         },
         /**
          * Search for contacts by phone number
+         * @param {string} phone Phone Number
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getSearchByPhone: async (phone: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'phone' is not null or undefined
+            assertParamExists('getSearchByPhone', 'phone', phone)
             const localVarPath = `/crm/contact/search`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -20439,6 +20442,10 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
+            if (phone !== undefined) {
+                localVarQueryParameter['phone'] = phone;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -20547,11 +20554,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
         },
         /**
          * Search for contacts by phone number
+         * @param {string} phone Phone Number
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(options);
+        async getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(phone, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['CRMApi.getSearchByPhone']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -20604,11 +20612,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
         },
         /**
          * Search for contacts by phone number
+         * @param {string} phone Phone Number
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
-            return localVarFp.getSearchByPhone(options).then((request) => request(axios, basePath));
+        getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
+            return localVarFp.getSearchByPhone(phone, options).then((request) => request(axios, basePath));
         },
         /**
          * Create CRM Note
@@ -20651,11 +20660,12 @@ export class CRMApi extends BaseAPI {
 
     /**
      * Search for contacts by phone number
+     * @param {string} phone Phone Number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getSearchByPhone(options?: RawAxiosRequestConfig) {
-        return CRMApiFp(this.configuration).getSearchByPhone(options).then((request) => request(this.axios, this.basePath));
+    public getSearchByPhone(phone: string, options?: RawAxiosRequestConfig) {
+        return CRMApiFp(this.configuration).getSearchByPhone(phone, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api.d.ts

@@ -15337,10 +15337,11 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
     getGetCrmActivities: (id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Search for contacts by phone number
+     * @param {string} phone Phone Number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getSearchByPhone: (phone: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create CRM Note
      * @param {number} id Account ID
@@ -15373,10 +15374,11 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
     getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDTO>>;
     /**
      * Search for contacts by phone number
+     * @param {string} phone Phone Number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
+    getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
     /**
      * Create CRM Note
      * @param {number} id Account ID
@@ -15409,10 +15411,11 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
     getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDTO>;
     /**
      * Search for contacts by phone number
+     * @param {string} phone Phone Number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
+    getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
     /**
      * Create CRM Note
      * @param {number} id Account ID
@@ -15445,10 +15448,11 @@ export declare class CRMApi extends BaseAPI {
     getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivitiesResponseDTO, any, {}, any>>;
     /**
      * Search for contacts by phone number
+     * @param {string} phone Phone Number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}, any>>;
+    getSearchByPhone(phone: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}, any>>;
     /**
      * Create CRM Note
      * @param {number} id Account ID

package/dist/api.js

@@ -11316,18 +11316,21 @@ var CRMApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Search for contacts by phone number
+         * @param {string} phone Phone Number
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSearchByPhone: function () {
+        getSearchByPhone: function (phone_1) {
             var args_1 = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args_1[_i] = arguments[_i];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
             }
-            return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
+            return __awaiter(_this, __spreadArray([phone_1], args_1, true), void 0, function (phone, options) {
                 var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
                 if (options === void 0) { options = {}; }
                 return __generator(this, function (_a) {
+                    // verify required parameter 'phone' is not null or undefined
+                    (0, common_1.assertParamExists)('getSearchByPhone', 'phone', phone);
                     localVarPath = "/crm/contact/search";
                     localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
                     if (configuration) {
@@ -11336,6 +11339,9 @@ var CRMApiAxiosParamCreator = function (configuration) {
                     localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
                     localVarHeaderParameter = {};
                     localVarQueryParameter = {};
+                    if (phone !== undefined) {
+                        localVarQueryParameter['phone'] = phone;
+                    }
                     localVarHeaderParameter['Accept'] = 'application/json';
                     (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
                     headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -11462,16 +11468,17 @@ var CRMApiFp = function (configuration) {
         },
         /**
          * Search for contacts by phone number
+         * @param {string} phone Phone Number
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSearchByPhone: function (options) {
+        getSearchByPhone: function (phone, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
                 var _a, _b, _c;
                 return __generator(this, function (_d) {
                     switch (_d.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(phone, options)];
                         case 1:
                             localVarAxiosArgs = _d.sent();
                             localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -11549,11 +11556,12 @@ var CRMApiFactory = function (configuration, basePath, axios) {
         },
         /**
          * Search for contacts by phone number
+         * @param {string} phone Phone Number
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSearchByPhone: function (options) {
-            return localVarFp.getSearchByPhone(options).then(function (request) { return request(axios, basePath); });
+        getSearchByPhone: function (phone, options) {
+            return localVarFp.getSearchByPhone(phone, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Create CRM Note
@@ -11600,12 +11608,13 @@ var CRMApi = /** @class */ (function (_super) {
     };
     /**
      * Search for contacts by phone number
+     * @param {string} phone Phone Number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    CRMApi.prototype.getSearchByPhone = function (options) {
+    CRMApi.prototype.getSearchByPhone = function (phone, options) {
         var _this = this;
-        return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(phone, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Create CRM Note

package/docs/CRMApi.md

@@ -85,11 +85,18 @@ import {
 const configuration = new Configuration();
 const apiInstance = new CRMApi(configuration);
 
-const { status, data } = await apiInstance.getSearchByPhone();
+let phone: string; //Phone Number (default to undefined)
+
+const { status, data } = await apiInstance.getSearchByPhone(
+    phone
+);
 ```
 
 ### Parameters
-This endpoint does not have any parameters.
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **phone** | [**string**] | Phone Number | defaults to undefined|
 
 
 ### Return type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.346",
+  "version": "3.2.347",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {