@teemill/gfn-catalog 1.1.0 → 1.3.0

package/dist/esm/models/VariantStock.d.ts

@@ -0,0 +1,50 @@
+/**
+ * GFN Catalog API
+ * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt.  Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * 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 { Stock } from './Stock';
+/**
+ *
+ * @export
+ * @interface VariantStock
+ */
+export interface VariantStock {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof VariantStock
+     */
+    id?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof VariantStock
+     */
+    ref?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof VariantStock
+     */
+    productRef?: string;
+    /**
+     *
+     * @type {Stock}
+     * @memberof VariantStock
+     */
+    stock?: Stock;
+}
+/**
+ * Check if a given object implements the VariantStock interface.
+ */
+export declare function instanceOfVariantStock(value: object): boolean;
+export declare function VariantStockFromJSON(json: any): VariantStock;
+export declare function VariantStockFromJSONTyped(json: any, ignoreDiscriminator: boolean): VariantStock;
+export declare function VariantStockToJSON(value?: VariantStock | null): any;

package/dist/esm/models/VariantStock.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt.  Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * 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 { StockFromJSON, StockToJSON, } from './Stock';
+/**
+ * Check if a given object implements the VariantStock interface.
+ */
+export function instanceOfVariantStock(value) {
+    return true;
+}
+export function VariantStockFromJSON(json) {
+    return VariantStockFromJSONTyped(json, false);
+}
+export function VariantStockFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'ref': json['ref'] == null ? undefined : json['ref'],
+        'productRef': json['productRef'] == null ? undefined : json['productRef'],
+        'stock': json['stock'] == null ? undefined : StockFromJSON(json['stock']),
+    };
+}
+export function VariantStockToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'ref': value['ref'],
+        'productRef': value['productRef'],
+        'stock': StockToJSON(value['stock']),
+    };
+}

package/dist/esm/models/VariantsResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * GFN Catalog API
+ * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt.  Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * 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 { Variant } from './Variant';
+/**
+ *
+ * @export
+ * @interface VariantsResponse
+ */
+export interface VariantsResponse {
+    /**
+     *
+     * @type {Array<Variant>}
+     * @memberof VariantsResponse
+     */
+    variants?: Array<Variant>;
+    /**
+     *
+     * @type {number}
+     * @memberof VariantsResponse
+     */
+    nextPageToken?: number;
+}
+/**
+ * Check if a given object implements the VariantsResponse interface.
+ */
+export declare function instanceOfVariantsResponse(value: object): boolean;
+export declare function VariantsResponseFromJSON(json: any): VariantsResponse;
+export declare function VariantsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VariantsResponse;
+export declare function VariantsResponseToJSON(value?: VariantsResponse | null): any;

package/dist/esm/models/VariantsResponse.js

@@ -0,0 +1,41 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt.  Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * 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 { VariantFromJSON, VariantToJSON, } from './Variant';
+/**
+ * Check if a given object implements the VariantsResponse interface.
+ */
+export function instanceOfVariantsResponse(value) {
+    return true;
+}
+export function VariantsResponseFromJSON(json) {
+    return VariantsResponseFromJSONTyped(json, false);
+}
+export function VariantsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'variants': json['variants'] == null ? undefined : (json['variants'].map(VariantFromJSON)),
+        'nextPageToken': json['nextPageToken'] == null ? undefined : json['nextPageToken'],
+    };
+}
+export function VariantsResponseToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'variants': value['variants'] == null ? undefined : (value['variants'].map(VariantToJSON)),
+        'nextPageToken': value['nextPageToken'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,13 @@
+export * from './ApiError';
+export * from './Attribute';
+export * from './AttributeThumbnail';
+export * from './Image';
+export * from './Product';
+export * from './ProductsResponse';
+export * from './Stock';
+export * from './StockResponse';
+export * from './Variant';
+export * from './VariantManufacturerOrigin';
+export * from './VariantProduct';
+export * from './VariantStock';
+export * from './VariantsResponse';

package/dist/esm/models/index.js

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ApiError';
+export * from './Attribute';
+export * from './AttributeThumbnail';
+export * from './Image';
+export * from './Product';
+export * from './ProductsResponse';
+export * from './Stock';
+export * from './StockResponse';
+export * from './Variant';
+export * from './VariantManufacturerOrigin';
+export * from './VariantProduct';
+export * from './VariantStock';
+export * from './VariantsResponse';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,187 @@
+/**
+ * GFN Catalog API
+ * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt.  Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * 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.
+ */
+export type OptionalProperties<T> = {
+    [K in keyof T]-?: undefined extends T[K] ? K : never;
+}[keyof T];
+export type OptionalOnly<T> = Partial<Pick<T, OptionalProperties<T>>>;
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | ((name: string) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    isResponseError(error: any): error is ResponseError;
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * 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.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function exists(json: any, key: string): boolean;
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function mapValues(data: any, fn: (item: any) => any): {};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}