dataforseo-client 2.0.16 → 2.0.17

package/dist/cjs/models/SerpBingLocalPackLiveRegularRequestInfo.d.ts

@@ -1,60 +1,26 @@
 export interface ISerpBingLocalPackLiveRegularRequestInfo {
-    /** direct URL of the search query
-optional field
-you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
-example:
-https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE */
-    url?: string | undefined;
     /** keyword
 required field
 you can specify up to 700 characters in the keyword field
-all %## will be decoded (plus character ‘+’ will be decoded to a space character)
-if you need to use the “%” character for your keyword, please specify it as “%25”;
+all %## will be decoded (plus character '+' will be decoded to a space character)
+if you need to use the '%' character for your keyword, please specify it as '%25';
 if you need to use the “+” character for your keyword, please specify it as “%2B”;
 learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
     keyword?: string | undefined;
-    /** full name of search engine location
-required field if you don’t specify location_code or location_coordinate
-if you use this field, you don’t need to specify location_code or location_coordinate
-you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations
-example:
-London,England,United Kingdom */
-    location_name?: string | undefined;
     /** search engine location code
-required field if you don’t specify location_name or location_coordinate
-if you use this field, you don’t need to specify location_name or location_coordinate
-you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations
+required field if you don't specify location_name or location_coordinate
+if you use this field, you don't need to specify location_name or location_coordinate
+you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
 example:
 2840 */
     location_code?: number | undefined;
-    /** GPS coordinates of a location
-required field if you don’t specify location_name or location_code
-if you use this field, you don’t need to specify location_name or location_code
-location_coordinate parameter should be specified in the “latitude,longitude” format
-the maximum number of decimal digits for “latitude” and “longitude”: 7
-example:
-53.476225,-2.243572 */
-    location_coordinate?: string | undefined;
-    /** full name of search engine language
-required field if you don’t specify language_code
-if you use this field, you don’t need to specify language_code
-you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages
-example:
-English */
-    language_name?: string | undefined;
     /** search engine language code
-required field if you don’t specify language_name
-if you use this field, you don’t need to specify language_name
-you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages
+required field if you don't specify language_name
+if you use this field, you don't need to specify language_name
+you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
 example:
 en */
     language_code?: string | undefined;
-    /** device operating system
-optional field
-note that this API provides results for desktop only
-choose from the following values: windows, macos
-default value: windows */
-    os?: string | undefined;
     /** parsing depth
 optional field
 number of results in SERP
@@ -64,6 +30,32 @@ Your account will be billed per each SERP containing up to 5 results;
 Setting depth above 5 may result in additional charges if the search engine returns more than 5 results;
 The cost can be calculated on the Pricing page. */
     depth?: number | undefined;
+    /** full name of search engine location
+required field if you don't specify location_code or location_coordinate
+if you use this field, you don't need to specify location_code or location_coordinate
+you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
+example:
+London,England,United Kingdom */
+    location_name?: string | undefined;
+    /** full name of search engine language
+required field if you don't specify language_code
+if you use this field, you don't need to specify language_code
+you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
+example:
+English */
+    language_name?: string | undefined;
+    /** device operating system
+optional field
+note that this API provides results for desktop only
+choose from the following values: windows, macos
+default value: windows */
+    os?: string | undefined;
+    /** user-defined task identifier
+optional field
+the character limit is 255
+you can use this parameter to identify the task and match it with the result
+you will find the specified tag value in the data object of the response */
+    tag?: string | undefined;
     /** page crawl limit
 optional field
 number of search results pages to crawl
@@ -75,71 +67,45 @@ learn more at our help center */
 optional field
 get the list of available parameters and additional details here */
     search_param?: string | undefined;
-    /** user-defined task identifier
-optional field
-the character limit is 255
-you can use this parameter to identify the task and match it with the result
-you will find the specified tag value in the data object of the response */
-    tag?: string | undefined;
-    [key: string]: any;
-}
-export declare class SerpBingLocalPackLiveRegularRequestInfo implements ISerpBingLocalPackLiveRegularRequestInfo {
     /** direct URL of the search query
 optional field
 you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
 example:
 https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE */
     url?: string | undefined;
+    /** GPS coordinates of a location
+required field if you don't specify location_name or location_code
+if you use this field, you don't need to specify location_name or location_code
+location_coordinate parameter should be specified in the 'latitude,longitude' format
+the maximum number of decimal digits for 'latitude' and 'longitude': 7
+example:
+53.476225,-2.243572 */
+    location_coordinate?: string | undefined;
+    [key: string]: any;
+}
+export declare class SerpBingLocalPackLiveRegularRequestInfo implements ISerpBingLocalPackLiveRegularRequestInfo {
     /** keyword
 required field
 you can specify up to 700 characters in the keyword field
-all %## will be decoded (plus character ‘+’ will be decoded to a space character)
-if you need to use the “%” character for your keyword, please specify it as “%25”;
+all %## will be decoded (plus character '+' will be decoded to a space character)
+if you need to use the '%' character for your keyword, please specify it as '%25';
 if you need to use the “+” character for your keyword, please specify it as “%2B”;
 learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
     keyword?: string | undefined;
-    /** full name of search engine location
-required field if you don’t specify location_code or location_coordinate
-if you use this field, you don’t need to specify location_code or location_coordinate
-you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations
-example:
-London,England,United Kingdom */
-    location_name?: string | undefined;
     /** search engine location code
-required field if you don’t specify location_name or location_coordinate
-if you use this field, you don’t need to specify location_name or location_coordinate
-you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations
+required field if you don't specify location_name or location_coordinate
+if you use this field, you don't need to specify location_name or location_coordinate
+you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
 example:
 2840 */
     location_code?: number | undefined;
-    /** GPS coordinates of a location
-required field if you don’t specify location_name or location_code
-if you use this field, you don’t need to specify location_name or location_code
-location_coordinate parameter should be specified in the “latitude,longitude” format
-the maximum number of decimal digits for “latitude” and “longitude”: 7
-example:
-53.476225,-2.243572 */
-    location_coordinate?: string | undefined;
-    /** full name of search engine language
-required field if you don’t specify language_code
-if you use this field, you don’t need to specify language_code
-you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages
-example:
-English */
-    language_name?: string | undefined;
     /** search engine language code
-required field if you don’t specify language_name
-if you use this field, you don’t need to specify language_name
-you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages
+required field if you don't specify language_name
+if you use this field, you don't need to specify language_name
+you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
 example:
 en */
     language_code?: string | undefined;
-    /** device operating system
-optional field
-note that this API provides results for desktop only
-choose from the following values: windows, macos
-default value: windows */
-    os?: string | undefined;
     /** parsing depth
 optional field
 number of results in SERP
@@ -149,6 +115,32 @@ Your account will be billed per each SERP containing up to 5 results;
 Setting depth above 5 may result in additional charges if the search engine returns more than 5 results;
 The cost can be calculated on the Pricing page. */
     depth?: number | undefined;
+    /** full name of search engine location
+required field if you don't specify location_code or location_coordinate
+if you use this field, you don't need to specify location_code or location_coordinate
+you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
+example:
+London,England,United Kingdom */
+    location_name?: string | undefined;
+    /** full name of search engine language
+required field if you don't specify language_code
+if you use this field, you don't need to specify language_code
+you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
+example:
+English */
+    language_name?: string | undefined;
+    /** device operating system
+optional field
+note that this API provides results for desktop only
+choose from the following values: windows, macos
+default value: windows */
+    os?: string | undefined;
+    /** user-defined task identifier
+optional field
+the character limit is 255
+you can use this parameter to identify the task and match it with the result
+you will find the specified tag value in the data object of the response */
+    tag?: string | undefined;
     /** page crawl limit
 optional field
 number of search results pages to crawl
@@ -160,12 +152,20 @@ learn more at our help center */
 optional field
 get the list of available parameters and additional details here */
     search_param?: string | undefined;
-    /** user-defined task identifier
+    /** direct URL of the search query
 optional field
-the character limit is 255
-you can use this parameter to identify the task and match it with the result
-you will find the specified tag value in the data object of the response */
-    tag?: string | undefined;
+you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.
+example:
+https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE */
+    url?: string | undefined;
+    /** GPS coordinates of a location
+required field if you don't specify location_name or location_code
+if you use this field, you don't need to specify location_name or location_code
+location_coordinate parameter should be specified in the 'latitude,longitude' format
+the maximum number of decimal digits for 'latitude' and 'longitude': 7
+example:
+53.476225,-2.243572 */
+    location_coordinate?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingLocalPackLiveRegularRequestInfo);
     init(data?: any): void;

