@teemill/gtins 0.2.1 → 0.4.1

package/dist/api.d.ts

@@ -0,0 +1,447 @@
+/**
+ * GTINs API
+ * Manage GTINs
+ *
+ * The version of the OpenAPI document: 0.4.1
+ * Contact: hello@teemill.com
+ *
+ * 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 { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'message': string;
+}
+/**
+ *
+ * @export
+ * @interface AssignGtinRequest
+ */
+export interface AssignGtinRequest {
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof AssignGtinRequest
+     */
+    'variantRef': string;
+}
+/**
+ *
+ * @export
+ * @interface GTIN
+ */
+export interface GTIN {
+    /**
+     * The GTIN
+     * @type {string}
+     * @memberof GTIN
+     */
+    'number': string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof GTIN
+     */
+    'variantRef': string;
+}
+/**
+ *
+ * @export
+ * @interface GTINsResponse
+ */
+export interface GTINsResponse {
+    /**
+     *
+     * @type {Array<GTIN>}
+     * @memberof GTINsResponse
+     */
+    'gtins'?: Array<GTIN>;
+    /**
+     *
+     * @type {number}
+     * @memberof GTINsResponse
+     */
+    'nextPageToken'?: number | null;
+}
+/**
+ *
+ * @export
+ * @interface ImportGtins202Response
+ */
+export interface ImportGtins202Response {
+    /**
+     * Id of the GTINs import
+     * @type {string}
+     * @memberof ImportGtins202Response
+     */
+    'importId'?: string;
+}
+/**
+ * GTINsApi - axios parameter creator
+ * @export
+ */
+export declare const GTINsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Assign a GTIN to a variant
+     * @summary Assign GTIN
+     * @param {string} project What project it is
+     * @param {string} gtin GTIN
+     * @param {AssignGtinRequest} [assignGtinRequest] Assign a GTIN to a variant
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    assignGtin: (project: string, gtin: string, assignGtinRequest?: AssignGtinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Export a CSV of a project\'s GTINs
+     * @summary Export GTINs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGtins: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a GTIN
+     * @summary Get GTIN
+     * @param {string} project What project it is
+     * @param {string} gtin GTIN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGtin: (project: string, gtin: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
+     * @summary Import GTINs
+     * @param {string} project What project it is
+     * @param {string} [body] A data URL of a CSV file containing GTINs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importGtins: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List GTINs
+     * @summary List gtins
+     * @param {string} project What project it is
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {number} [pageToken] Page reference token
+     * @param {string} [search] Search term to filter based on GTIN based on the GTIN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listGtins: (project: string, pageSize?: number, pageToken?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Unassign a GTIN from a variant
+     * @summary Unassign GTIN
+     * @param {string} project What project it is
+     * @param {string} gtin GTIN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unassignGtin: (project: string, gtin: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GTINsApi - functional programming interface
+ * @export
+ */
+export declare const GTINsApiFp: (configuration?: Configuration) => {
+    /**
+     * Assign a GTIN to a variant
+     * @summary Assign GTIN
+     * @param {string} project What project it is
+     * @param {string} gtin GTIN
+     * @param {AssignGtinRequest} [assignGtinRequest] Assign a GTIN to a variant
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    assignGtin(project: string, gtin: string, assignGtinRequest?: AssignGtinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GTIN>>;
+    /**
+     * Export a CSV of a project\'s GTINs
+     * @summary Export GTINs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGtins(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get a GTIN
+     * @summary Get GTIN
+     * @param {string} project What project it is
+     * @param {string} gtin GTIN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGtin(project: string, gtin: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GTIN>>;
+    /**
+     * Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
+     * @summary Import GTINs
+     * @param {string} project What project it is
+     * @param {string} [body] A data URL of a CSV file containing GTINs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportGtins202Response>>;
+    /**
+     * List GTINs
+     * @summary List gtins
+     * @param {string} project What project it is
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {number} [pageToken] Page reference token
+     * @param {string} [search] Search term to filter based on GTIN based on the GTIN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listGtins(project: string, pageSize?: number, pageToken?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GTINsResponse>>;
+    /**
+     * Unassign a GTIN from a variant
+     * @summary Unassign GTIN
+     * @param {string} project What project it is
+     * @param {string} gtin GTIN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unassignGtin(project: string, gtin: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * GTINsApi - factory interface
+ * @export
+ */
+export declare const GTINsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Assign a GTIN to a variant
+     * @summary Assign GTIN
+     * @param {GTINsApiAssignGtinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    assignGtin(requestParameters: GTINsApiAssignGtinRequest, options?: RawAxiosRequestConfig): AxiosPromise<GTIN>;
+    /**
+     * Export a CSV of a project\'s GTINs
+     * @summary Export GTINs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportGtins(options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get a GTIN
+     * @summary Get GTIN
+     * @param {GTINsApiGetGtinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGtin(requestParameters: GTINsApiGetGtinRequest, options?: RawAxiosRequestConfig): AxiosPromise<GTIN>;
+    /**
+     * Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
+     * @summary Import GTINs
+     * @param {GTINsApiImportGtinsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportGtins202Response>;
+    /**
+     * List GTINs
+     * @summary List gtins
+     * @param {GTINsApiListGtinsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listGtins(requestParameters: GTINsApiListGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GTINsResponse>;
+    /**
+     * Unassign a GTIN from a variant
+     * @summary Unassign GTIN
+     * @param {GTINsApiUnassignGtinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unassignGtin(requestParameters: GTINsApiUnassignGtinRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for assignGtin operation in GTINsApi.
+ * @export
+ * @interface GTINsApiAssignGtinRequest
+ */
+export interface GTINsApiAssignGtinRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof GTINsApiAssignGtin
+     */
+    readonly project: string;
+    /**
+     * GTIN
+     * @type {string}
+     * @memberof GTINsApiAssignGtin
+     */
+    readonly gtin: string;
+    /**
+     * Assign a GTIN to a variant
+     * @type {AssignGtinRequest}
+     * @memberof GTINsApiAssignGtin
+     */
+    readonly assignGtinRequest?: AssignGtinRequest;
+}
+/**
+ * Request parameters for getGtin operation in GTINsApi.
+ * @export
+ * @interface GTINsApiGetGtinRequest
+ */
+export interface GTINsApiGetGtinRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof GTINsApiGetGtin
+     */
+    readonly project: string;
+    /**
+     * GTIN
+     * @type {string}
+     * @memberof GTINsApiGetGtin
+     */
+    readonly gtin: string;
+}
+/**
+ * Request parameters for importGtins operation in GTINsApi.
+ * @export
+ * @interface GTINsApiImportGtinsRequest
+ */
+export interface GTINsApiImportGtinsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof GTINsApiImportGtins
+     */
+    readonly project: string;
+    /**
+     * A data URL of a CSV file containing GTINs
+     * @type {string}
+     * @memberof GTINsApiImportGtins
+     */
+    readonly body?: string;
+}
+/**
+ * Request parameters for listGtins operation in GTINsApi.
+ * @export
+ * @interface GTINsApiListGtinsRequest
+ */
+export interface GTINsApiListGtinsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof GTINsApiListGtins
+     */
+    readonly project: string;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof GTINsApiListGtins
+     */
+    readonly pageSize?: number;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof GTINsApiListGtins
+     */
+    readonly pageToken?: number;
+    /**
+     * Search term to filter based on GTIN based on the GTIN
+     * @type {string}
+     * @memberof GTINsApiListGtins
+     */
+    readonly search?: string;
+}
+/**
+ * Request parameters for unassignGtin operation in GTINsApi.
+ * @export
+ * @interface GTINsApiUnassignGtinRequest
+ */
+export interface GTINsApiUnassignGtinRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof GTINsApiUnassignGtin
+     */
+    readonly project: string;
+    /**
+     * GTIN
+     * @type {string}
+     * @memberof GTINsApiUnassignGtin
+     */
+    readonly gtin: string;
+}
+/**
+ * GTINsApi - object-oriented interface
+ * @export
+ * @class GTINsApi
+ * @extends {BaseAPI}
+ */
+export declare class GTINsApi extends BaseAPI {
+    /**
+     * Assign a GTIN to a variant
+     * @summary Assign GTIN
+     * @param {GTINsApiAssignGtinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GTINsApi
+     */
+    assignGtin(requestParameters: GTINsApiAssignGtinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GTIN, any>>;
+    /**
+     * Export a CSV of a project\'s GTINs
+     * @summary Export GTINs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GTINsApi
+     */
+    exportGtins(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Get a GTIN
+     * @summary Get GTIN
+     * @param {GTINsApiGetGtinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GTINsApi
+     */
+    getGtin(requestParameters: GTINsApiGetGtinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GTIN, any>>;
+    /**
+     * Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
+     * @summary Import GTINs
+     * @param {GTINsApiImportGtinsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GTINsApi
+     */
+    importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportGtins202Response, any>>;
+    /**
+     * List GTINs
+     * @summary List gtins
+     * @param {GTINsApiListGtinsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GTINsApi
+     */
+    listGtins(requestParameters: GTINsApiListGtinsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GTINsResponse, any>>;
+    /**
+     * Unassign a GTIN from a variant
+     * @summary Unassign GTIN
+     * @param {GTINsApiUnassignGtinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof GTINsApi
+     */
+    unassignGtin(requestParameters: GTINsApiUnassignGtinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}