dataforseo-client 2.1.2 → 2.1.5

package/dist/esm/models/DataforseoTrendsGraphDataTrendsGraphDataInfo.d.ts

@@ -1,22 +1,22 @@
 export interface IDataforseoTrendsGraphDataTrendsGraphDataInfo {
-    /** start date of the corresponding time range in the UTC format: “yyyy-mm-dd” */
+    /** *start date of the corresponding time range* in the UTC format: 'yyyy-mm-dd' */
     date_from?: string | undefined;
-    /** end date of the corresponding time range in the UTC format: “yyyy-mm-dd” */
+    /** *end date of the corresponding time range* in the UTC format: 'yyyy-mm-dd' */
     date_to?: string | undefined;
-    /** a point in time in the Unix time format */
+    /** *a point in time in the [Unix time format](https://en.wikipedia.org/wiki/Unix_time)* */
     timestamp?: number | undefined;
-    /** relative keyword popularity rate at a specific timestamp represents the keyword popularity rate over the given time range if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term */
+    /** *relative keyword popularity rate at a specific timestamp* represents the keyword popularity rate over the given time range **if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords** a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term */
     values?: number[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoTrendsGraphDataTrendsGraphDataInfo implements IDataforseoTrendsGraphDataTrendsGraphDataInfo {
-    /** start date of the corresponding time range in the UTC format: “yyyy-mm-dd” */
+    /** *start date of the corresponding time range* in the UTC format: 'yyyy-mm-dd' */
     date_from?: string | undefined;
-    /** end date of the corresponding time range in the UTC format: “yyyy-mm-dd” */
+    /** *end date of the corresponding time range* in the UTC format: 'yyyy-mm-dd' */
     date_to?: string | undefined;
-    /** a point in time in the Unix time format */
+    /** *a point in time in the [Unix time format](https://en.wikipedia.org/wiki/Unix_time)* */
     timestamp?: number | undefined;
-    /** relative keyword popularity rate at a specific timestamp represents the keyword popularity rate over the given time range if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term */
+    /** *relative keyword popularity rate at a specific timestamp* represents the keyword popularity rate over the given time range **if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords** a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term */
     values?: number[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoTrendsGraphDataTrendsGraphDataInfo);

package/dist/esm/models/DataforseoTrendsinterestsInfo.d.ts

@@ -1,15 +1,15 @@
 import { DataforseoTrendsinterestsValuesInfo } from "./DataforseoTrendsinterestsValuesInfo";
 export interface IDataforseoTrendsinterestsInfo {
-    /** relevant keyword the data included in the values element is based on this keyword */
+    /** *relevant keyword* the data included in the `values` element is based on this keyword */
     keyword?: string | undefined;
-    /** contains data on relative keyword popularity by country or region */
+    /** *contains data on relative keyword popularity by country or region* */
     values?: DataforseoTrendsinterestsValuesInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoTrendsinterestsInfo implements IDataforseoTrendsinterestsInfo {
-    /** relevant keyword the data included in the values element is based on this keyword */
+    /** *relevant keyword* the data included in the `values` element is based on this keyword */
     keyword?: string | undefined;
-    /** contains data on relative keyword popularity by country or region */
+    /** *contains data on relative keyword popularity by country or region* */
     values?: DataforseoTrendsinterestsValuesInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoTrendsinterestsInfo);

package/dist/esm/models/DataforseoTrendsinterestsValuesInfo.d.ts

@@ -1,18 +1,18 @@
 export interface IDataforseoTrendsinterestsValuesInfo {
-    /** location identifier you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: US-NY */
+    /** *location identifier* you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their `geo_id` [here](/v3/keywords_data/dataforseo_trends/locations/) or by making a separate request to `https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations` example: `US-NY` */
     geo_id?: string | undefined;
-    /** location name you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: Andorra */
+    /** *location name* you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their `geo_name` [here](/v3/keywords_data/dataforseo_trends/locations/) or by making a separate request to `https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations` example: `Andorra` */
     geo_name?: string | undefined;
-    /** relative keyword popularity rate in a given location represents location-specific keyword popularity rate over the specified time range; using this value you can understand how popular a keyword is in one location compared to another location; calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100); a value of 100 is the highest popularity for the term a value of 50 means that the term is half as popular a value of 0 means there was not enough data for this term */
+    /** *relative keyword popularity rate in a given location* represents location-specific keyword popularity rate over the specified time range; using this `value` you can understand how popular a keyword is in one location compared to another location; calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100); a value of `100` is the highest popularity for the term a value of `50` means that the term is half as popular a value of `0` means there was not enough data for this term */
     value?: number | undefined;
     [key: string]: any;
 }
 export declare class DataforseoTrendsinterestsValuesInfo implements IDataforseoTrendsinterestsValuesInfo {
-    /** location identifier you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: US-NY */
+    /** *location identifier* you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their `geo_id` [here](/v3/keywords_data/dataforseo_trends/locations/) or by making a separate request to `https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations` example: `US-NY` */
     geo_id?: string | undefined;
-    /** location name you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: Andorra */
+    /** *location name* you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their `geo_name` [here](/v3/keywords_data/dataforseo_trends/locations/) or by making a separate request to `https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations` example: `Andorra` */
     geo_name?: string | undefined;
-    /** relative keyword popularity rate in a given location represents location-specific keyword popularity rate over the specified time range; using this value you can understand how popular a keyword is in one location compared to another location; calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100); a value of 100 is the highest popularity for the term a value of 50 means that the term is half as popular a value of 0 means there was not enough data for this term */
+    /** *relative keyword popularity rate in a given location* represents location-specific keyword popularity rate over the specified time range; using this `value` you can understand how popular a keyword is in one location compared to another location; calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100); a value of `100` is the highest popularity for the term a value of `50` means that the term is half as popular a value of `0` means there was not enough data for this term */
     value?: number | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoTrendsinterestsValuesInfo);

package/dist/esm/models/Demography.d.ts

@@ -1,15 +1,15 @@
 import { DataforseoTrendsDataInfo } from "./DataforseoTrendsDataInfo";
 export interface IDemography {
-    /** distribution of keyword popularity by age */
+    /** *distribution of keyword popularity by age* */
     age?: DataforseoTrendsDataInfo[] | undefined;
-    /** distribution of keyword popularity by gender */
+    /** *distribution of keyword popularity by gender* */
     gender?: DataforseoTrendsDataInfo[] | undefined;
     [key: string]: any;
 }
 export declare class Demography implements IDemography {
-    /** distribution of keyword popularity by age */
+    /** *distribution of keyword popularity by age* */
     age?: DataforseoTrendsDataInfo[] | undefined;
-    /** distribution of keyword popularity by gender */
+    /** *distribution of keyword popularity by gender* */
     gender?: DataforseoTrendsDataInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDemography);

package/dist/esm/models/DemographyItemValueInfo.d.ts

@@ -1,14 +1,14 @@
 export interface IDemographyItemValueInfo {
     /** type of element */
     type?: string | undefined;
-    /** keyword popularity rate within the specified age range using this value you can understand how popular a keyword is within each age range; calculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100); a value of 100 is the highest popularity for the term a value of 0 means there was not enough data for this term */
+    /** *keyword popularity rate within the specified age range* using this `value` you can understand how popular a keyword is within each age range;  calculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100); a value of `100` is the highest popularity for the term a value of `0` means there was not enough data for this term */
     value?: number | undefined;
     [key: string]: any;
 }
 export declare class DemographyItemValueInfo implements IDemographyItemValueInfo {
     /** type of element */
     type?: string | undefined;
-    /** keyword popularity rate within the specified age range using this value you can understand how popular a keyword is within each age range; calculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100); a value of 100 is the highest popularity for the term a value of 0 means there was not enough data for this term */
+    /** *keyword popularity rate within the specified age range* using this `value` you can understand how popular a keyword is within each age range;  calculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100); a value of `100` is the highest popularity for the term a value of `0` means there was not enough data for this term */
     value?: number | undefined;
     [key: string]: any;
     constructor(data?: IDemographyItemValueInfo);

package/dist/esm/models/DiscussionsAndForumsElement.d.ts

@@ -1,38 +1,38 @@
 export interface IDiscussionsAndForumsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** date and time when the result was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was published* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     timestamp?: string | undefined;
-    /** number of posts from the discussion on the related source */
+    /** *number of posts from the discussion on the related source* */
     posts_count?: number | undefined;
     [key: string]: any;
 }
 export declare class DiscussionsAndForumsElement implements IDiscussionsAndForumsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** date and time when the result was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was published* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     timestamp?: string | undefined;
-    /** number of posts from the discussion on the related source */
+    /** *number of posts from the discussion on the related source* */
     posts_count?: number | undefined;
     [key: string]: any;
     constructor(data?: IDiscussionsAndForumsElement);

package/dist/esm/models/DomainAnalyticsErrorsRequestInfo.d.ts

@@ -1,26 +1,26 @@
 export interface IDomainAnalyticsErrorsRequestInfo {
-    /** the maximum number of returned tasks that responded with an error optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned tasks that responded with an error* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned tasks optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
+    /** *offset in the results array of returned tasks* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
     offset?: number | undefined;
-    /** return tasks with a certain function use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the function fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by function example: domain_analytics/task_get, postback_url, pingback_url */
+    /** *return tasks with a certain function* use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the `function` fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by `function`  example: `domain_analytics/task_get`, `postback_url`, `pingback_url` */
     filtered_function?: string | undefined;
-    /** start time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 12:57:46 +00:00 */
+    /** *start time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 13:57:46 +00:00 */
+    /** *finish time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 13:57:46 +00:00` */
     datetime_to?: string | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsErrorsRequestInfo implements IDomainAnalyticsErrorsRequestInfo {
-    /** the maximum number of returned tasks that responded with an error optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned tasks that responded with an error* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned tasks optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
+    /** *offset in the results array of returned tasks* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
     offset?: number | undefined;
-    /** return tasks with a certain function use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the function fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by function example: domain_analytics/task_get, postback_url, pingback_url */
+    /** *return tasks with a certain function* use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the `function` fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by `function`  example: `domain_analytics/task_get`, `postback_url`, `pingback_url` */
     filtered_function?: string | undefined;
-    /** start time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 12:57:46 +00:00 */
+    /** *start time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 13:57:46 +00:00 */
+    /** *finish time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 13:57:46 +00:00` */
     datetime_to?: string | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsErrorsRequestInfo);

package/dist/esm/models/DomainAnalyticsErrorsResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { DomainAnalyticsErrorsTaskInfo } from "./DomainAnalyticsErrorsTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IDomainAnalyticsErrorsResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DomainAnalyticsErrorsTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsErrorsResponseInfo extends BaseResponseInfo implements IDomainAnalyticsErrorsResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DomainAnalyticsErrorsTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsErrorsResponseInfo);

package/dist/esm/models/DomainAnalyticsErrorsResultInfo.d.ts

@@ -1,46 +1,46 @@
 export interface IDomainAnalyticsErrorsResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** date and time when an error occurred in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when an error occurred* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     datetime?: string | undefined;
-    /** corresponding API function */
+    /** *corresponding API function* */
     function?: string | undefined;
-    /** error code */
+    /** *error code* */
     error_code?: number | undefined;
-    /** error message or error URL error message (see full list) or URL that caused an error */
+    /** *error message or error URL* error message [(see full list)](https://docs.dataforseo.com/v3/appendix/errors/) or URL that caused an error */
     error_message?: string | undefined;
-    /** URL that caused an error URL you used for making an API call or pingback/postback URL */
+    /** *URL that caused an error* URL you used for making an API call or pingback/postback URL */
     http_url?: string | undefined;
-    /** HTTP method */
+    /** *HTTP method* */
     http_method?: string | undefined;
-    /** HTTP status code */
+    /** *HTTP status code* */
     http_code?: number | undefined;
-    /** time taken by HTTP request for tasks set with a pingback/postback, this field will show the time it took your server to respond */
+    /** *time taken by HTTP request* for tasks set with a pingback/postback, this field will show the time it took your server to respond */
     http_time?: number | undefined;
-    /** HTTP response server response */
+    /** *HTTP response* server response */
     http_response?: string | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsErrorsResultInfo implements IDomainAnalyticsErrorsResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** date and time when an error occurred in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when an error occurred* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     datetime?: string | undefined;
-    /** corresponding API function */
+    /** *corresponding API function* */
     function?: string | undefined;
-    /** error code */
+    /** *error code* */
     error_code?: number | undefined;
-    /** error message or error URL error message (see full list) or URL that caused an error */
+    /** *error message or error URL* error message [(see full list)](https://docs.dataforseo.com/v3/appendix/errors/) or URL that caused an error */
     error_message?: string | undefined;
-    /** URL that caused an error URL you used for making an API call or pingback/postback URL */
+    /** *URL that caused an error* URL you used for making an API call or pingback/postback URL */
     http_url?: string | undefined;
-    /** HTTP method */
+    /** *HTTP method* */
     http_method?: string | undefined;
-    /** HTTP status code */
+    /** *HTTP status code* */
     http_code?: number | undefined;
-    /** time taken by HTTP request for tasks set with a pingback/postback, this field will show the time it took your server to respond */
+    /** *time taken by HTTP request* for tasks set with a pingback/postback, this field will show the time it took your server to respond */
     http_time?: number | undefined;
-    /** HTTP response server response */
+    /** *HTTP response* server response */
     http_response?: string | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsErrorsResultInfo);

package/dist/esm/models/DomainAnalyticsErrorsTaskInfo.d.ts

@@ -1,12 +1,12 @@
 import { DomainAnalyticsErrorsResultInfo } from "./DomainAnalyticsErrorsResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IDomainAnalyticsErrorsTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DomainAnalyticsErrorsResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsErrorsTaskInfo extends BaseResponseTaskInfo implements IDomainAnalyticsErrorsTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DomainAnalyticsErrorsResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsErrorsTaskInfo);

package/dist/esm/models/DomainAnalyticsIdListRequestInfo.d.ts

@@ -1,30 +1,30 @@
 export interface IDomainAnalyticsIdListRequestInfo {
-    /** start time for filtering results required field if include_metadata is set to true, maximum value: a month from current datetime; if include_metadata is set to false, maximum value: six months from current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *start time for filtering results* **required field** if `include_metadata` is set to `true`, maximum value: a month from current datetime; if `include_metadata` is set to `false`, maximum value: six months from current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results required field maximum value: current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-31 13:57:46 +00:00 */
+    /** *finish time for filtering results* **required field** maximum value: current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-31 13:57:46 +00:00` */
     datetime_to?: string | undefined;
-    /** the maximum number of returned task IDs optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned task IDs* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned task IDs optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted */
+    /** *offset in the results array of returned task IDs* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted */
     offset?: number | undefined;
-    /** sorting by task execution time optional field possible values: 'asc', 'desc' default value: 'asc' */
+    /** *sorting by task execution time* optional field possible values: `'asc'`, `'desc'` default value: `'asc'` */
     sort?: string | undefined;
-    /** include task metadata in the respond optional field default value: false */
+    /** *include task metadata in the respond* optional field default value: `false` */
     include_metadata?: boolean | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsIdListRequestInfo implements IDomainAnalyticsIdListRequestInfo {
-    /** start time for filtering results required field if include_metadata is set to true, maximum value: a month from current datetime; if include_metadata is set to false, maximum value: six months from current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *start time for filtering results* **required field** if `include_metadata` is set to `true`, maximum value: a month from current datetime; if `include_metadata` is set to `false`, maximum value: six months from current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results required field maximum value: current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-31 13:57:46 +00:00 */
+    /** *finish time for filtering results* **required field** maximum value: current datetime; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-31 13:57:46 +00:00` */
     datetime_to?: string | undefined;
-    /** the maximum number of returned task IDs optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned task IDs* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned task IDs optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted */
+    /** *offset in the results array of returned task IDs* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted */
     offset?: number | undefined;
-    /** sorting by task execution time optional field possible values: 'asc', 'desc' default value: 'asc' */
+    /** *sorting by task execution time* optional field possible values: `'asc'`, `'desc'` default value: `'asc'` */
     sort?: string | undefined;
-    /** include task metadata in the respond optional field default value: false */
+    /** *include task metadata in the respond* optional field default value: `false` */
     include_metadata?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsIdListRequestInfo);

package/dist/esm/models/DomainAnalyticsIdListResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { DomainAnalyticsIdListTaskInfo } from "./DomainAnalyticsIdListTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IDomainAnalyticsIdListResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DomainAnalyticsIdListTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsIdListResponseInfo extends BaseResponseInfo implements IDomainAnalyticsIdListResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DomainAnalyticsIdListTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsIdListResponseInfo);

package/dist/esm/models/DomainAnalyticsIdListResultInfo.d.ts

@@ -1,36 +1,36 @@
 export interface IDomainAnalyticsIdListResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** URL of the task URL you used for making an API call */
+    /** *URL of the task* URL you used for making an API call */
     url?: string | undefined;
-    /** date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was made* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_posted?: string | undefined;
-    /** date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was completed* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_done?: string | undefined;
-    /** informational message of the task you can find the full list of general informational messages here */
+    /** *informational message of the task* you can find the full list of general informational messages [here](/v3/appendix-errors/) */
     status?: string | undefined;
-    /** total tasks cost, USD */
+    /** *total tasks cost, USD* */
     cost?: number | undefined;
-    /** contains parameters you specified in the POST request */
+    /** *contains parameters you specified in the POST request* */
     metadata?: {
         [key: string]: any;
     } | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsIdListResultInfo implements IDomainAnalyticsIdListResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** URL of the task URL you used for making an API call */
+    /** *URL of the task* URL you used for making an API call */
     url?: string | undefined;
-    /** date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was made* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_posted?: string | undefined;
-    /** date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was completed* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_done?: string | undefined;
-    /** informational message of the task you can find the full list of general informational messages here */
+    /** *informational message of the task* you can find the full list of general informational messages [here](/v3/appendix-errors/) */
     status?: string | undefined;
-    /** total tasks cost, USD */
+    /** *total tasks cost, USD* */
     cost?: number | undefined;
-    /** contains parameters you specified in the POST request */
+    /** *contains parameters you specified in the POST request* */
     metadata?: {
         [key: string]: any;
     } | undefined;

package/dist/esm/models/DomainAnalyticsIdListTaskInfo.d.ts

@@ -1,12 +1,12 @@
 import { DomainAnalyticsIdListResultInfo } from "./DomainAnalyticsIdListResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IDomainAnalyticsIdListTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DomainAnalyticsIdListResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsIdListTaskInfo extends BaseResponseTaskInfo implements IDomainAnalyticsIdListTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DomainAnalyticsIdListResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsIdListTaskInfo);

package/dist/esm/models/DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem.d.ts

@@ -1,34 +1,34 @@
 export interface IDomainAnalyticsTechnologiesAggregationTechnologiesLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** technology group id */
+    /** *technology group id* */
     group?: string | undefined;
-    /** technology category id */
+    /** *technology category id* */
     category?: string | undefined;
-    /** technology name */
+    /** *technology name* */
     technology?: string | undefined;
-    /** technology groups count number of domains that match the parameters you specified and are using technologies from the indicated group */
+    /** *technology groups count* number of domains that match the parameters you specified and are using technologies from the indicated `group` */
     groups_count?: number | undefined;
-    /** technology categories count number of domains that match the parameters you specified and are using technologies from the indicated category */
+    /** *technology categories count* number of domains that match the parameters you specified and are using technologies from the indicated `category` */
     categories_count?: number | undefined;
-    /** technologies count number of domains that match the parameters you specified and are using the indicated technology */
+    /** *technologies count* number of domains that match the parameters you specified and are using the indicated `technology` */
     technologies_count?: number | undefined;
     [key: string]: any;
 }
 export declare class DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem implements IDomainAnalyticsTechnologiesAggregationTechnologiesLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** technology group id */
+    /** *technology group id* */
     group?: string | undefined;
-    /** technology category id */
+    /** *technology category id* */
     category?: string | undefined;
-    /** technology name */
+    /** *technology name* */
     technology?: string | undefined;
-    /** technology groups count number of domains that match the parameters you specified and are using technologies from the indicated group */
+    /** *technology groups count* number of domains that match the parameters you specified and are using technologies from the indicated `group` */
     groups_count?: number | undefined;
-    /** technology categories count number of domains that match the parameters you specified and are using technologies from the indicated category */
+    /** *technology categories count* number of domains that match the parameters you specified and are using technologies from the indicated `category` */
     categories_count?: number | undefined;
-    /** technologies count number of domains that match the parameters you specified and are using the indicated technology */
+    /** *technologies count* number of domains that match the parameters you specified and are using the indicated `technology` */
     technologies_count?: number | undefined;
     [key: string]: any;
     constructor(data?: IDomainAnalyticsTechnologiesAggregationTechnologiesLiveItem);