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

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

@@ -0,0 +1,54 @@
+/**
+ * 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.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}

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

@@ -0,0 +1,66 @@
+/**
+ * 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.
+ */
+/// <reference types="node" />
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

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

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+export 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>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    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;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/src/api-model/models/create-query-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ * @export
+ * @interface CreateQueryResponse
+ */
+export interface CreateQueryResponse {
+    /**
+     * The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
+     * @type {string}
+     * @memberof CreateQueryResponse
+     */
+    'queryId': string;
+}

package/dist/types/src/api-model/models/create-query-specification.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ * @export
+ * @interface CreateQuerySpecification
+ */
+export interface CreateQuerySpecification {
+    /**
+     * The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.
+     * @type {string}
+     * @memberof CreateQuerySpecification
+     */
+    '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.
+     * @type {string}
+     * @memberof CreateQuerySpecification
+     */
+    'paginationToken'?: string;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ * @export
+ * @interface ErrorList
+ */
+export interface ErrorList {
+    /**
+     *
+     * @type {Array<Error>}
+     * @memberof ErrorList
+     */
+    'errors': Array<Error>;
+}

package/dist/types/src/api-model/models/get-document-response.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ * @export
+ * @interface GetDocumentResponse
+ */
+export interface GetDocumentResponse {
+    /**
+     * The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.
+     * @type {string}
+     * @memberof GetDocumentResponse
+     */
+    '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.
+     * @type {string}
+     * @memberof GetDocumentResponse
+     */
+    'documentUrl': string;
+}

package/dist/types/src/api-model/models/get-queries-response-pagination.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ * @export
+ * @interface GetQueriesResponsePagination
+ */
+export interface GetQueriesResponsePagination {
+    /**
+     * A token that can be used to fetch the next page of results.
+     * @type {string}
+     * @memberof GetQueriesResponsePagination
+     */
+    'nextToken'?: string;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+import { GetQueriesResponsePagination } from './get-queries-response-pagination';
+import { Query } from './query';
+/**
+ * The response for the `getQueries` operation.
+ * @export
+ * @interface GetQueriesResponse
+ */
+export interface GetQueriesResponse {
+    /**
+     * A list of queries.
+     * @type {Array<Query>}
+     * @memberof GetQueriesResponse
+     */
+    'queries': Array<Query>;
+    /**
+     *
+     * @type {GetQueriesResponsePagination}
+     * @memberof GetQueriesResponse
+     */
+    'pagination'?: GetQueriesResponsePagination;
+}

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

@@ -0,0 +1,9 @@
+export * from './create-query-response';
+export * from './create-query-specification';
+export * from './error-list';
+export * from './get-document-response';
+export * from './get-queries-response';
+export * from './get-queries-response-pagination';
+export * from './model-error';
+export * from './query';
+export * from './query-pagination';

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     * An error code that identifies the type of error that occurred.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'code': string;
+    /**
+     * A message that describes the error condition in a human-readable form.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'message': string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'details'?: string;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ * @export
+ * @interface QueryPagination
+ */
+export interface QueryPagination {
+    /**
+     * A token that can be used to fetch the next page of results.
+     * @type {string}
+     * @memberof QueryPagination
+     */
+    'nextToken'?: string;
+}

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

@@ -0,0 +1,81 @@
+/**
+ * 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.
+ */
+import { QueryPagination } from './query-pagination';
+/**
+ * Detailed information about the query.
+ * @export
+ * @interface Query
+ */
+export interface Query {
+    /**
+     * The query identifier. This identifier is unique only in combination with a selling partner account ID.
+     * @type {string}
+     * @memberof Query
+     */
+    'queryId': string;
+    /**
+     * The submitted query.
+     * @type {string}
+     * @memberof Query
+     */
+    'query': string;
+    /**
+     * The date and time when the query was created, in ISO 8601 date time format.
+     * @type {string}
+     * @memberof Query
+     */
+    'createdTime': string;
+    /**
+     * The processing status of the query.
+     * @type {string}
+     * @memberof Query
+     */
+    'processingStatus': QueryProcessingStatusEnum;
+    /**
+     * The date and time when the query processing started, in ISO 8601 date time format.
+     * @type {string}
+     * @memberof Query
+     */
+    'processingStartTime'?: string;
+    /**
+     * The date and time when the query processing completed, in ISO 8601 date time format.
+     * @type {string}
+     * @memberof Query
+     */
+    '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.
+     * @type {string}
+     * @memberof Query
+     */
+    '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.
+     * @type {string}
+     * @memberof Query
+     */
+    'errorDocumentId'?: string;
+    /**
+     *
+     * @type {QueryPagination}
+     * @memberof Query
+     */
+    'pagination'?: QueryPagination;
+}
+export declare const QueryProcessingStatusEnum: {
+    readonly Cancelled: "CANCELLED";
+    readonly Done: "DONE";
+    readonly Fatal: "FATAL";
+    readonly InProgress: "IN_PROGRESS";
+    readonly InQueue: "IN_QUEUE";
+};
+export type QueryProcessingStatusEnum = typeof QueryProcessingStatusEnum[keyof typeof QueryProcessingStatusEnum];

package/dist/types/src/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
+import { QueriesApi } from './api-model';
+export declare const clientRateLimits: RateLimit[];
+export declare class DataKioskApiClient extends QueriesApi {
+    constructor(configuration: ClientConfiguration);
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "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",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@sp-api-sdk/common": "2.0.3",
+    "axios": "^1.6.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bizon/selling-partner-api-sdk.git",
+    "directory": "clients/data-kiosk-api-2023-11-15"
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/data-kiosk-api-2023-11-15",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "data kiosk api"
+  ],
+  "gitHead": "c81279baeb662780ae3cb42fb60fa11670fed191"
+}