@sp-api-sdk/data-kiosk-api-2023-11-15 1.1.0 → 1.2.0

package/dist/cjs/src/api-model/api/queries-api.js

@@ -59,7 +59,7 @@ const QueriesApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateQuerySpecification} body
+         * @param {CreateQuerySpecification} body The body of the request.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -212,7 +212,7 @@ const QueriesApiFp = function (configuration) {
         },
         /**
          * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateQuerySpecification} body
+         * @param {CreateQuerySpecification} body The body of the request.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

package/dist/es/src/api-model/api/queries-api.js

@@ -53,7 +53,7 @@ export const QueriesApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateQuerySpecification} body
+         * @param {CreateQuerySpecification} body The body of the request.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -205,7 +205,7 @@ export const QueriesApiFp = function (configuration) {
         },
         /**
          * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {CreateQuerySpecification} body
+         * @param {CreateQuerySpecification} body The body of the request.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

package/dist/types/src/api-model/api/queries-api.d.ts

@@ -11,6 +11,7 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
 import { CreateQueryResponse } from '../models';
 import { CreateQuerySpecification } from '../models';
@@ -31,7 +32,7 @@ export declare const QueriesApiAxiosParamCreator: (configuration?: Configuration
     cancelQuery: (queryId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {CreateQuerySpecification} body
+     * @param {CreateQuerySpecification} body The body of the request.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -76,7 +77,7 @@ export declare const QueriesApiFp: (configuration?: Configuration) => {
     cancelQuery(queryId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {CreateQuerySpecification} body
+     * @param {CreateQuerySpecification} body The body of the request.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -168,7 +169,7 @@ export interface QueriesApiCancelQueryRequest {
  */
 export interface QueriesApiCreateQueryRequest {
     /**
-     *
+     * The body of the request.
      * @type {CreateQuerySpecification}
      * @memberof QueriesApiCreateQuery
      */
@@ -251,7 +252,7 @@ export declare class QueriesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof QueriesApi
      */
-    cancelQuery(requestParameters: QueriesApiCancelQueryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    cancelQuery(requestParameters: QueriesApiCancelQueryRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
     /**
      * Creates a Data Kiosk query request.  **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query\'s resulting documents always matches the retention of the query.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {QueriesApiCreateQueryRequest} requestParameters Request parameters.
@@ -259,7 +260,7 @@ export declare class QueriesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof QueriesApi
      */
-    createQuery(requestParameters: QueriesApiCreateQueryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateQueryResponse, any>>;
+    createQuery(requestParameters: QueriesApiCreateQueryRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateQueryResponse, any>>;
     /**
      * Returns the information required for retrieving a Data Kiosk document\'s contents. See the `createQuery` operation for details about document retention.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {QueriesApiGetDocumentRequest} requestParameters Request parameters.
@@ -267,7 +268,7 @@ export declare class QueriesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof QueriesApi
      */
-    getDocument(requestParameters: QueriesApiGetDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentResponse, any>>;
+    getDocument(requestParameters: QueriesApiGetDocumentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDocumentResponse, any>>;
     /**
      * Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {QueriesApiGetQueriesRequest} requestParameters Request parameters.
@@ -275,7 +276,7 @@ export declare class QueriesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof QueriesApi
      */
-    getQueries(requestParameters?: QueriesApiGetQueriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueriesResponse, any>>;
+    getQueries(requestParameters?: QueriesApiGetQueriesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetQueriesResponse, any>>;
     /**
      * Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {QueriesApiGetQueryRequest} requestParameters Request parameters.
@@ -283,5 +284,5 @@ export declare class QueriesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof QueriesApi
      */
-    getQuery(requestParameters: QueriesApiGetQueryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Query, any>>;
+    getQuery(requestParameters: QueriesApiGetQueryRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<Query, any>>;
 }

package/dist/types/src/api-model/models/error-list.d.ts

@@ -16,7 +16,7 @@
  */
 export interface ErrorList {
     /**
-     *
+     * Error response returned when the request is unsuccessful.
      * @type {Array<Error>}
      * @memberof ErrorList
      */

package/dist/types/src/api-model/models/model-error.d.ts

@@ -22,7 +22,7 @@ export interface ModelError {
      */
     'code': string;
     /**
-     * A message that describes the error condition in a human-readable form.
+     * A message that describes the error condition.
      * @type {string}
      * @memberof ModelError
      */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/data-kiosk-api-2023-11-15",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.0.3",
-    "axios": "^1.6.2"
+    "@sp-api-sdk/common": "2.0.5",
+    "axios": "^1.6.7"
   },
   "repository": {
     "type": "git",
@@ -40,5 +40,5 @@
     "sp sdk",
     "data kiosk api"
   ],
-  "gitHead": "c81279baeb662780ae3cb42fb60fa11670fed191"
+  "gitHead": "014aad96509aba433e07461efbe936a6062cc66a"
 }