@sp-api-sdk/data-kiosk-api-2023-11-15 3.0.17 → 4.1.0

package/dist/index.d.ts

@@ -0,0 +1,590 @@
+import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
+import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
+//#region src/api-model/configuration.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface AWSv4Configuration {
+  options?: {
+    region?: string;
+    service?: string;
+  };
+  credentials?: {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    sessionToken?: string;
+  };
+}
+interface ConfigurationParameters {
+  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+  username?: string;
+  password?: string;
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+  awsv4?: AWSv4Configuration;
+  basePath?: string;
+  serverIndex?: number;
+  baseOptions?: any;
+  formDataCtor?: new () => any;
+}
+declare class Configuration {
+  /**
+   * parameter for apiKey security
+   * @param name security name
+   */
+  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+  /**
+   * parameter for basic security
+   */
+  username?: string;
+  /**
+   * parameter for basic security
+   */
+  password?: string;
+  /**
+   * parameter for oauth2 security
+   * @param name security name
+   * @param scopes oauth2 scope
+   */
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+  /**
+   * parameter for aws4 signature security
+   * @param {Object} AWS4Signature - AWS4 Signature security
+   * @param {string} options.region - aws region
+   * @param {string} options.service - name of the service.
+   * @param {string} credentials.accessKeyId - aws access key id
+   * @param {string} credentials.secretAccessKey - aws access key
+   * @param {string} credentials.sessionToken - aws session token
+   * @memberof Configuration
+   */
+  awsv4?: AWSv4Configuration;
+  /**
+   * override base path
+   */
+  basePath?: string;
+  /**
+   * override server index
+   */
+  serverIndex?: number;
+  /**
+   * base options for axios calls
+   */
+  baseOptions?: any;
+  /**
+   * The FormData constructor that will be used to create multipart form data
+   * requests. You can inject this here so that execution environments that
+   * do not support the FormData class can still run the generated client.
+   *
+   * @type {new () => FormData}
+   */
+  formDataCtor?: new () => any;
+  constructor(param?: ConfigurationParameters);
+  /**
+   * Check if the given MIME is a JSON MIME.
+   * JSON MIME examples:
+   *   application/json
+   *   application/json; charset=UTF8
+   *   APPLICATION/JSON
+   *   application/vnd.company+json
+   * @param mime - MIME (Multipurpose Internet Mail Extensions)
+   * @return True if the given MIME is JSON, false otherwise.
+   */
+  isJsonMime(mime: string): boolean;
+}
+//#endregion
+//#region src/api-model/base.d.ts
+interface RequestArgs {
+  url: string;
+  options: RawAxiosRequestConfig;
+}
+declare class BaseAPI {
+  protected basePath: string;
+  protected axios: AxiosInstance;
+  protected configuration: Configuration | undefined;
+  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+//#endregion
+//#region src/api-model/models/create-query-response.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The response for the `createQuery` operation.
+ */
+interface CreateQueryResponse {
+  /**
+   * The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
+   */
+  'queryId': string;
+}
+//#endregion
+//#region src/api-model/models/create-query-specification.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Information required to create the query.
+ */
+interface CreateQuerySpecification {
+  /**
+   * The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.
+   */
+  'query': string;
+  /**
+   * A token to fetch a certain page of query results when there are multiple pages of query results available. The value of this token must be fetched from the `pagination.nextToken` field of the `Query` object, and the `query` field for this object must also be set to the `query` field of the same `Query` object. A `Query` object can be retrieved from either the `getQueries` or `getQuery` operation. In the absence of this token value, the first page of query results will be requested.
+   */
+  'paginationToken'?: string;
+}
+//#endregion
+//#region src/api-model/models/error-list.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A list of error responses returned when a request is unsuccessful.
+ */
+interface ErrorList {
+  /**
+   * Error response returned when the request is unsuccessful.
+   */
+  'errors': Array<Error>;
+}
+//#endregion
+//#region src/api-model/models/get-document-response.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The response for the `getDocument` operation.
+ */
+interface GetDocumentResponse {
+  /**
+   * The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.
+   */
+  'documentId': string;
+  /**
+   * A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after 5 minutes. If the Data Kiosk document is compressed, the `Content-Encoding` header will indicate the compression algorithm.  **Note:** Most HTTP clients are capable of automatically decompressing downloaded files based on the `Content-Encoding` header.
+   */
+  'documentUrl': string;
+}
+//#endregion
+//#region src/api-model/models/get-queries-response-pagination.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * When a request has results that are not included in this response, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass the `nextToken` as the `paginationToken` query parameter in the subsequent `getQueries` request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. When there are no more pages to fetch, the `nextToken` field will be absent.
+ */
+interface GetQueriesResponsePagination {
+  /**
+   * A token that can be used to fetch the next page of results.
+   */
+  'nextToken'?: string;
+}
+//#endregion
+//#region src/api-model/models/query-pagination.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * When a query produces results that are not included in the data document, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object\'s `nextToken` and with `query` set to this object\'s `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent.
+ */
+interface QueryPagination {
+  /**
+   * A token that can be used to fetch the next page of results.
+   */
+  'nextToken'?: string;
+}
+//#endregion
+//#region src/api-model/models/query.d.ts
+/**
+ * Detailed information about the query.
+ */
+interface Query {
+  /**
+   * The query identifier. This identifier is unique only in combination with a selling partner account ID.
+   */
+  'queryId': string;
+  /**
+   * The submitted query.
+   */
+  'query': string;
+  /**
+   * The date and time when the query was created, in ISO 8601 date time format.
+   */
+  'createdTime': string;
+  /**
+   * The processing status of the query.
+   */
+  'processingStatus': QueryProcessingStatusEnum;
+  /**
+   * The date and time when the query processing started, in ISO 8601 date time format.
+   */
+  'processingStartTime'?: string;
+  /**
+   * The date and time when the query processing completed, in ISO 8601 date time format.
+   */
+  'processingEndTime'?: string;
+  /**
+   * The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document\'s contents.
+   */
+  'dataDocumentId'?: string;
+  /**
+   * The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document\'s contents.
+   */
+  'errorDocumentId'?: string;
+  'pagination'?: QueryPagination;
+}
+declare const QueryProcessingStatusEnum: {
+  readonly Cancelled: "CANCELLED";
+  readonly Done: "DONE";
+  readonly Fatal: "FATAL";
+  readonly InProgress: "IN_PROGRESS";
+  readonly InQueue: "IN_QUEUE";
+};
+type QueryProcessingStatusEnum = typeof QueryProcessingStatusEnum[keyof typeof QueryProcessingStatusEnum];
+//#endregion
+//#region src/api-model/models/get-queries-response.d.ts
+/**
+ * The response for the `getQueries` operation.
+ */
+interface GetQueriesResponse {
+  /**
+   * A list of queries.
+   */
+  'queries': Array<Query>;
+  'pagination'?: GetQueriesResponsePagination;
+}
+//#endregion
+//#region src/api-model/models/model-error.d.ts
+/**
+ * Selling Partner API for Data Kiosk
+ * The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.
+ *
+ * The version of the OpenAPI document: 2023-11-15
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Error response returned when the request is unsuccessful.
+ */
+interface ModelError {
+  /**
+   * An error code that identifies the type of error that occurred.
+   */
+  'code': string;
+  /**
+   * A message that describes the error condition.
+   */
+  'message': string;
+  /**
+   * Additional details that can help the caller understand or fix the issue.
+   */
+  'details'?: string;
+}
+//#endregion
+//#region src/api-model/api/data-kiosk-api.d.ts
+/**
+ * DataKioskApi - axios parameter creator
+ */
+declare const DataKioskApiAxiosParamCreator: (configuration?: Configuration) => {
+  /**
+   * Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.  **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 {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  cancelQuery: (queryId: string, options?: RawAxiosRequestConfig) => 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 The body of the request.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createQuery: (body: CreateQuerySpecification, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * 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 {string} documentId The identifier for the Data Kiosk document.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * 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 {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
+   * @param {number} [pageSize] The maximum number of queries to return in a single call.
+   * @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
+   * @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the &#x60;getQueries&#x60; request.
+   * @param {string} [paginationToken] A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the &#x60;pagination.nextToken&#x60; field returned in the &#x60;GetQueriesResponse&#x60; object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of &#x60;pageSize&#x60; which can be modified between calls to &#x60;getQueries&#x60;. In the absence of this token value, &#x60;getQueries&#x60; returns the first page of results.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQueries: (processingStatuses?: Array<GetQueriesProcessingStatusesEnum>, pageSize?: number, createdSince?: string, createdUntil?: string, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+  /**
+   * 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 {string} queryId The query identifier.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQuery: (queryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DataKioskApi - functional programming interface
+ */
+declare const DataKioskApiFp: (configuration?: Configuration) => {
+  /**
+   * Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.  **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 {string} queryId The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  cancelQuery(queryId: string, options?: RawAxiosRequestConfig): 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 The body of the request.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createQuery(body: CreateQuerySpecification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateQueryResponse>>;
+  /**
+   * 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 {string} documentId The identifier for the Data Kiosk document.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentResponse>>;
+  /**
+   * 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 {Array<GetQueriesProcessingStatusesEnum>} [processingStatuses] A list of processing statuses used to filter queries.
+   * @param {number} [pageSize] The maximum number of queries to return in a single call.
+   * @param {string} [createdSince] The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
+   * @param {string} [createdUntil] The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the &#x60;getQueries&#x60; request.
+   * @param {string} [paginationToken] A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the &#x60;pagination.nextToken&#x60; field returned in the &#x60;GetQueriesResponse&#x60; object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of &#x60;pageSize&#x60; which can be modified between calls to &#x60;getQueries&#x60;. In the absence of this token value, &#x60;getQueries&#x60; returns the first page of results.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQueries(processingStatuses?: Array<GetQueriesProcessingStatusesEnum>, pageSize?: number, createdSince?: string, createdUntil?: string, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQueriesResponse>>;
+  /**
+   * 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 {string} queryId The query identifier.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQuery(queryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Query>>;
+};
+/**
+ * DataKioskApi - factory interface
+ */
+declare const DataKioskApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+  /**
+   * Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.  **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 {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): 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 {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateQueryResponse>;
+  /**
+   * 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 {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDocumentResponse>;
+  /**
+   * 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 {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueriesResponse>;
+  /**
+   * 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 {DataKioskApiGetQueryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Query>;
+};
+/**
+ * Request parameters for cancelQuery operation in DataKioskApi.
+ */
+interface DataKioskApiCancelQueryRequest {
+  /**
+   * The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
+   */
+  readonly queryId: string;
+}
+/**
+ * Request parameters for createQuery operation in DataKioskApi.
+ */
+interface DataKioskApiCreateQueryRequest {
+  /**
+   * The body of the request.
+   */
+  readonly body: CreateQuerySpecification;
+}
+/**
+ * Request parameters for getDocument operation in DataKioskApi.
+ */
+interface DataKioskApiGetDocumentRequest {
+  /**
+   * The identifier for the Data Kiosk document.
+   */
+  readonly documentId: string;
+}
+/**
+ * Request parameters for getQueries operation in DataKioskApi.
+ */
+interface DataKioskApiGetQueriesRequest {
+  /**
+   * A list of processing statuses used to filter queries.
+   */
+  readonly processingStatuses?: Array<GetQueriesProcessingStatusesEnum>;
+  /**
+   * The maximum number of queries to return in a single call.
+   */
+  readonly pageSize?: number;
+  /**
+   * The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
+   */
+  readonly createdSince?: string;
+  /**
+   * The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the &#x60;getQueries&#x60; request.
+   */
+  readonly createdUntil?: string;
+  /**
+   * A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the &#x60;pagination.nextToken&#x60; field returned in the &#x60;GetQueriesResponse&#x60; object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of &#x60;pageSize&#x60; which can be modified between calls to &#x60;getQueries&#x60;. In the absence of this token value, &#x60;getQueries&#x60; returns the first page of results.
+   */
+  readonly paginationToken?: string;
+}
+/**
+ * Request parameters for getQuery operation in DataKioskApi.
+ */
+interface DataKioskApiGetQueryRequest {
+  /**
+   * The query identifier.
+   */
+  readonly queryId: string;
+}
+/**
+ * DataKioskApi - object-oriented interface
+ */
+declare class DataKioskApi extends BaseAPI {
+  /**
+   * Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.  **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 {DataKioskApiCancelQueryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  cancelQuery(requestParameters: DataKioskApiCancelQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").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 {DataKioskApiCreateQueryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  createQuery(requestParameters: DataKioskApiCreateQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").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 {DataKioskApiGetDocumentRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getDocument(requestParameters: DataKioskApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").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 {DataKioskApiGetQueriesRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQueries(requestParameters?: DataKioskApiGetQueriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").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 {DataKioskApiGetQueryRequest} requestParameters Request parameters.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   */
+  getQuery(requestParameters: DataKioskApiGetQueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Query, any, {}>>;
+}
+declare const GetQueriesProcessingStatusesEnum: {
+  readonly Cancelled: "CANCELLED";
+  readonly Done: "DONE";
+  readonly Fatal: "FATAL";
+  readonly InProgress: "IN_PROGRESS";
+  readonly InQueue: "IN_QUEUE";
+};
+type GetQueriesProcessingStatusesEnum = typeof GetQueriesProcessingStatusesEnum[keyof typeof GetQueriesProcessingStatusesEnum];
+//#endregion
+//#region src/client.d.ts
+declare const clientRateLimits: RateLimit[];
+declare class DataKioskApiClient extends DataKioskApi {
+  constructor(configuration: ClientConfiguration);
+}
+//#endregion
+export { CreateQueryResponse, CreateQuerySpecification, DataKioskApi, DataKioskApiAxiosParamCreator, DataKioskApiCancelQueryRequest, DataKioskApiClient, DataKioskApiCreateQueryRequest, DataKioskApiFactory, DataKioskApiFp, DataKioskApiGetDocumentRequest, DataKioskApiGetQueriesRequest, DataKioskApiGetQueryRequest, ErrorList, GetDocumentResponse, GetQueriesProcessingStatusesEnum, GetQueriesResponse, GetQueriesResponsePagination, ModelError, Query, QueryPagination, QueryProcessingStatusEnum, clientRateLimits };
+//# sourceMappingURL=index.d.ts.map