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

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

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

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

@@ -1,34 +0,0 @@
-/**
- * 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 { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
- */
-export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-export declare const toPathString: (url: URL) => string;
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

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

@@ -1,98 +0,0 @@
-/**
- * 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;
-    };
-}
-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>);
-    awsv4?: AWSv4Configuration;
-    basePath?: string;
-    serverIndex?: number;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-export 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;
-}
-export {};

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

@@ -1,14 +0,0 @@
-/**
- * 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/api-model/models/create-query-response.d.ts

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

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

@@ -1,24 +0,0 @@
-/**
- * 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 {
-    /**
-     * 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;
-}

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

@@ -1,20 +0,0 @@
-/**
- * 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 {
-    /**
-     * Error response returned when the request is unsuccessful.
-     */
-    'errors': Array<Error>;
-}

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

@@ -1,24 +0,0 @@
-/**
- * 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 {
-    /**
-     * 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;
-}

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

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

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

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

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

@@ -1,9 +0,0 @@
-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/api-model/models/model-error.d.ts

@@ -1,28 +0,0 @@
-/**
- * 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 {
-    /**
-     * 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;
-}

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

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

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

@@ -1,58 +0,0 @@
-/**
- * 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 { QueryPagination } from './query-pagination';
-/**
- * Detailed information about the query.
- */
-export 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;
-}
-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/client.d.ts

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

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './client';
-export * from './api-model/api';
-export * from './api-model/models';