@teemill/gfn-catalog 1.3.0 → 2.0.0

package/src/apis/VariantsApi.ts

@@ -1,342 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import type {
-  ApiError,
-  StockResponse,
-  Variant,
-  VariantStock,
-  VariantsResponse,
-} from '../models/index';
-import {
-    ApiErrorFromJSON,
-    ApiErrorToJSON,
-    StockResponseFromJSON,
-    StockResponseToJSON,
-    VariantFromJSON,
-    VariantToJSON,
-    VariantStockFromJSON,
-    VariantStockToJSON,
-    VariantsResponseFromJSON,
-    VariantsResponseToJSON,
-} from '../models/index';
-
-export interface GetStockRequest {
-    project: string;
-    variantId: string;
-    fulfillmentProjects?: string;
-}
-
-export interface GetVariantRequest {
-    project: string;
-    variantId: string;
-    fields?: string;
-}
-
-export interface ListStockRequest {
-    project: string;
-    fulfillmentProjects?: string;
-    pageToken?: number;
-    pageSize?: number;
-    search?: string;
-}
-
-export interface ListVariantsRequest {
-    project: string;
-    pageToken?: number;
-    pageSize?: number;
-    fields?: string;
-    search?: string;
-}
-
-/**
- * 
- */
-export class VariantsApi extends runtime.BaseAPI {
-
-    /**
-     * Gets the stock level for the GFN variant with the given ID.
-     * Get GFN variant stock
-     */
-    async getStockRaw(requestParameters: GetStockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantStock>> {
-        if (requestParameters.project === null || requestParameters.project === undefined) {
-            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getStock.');
-        }
-
-        if (requestParameters.variantId === null || requestParameters.variantId === undefined) {
-            throw new runtime.RequiredError('variantId','Required parameter requestParameters.variantId was null or undefined when calling getStock.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.project !== undefined) {
-            queryParameters['project'] = requestParameters.project;
-        }
-
-        if (requestParameters.fulfillmentProjects !== undefined) {
-            queryParameters['fulfillmentProjects'] = requestParameters.fulfillmentProjects;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
-        }
-
-        if (this.configuration && this.configuration.apiKey) {
-            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
-        }
-
-        const response = await this.request({
-            path: `/v1/gfn/catalog/stock/{variantId}`.replace(`{${"variantId"}}`, encodeURIComponent(String(requestParameters.variantId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => VariantStockFromJSON(jsonValue));
-    }
-
-    /**
-     * Gets the stock level for the GFN variant with the given ID.
-     * Get GFN variant stock
-     */
-    async getStock(
-        project: string, variantId: string, 
-        optionalParameters: runtime.OptionalOnly<GetStockRequest> = {},
-        initOverrides?: RequestInit | runtime.InitOverrideFunction
-    ): Promise<VariantStock> {
-        const response = await this.getStockRaw(
-            {
-                project: project,variantId: variantId,
-                ...optionalParameters,
-            },
-            initOverrides
-        );
-
-        return await response.value();
-    }
-
-    /**
-     * Gets a GFN variant by the given ID.
-     * Get a GFN variant
-     */
-    async getVariantRaw(requestParameters: GetVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Variant>> {
-        if (requestParameters.project === null || requestParameters.project === undefined) {
-            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getVariant.');
-        }
-
-        if (requestParameters.variantId === null || requestParameters.variantId === undefined) {
-            throw new runtime.RequiredError('variantId','Required parameter requestParameters.variantId was null or undefined when calling getVariant.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.project !== undefined) {
-            queryParameters['project'] = requestParameters.project;
-        }
-
-        if (requestParameters.fields !== undefined) {
-            queryParameters['fields'] = requestParameters.fields;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
-        }
-
-        if (this.configuration && this.configuration.apiKey) {
-            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
-        }
-
-        const response = await this.request({
-            path: `/v1/gfn/catalog/variants/{variantId}`.replace(`{${"variantId"}}`, encodeURIComponent(String(requestParameters.variantId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => VariantFromJSON(jsonValue));
-    }
-
-    /**
-     * Gets a GFN variant by the given ID.
-     * Get a GFN variant
-     */
-    async getVariant(
-        project: string, variantId: string, 
-        optionalParameters: runtime.OptionalOnly<GetVariantRequest> = {},
-        initOverrides?: RequestInit | runtime.InitOverrideFunction
-    ): Promise<Variant> {
-        const response = await this.getVariantRaw(
-            {
-                project: project,variantId: variantId,
-                ...optionalParameters,
-            },
-            initOverrides
-        );
-
-        return await response.value();
-    }
-
-    /**
-     * Lists the stock levels for all GFN variants available to the project.
-     * List GFN variant stock
-     */
-    async listStockRaw(requestParameters: ListStockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StockResponse>> {
-        if (requestParameters.project === null || requestParameters.project === undefined) {
-            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling listStock.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.project !== undefined) {
-            queryParameters['project'] = requestParameters.project;
-        }
-
-        if (requestParameters.fulfillmentProjects !== undefined) {
-            queryParameters['fulfillmentProjects'] = requestParameters.fulfillmentProjects;
-        }
-
-        if (requestParameters.pageToken !== undefined) {
-            queryParameters['pageToken'] = requestParameters.pageToken;
-        }
-
-        if (requestParameters.pageSize !== undefined) {
-            queryParameters['pageSize'] = requestParameters.pageSize;
-        }
-
-        if (requestParameters.search !== undefined) {
-            queryParameters['search'] = requestParameters.search;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
-        }
-
-        if (this.configuration && this.configuration.apiKey) {
-            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
-        }
-
-        const response = await this.request({
-            path: `/v1/gfn/catalog/stock`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => StockResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Lists the stock levels for all GFN variants available to the project.
-     * List GFN variant stock
-     */
-    async listStock(
-        project: string, 
-        optionalParameters: runtime.OptionalOnly<ListStockRequest> = {},
-        initOverrides?: RequestInit | runtime.InitOverrideFunction
-    ): Promise<StockResponse> {
-        const response = await this.listStockRaw(
-            {
-                project: project,
-                ...optionalParameters,
-            },
-            initOverrides
-        );
-
-        return await response.value();
-    }
-
-    /**
-     * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
-     * List GFN variants
-     */
-    async listVariantsRaw(requestParameters: ListVariantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantsResponse>> {
-        if (requestParameters.project === null || requestParameters.project === undefined) {
-            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling listVariants.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.project !== undefined) {
-            queryParameters['project'] = requestParameters.project;
-        }
-
-        if (requestParameters.pageToken !== undefined) {
-            queryParameters['pageToken'] = requestParameters.pageToken;
-        }
-
-        if (requestParameters.pageSize !== undefined) {
-            queryParameters['pageSize'] = requestParameters.pageSize;
-        }
-
-        if (requestParameters.fields !== undefined) {
-            queryParameters['fields'] = requestParameters.fields;
-        }
-
-        if (requestParameters.search !== undefined) {
-            queryParameters['search'] = requestParameters.search;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
-        }
-
-        if (this.configuration && this.configuration.apiKey) {
-            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
-        }
-
-        const response = await this.request({
-            path: `/v1/gfn/catalog/variants`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => VariantsResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
-     * List GFN variants
-     */
-    async listVariants(
-        project: string, 
-        optionalParameters: runtime.OptionalOnly<ListVariantsRequest> = {},
-        initOverrides?: RequestInit | runtime.InitOverrideFunction
-    ): Promise<VariantsResponse> {
-        const response = await this.listVariantsRaw(
-            {
-                project: project,
-                ...optionalParameters,
-            },
-            initOverrides
-        );
-
-        return await response.value();
-    }
-
-}

package/src/apis/index.ts

@@ -1,4 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-export * from './ProductsApi';
-export * from './VariantsApi';

package/src/index.ts

@@ -1,5 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-export * from './runtime';
-export * from './apis/index';
-export * from './models/index';

package/src/models/ApiError.ts

@@ -1,69 +0,0 @@
-/* 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 { mapValues } from '../runtime';
-/**
- * 
- * @export
- * @interface ApiError
- */
-export interface ApiError {
-    /**
-     * 
-     * @type {string}
-     * @memberof ApiError
-     */
-    code?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ApiError
-     */
-    message: string;
-}
-
-/**
- * Check if a given object implements the ApiError interface.
- */
-export function instanceOfApiError(value: object): boolean {
-    if (!('message' in value)) return false;
-    return true;
-}
-
-export function ApiErrorFromJSON(json: any): ApiError {
-    return ApiErrorFromJSONTyped(json, false);
-}
-
-export function ApiErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiError {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'code': json['code'] == null ? undefined : json['code'],
-        'message': json['message'],
-    };
-}
-
-export function ApiErrorToJSON(value?: ApiError | null): any {
-    if (value == null) {
-        return value;
-    }
-    return {
-        
-        'code': value['code'],
-        'message': value['message'],
-    };
-}
-

package/src/models/Attribute.ts

@@ -1,93 +0,0 @@
-/* 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 { mapValues } from '../runtime';
-import type { AttributeThumbnail } from './AttributeThumbnail';
-import {
-    AttributeThumbnailFromJSON,
-    AttributeThumbnailFromJSONTyped,
-    AttributeThumbnailToJSON,
-} from './AttributeThumbnail';
-
-/**
- * 
- * @export
- * @interface Attribute
- */
-export interface Attribute {
-    /**
-     * Attribute name
-     * @type {string}
-     * @memberof Attribute
-     */
-    name: string;
-    /**
-     * Attribute value
-     * @type {string}
-     * @memberof Attribute
-     */
-    value: string;
-    /**
-     * 
-     * @type {AttributeThumbnail}
-     * @memberof Attribute
-     */
-    thumbnail?: AttributeThumbnail;
-    /**
-     * Attribute tags
-     * @type {Array<string>}
-     * @memberof Attribute
-     */
-    tags?: Array<string>;
-}
-
-/**
- * Check if a given object implements the Attribute interface.
- */
-export function instanceOfAttribute(value: object): boolean {
-    if (!('name' in value)) return false;
-    if (!('value' in value)) return false;
-    return true;
-}
-
-export function AttributeFromJSON(json: any): Attribute {
-    return AttributeFromJSONTyped(json, false);
-}
-
-export function AttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Attribute {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'name': json['name'],
-        'value': json['value'],
-        'thumbnail': json['thumbnail'] == null ? undefined : AttributeThumbnailFromJSON(json['thumbnail']),
-        'tags': json['tags'] == null ? undefined : json['tags'],
-    };
-}
-
-export function AttributeToJSON(value?: Attribute | null): any {
-    if (value == null) {
-        return value;
-    }
-    return {
-        
-        'name': value['name'],
-        'value': value['value'],
-        'thumbnail': AttributeThumbnailToJSON(value['thumbnail']),
-        'tags': value['tags'],
-    };
-}
-

package/src/models/AttributeThumbnail.ts

@@ -1,80 +0,0 @@
-/* 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 { mapValues } from '../runtime';
-/**
- * Attribute thumbnail
- * @export
- * @interface AttributeThumbnail
- */
-export interface AttributeThumbnail {
-    /**
-     * 
-     * @type {string}
-     * @memberof AttributeThumbnail
-     */
-    type?: AttributeThumbnailTypeEnum;
-    /**
-     * 
-     * @type {string}
-     * @memberof AttributeThumbnail
-     */
-    value?: string;
-}
-
-
-/**
- * @export
- */
-export const AttributeThumbnailTypeEnum = {
-    Text: 'text',
-    Color: 'color',
-    Image: 'image'
-} as const;
-export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
-
-
-/**
- * Check if a given object implements the AttributeThumbnail interface.
- */
-export function instanceOfAttributeThumbnail(value: object): boolean {
-    return true;
-}
-
-export function AttributeThumbnailFromJSON(json: any): AttributeThumbnail {
-    return AttributeThumbnailFromJSONTyped(json, false);
-}
-
-export function AttributeThumbnailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttributeThumbnail {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'type': json['type'] == null ? undefined : json['type'],
-        'value': json['value'] == null ? undefined : json['value'],
-    };
-}
-
-export function AttributeThumbnailToJSON(value?: AttributeThumbnail | null): any {
-    if (value == null) {
-        return value;
-    }
-    return {
-        
-        'type': value['type'],
-        'value': value['value'],
-    };
-}
-