package/dist/cjs/models/SerpBingLocalPackLiveRegularRequestInfo.js

@@ -16,18 +16,18 @@ class SerpBingLocalPackLiveRegularRequestInfo {
                 if (data.hasOwnProperty(property))
                     this[property] = data[property];
             }
-            this.url = data["url"];
             this.keyword = data["keyword"];
-            this.location_name = data["location_name"];
             this.location_code = data["location_code"];
-            this.location_coordinate = data["location_coordinate"];
-            this.language_name = data["language_name"];
             this.language_code = data["language_code"];
-            this.os = data["os"];
             this.depth = data["depth"];
+            this.location_name = data["location_name"];
+            this.language_name = data["language_name"];
+            this.os = data["os"];
+            this.tag = data["tag"];
             this.max_crawl_pages = data["max_crawl_pages"];
             this.search_param = data["search_param"];
-            this.tag = data["tag"];
+            this.url = data["url"];
+            this.location_coordinate = data["location_coordinate"];
         }
     }
     static fromJS(data) {
@@ -38,18 +38,18 @@ class SerpBingLocalPackLiveRegularRequestInfo {
     }
     toJSON(data) {
         data = typeof data === 'object' ? data : {};
-        data["url"] = this.url;
         data["keyword"] = this.keyword;
-        data["location_name"] = this.location_name;
         data["location_code"] = this.location_code;
-        data["location_coordinate"] = this.location_coordinate;
-        data["language_name"] = this.language_name;
         data["language_code"] = this.language_code;
-        data["os"] = this.os;
         data["depth"] = this.depth;
+        data["location_name"] = this.location_name;
+        data["language_name"] = this.language_name;
+        data["os"] = this.os;
+        data["tag"] = this.tag;
         data["max_crawl_pages"] = this.max_crawl_pages;
         data["search_param"] = this.search_param;
-        data["tag"] = this.tag;
+        data["url"] = this.url;
+        data["location_coordinate"] = this.location_coordinate;
         return data;
     }
 }

package/dist/cjs/models/SerpBingLocalPackLiveRegularRequestInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"SerpBingLocalPackLiveRegularRequestInfo.js","sourceRoot":"","sources":["../../../src/models/SerpBingLocalPackLiveRegularRequestInfo.ts"],"names":[],"mappings":";;;AAoGA,MAAa,uCAAuC;IA+GhD,YAAY,IAA+C;QAE3D,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACvD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;YACzC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,uCAAuC,EAAE,CAAC;QAC3D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAI5C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACvD,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA3KD,0FA2KC"}
+{"version":3,"file":"SerpBingLocalPackLiveRegularRequestInfo.js","sourceRoot":"","sources":["../../../src/models/SerpBingLocalPackLiveRegularRequestInfo.ts"],"names":[],"mappings":";;;AAoGA,MAAa,uCAAuC;IA+GhD,YAAY,IAA+C;QAE3D,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;YACzC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,uCAAuC,EAAE,CAAC;QAC3D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAI5C,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACvD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA3KD,0FA2KC"}