@teemill/gfn-catalog 1.2.0 → 1.4.0

package/dist/esm/apis/ProductsApi.js

@@ -0,0 +1,81 @@
+/* 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.4.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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { ProductsResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class ProductsApi extends runtime.BaseAPI {
+    /**
+     * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
+     * List GFN products
+     */
+    listProductsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.project === null || requestParameters.project === undefined) {
+                throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listProducts.');
+            }
+            const queryParameters = {};
+            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 = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+            }
+            const response = yield this.request({
+                path: `/v1/gfn/catalog/products`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ProductsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
+     * List GFN products
+     */
+    listProducts(project_1) {
+        return __awaiter(this, arguments, void 0, function* (project, optionalParameters = {}, initOverrides) {
+            const response = yield this.listProductsRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/StatementsApi.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.4.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 { ListStatements200Response, Statement } from '../models/index';
+export interface GetStatementRequest {
+    project: string;
+    statementId: string;
+}
+export interface ListStatementsRequest {
+    project: string;
+    pageToken?: number;
+    pageSize?: number;
+    search?: string;
+}
+/**
+ *
+ */
+export declare class StatementsApi extends runtime.BaseAPI {
+    /**
+     * Gets a GFN statement by the given ID.
+     * Get a GFN statement
+     */
+    getStatementRaw(requestParameters: GetStatementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Statement>>;
+    /**
+     * Gets a GFN statement by the given ID.
+     * Get a GFN statement
+     */
+    getStatement(project: string, statementId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Statement>;
+    /**
+     * Lists GFN statements available to the project
+     * List GFN statements
+     */
+    listStatementsRaw(requestParameters: ListStatementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListStatements200Response>>;
+    /**
+     * Lists GFN statements available to the project
+     * List GFN statements
+     */
+    listStatements(project: string, optionalParameters?: runtime.OptionalOnly<ListStatementsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListStatements200Response>;
+}

package/dist/esm/apis/StatementsApi.js

@@ -0,0 +1,123 @@
+/* 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.4.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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { ListStatements200ResponseFromJSON, StatementFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class StatementsApi extends runtime.BaseAPI {
+    /**
+     * Gets a GFN statement by the given ID.
+     * Get a GFN statement
+     */
+    getStatementRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.project === null || requestParameters.project === undefined) {
+                throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling getStatement.');
+            }
+            if (requestParameters.statementId === null || requestParameters.statementId === undefined) {
+                throw new runtime.RequiredError('statementId', 'Required parameter requestParameters.statementId was null or undefined when calling getStatement.');
+            }
+            const queryParameters = {};
+            if (requestParameters.project !== undefined) {
+                queryParameters['project'] = requestParameters.project;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+            }
+            const response = yield this.request({
+                path: `/v1/gfn/statements/{statementId}`.replace(`{${"statementId"}}`, encodeURIComponent(String(requestParameters.statementId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StatementFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Gets a GFN statement by the given ID.
+     * Get a GFN statement
+     */
+    getStatement(project, statementId, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getStatementRaw({
+                project: project, statementId: statementId,
+            }, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lists GFN statements available to the project
+     * List GFN statements
+     */
+    listStatementsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.project === null || requestParameters.project === undefined) {
+                throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listStatements.');
+            }
+            const queryParameters = {};
+            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.search !== undefined) {
+                queryParameters['search'] = requestParameters.search;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+            }
+            const response = yield this.request({
+                path: `/v1/gfn/statements`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListStatements200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Lists GFN statements available to the project
+     * List GFN statements
+     */
+    listStatements(project_1) {
+        return __awaiter(this, arguments, void 0, function* (project, optionalParameters = {}, initOverrides) {
+            const response = yield this.listStatementsRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/TransactionsApi.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.4.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 { ExportTransactionsRequest, ListTransactions200Response } from '../models/index';
+export interface ExportTransactionsOperationRequest {
+    project: string;
+    exportTransactionsRequest: ExportTransactionsRequest;
+}
+export interface ListTransactionsRequest {
+    project: string;
+    pageToken?: number;
+    pageSize?: number;
+    statementId?: string;
+}
+/**
+ *
+ */
+export declare class TransactionsApi extends runtime.BaseAPI {
+    /**
+     * Exports all GFN transactions available to the project
+     * Export GFN transactions
+     */
+    exportTransactionsRaw(requestParameters: ExportTransactionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Exports all GFN transactions available to the project
+     * Export GFN transactions
+     */
+    exportTransactions(project: string, exportTransactionsRequest: ExportTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Lists all GFN transactions available to the project
+     * List GFN transactions
+     */
+    listTransactionsRaw(requestParameters: ListTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListTransactions200Response>>;
+    /**
+     * Lists all GFN transactions available to the project
+     * List GFN transactions
+     */
+    listTransactions(project: string, optionalParameters?: runtime.OptionalOnly<ListTransactionsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListTransactions200Response>;
+}

package/dist/esm/apis/TransactionsApi.js

@@ -0,0 +1,125 @@
+/* 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.4.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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { ExportTransactionsRequestToJSON, ListTransactions200ResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class TransactionsApi extends runtime.BaseAPI {
+    /**
+     * Exports all GFN transactions available to the project
+     * Export GFN transactions
+     */
+    exportTransactionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.project === null || requestParameters.project === undefined) {
+                throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling exportTransactions.');
+            }
+            if (requestParameters.exportTransactionsRequest === null || requestParameters.exportTransactionsRequest === undefined) {
+                throw new runtime.RequiredError('exportTransactionsRequest', 'Required parameter requestParameters.exportTransactionsRequest was null or undefined when calling exportTransactions.');
+            }
+            const queryParameters = {};
+            if (requestParameters.project !== undefined) {
+                queryParameters['project'] = requestParameters.project;
+            }
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+            }
+            const response = yield this.request({
+                path: `/v1/gfn/transactions/export`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ExportTransactionsRequestToJSON(requestParameters.exportTransactionsRequest),
+            }, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Exports all GFN transactions available to the project
+     * Export GFN transactions
+     */
+    exportTransactions(project, exportTransactionsRequest, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.exportTransactionsRaw({
+                project: project, exportTransactionsRequest: exportTransactionsRequest,
+            }, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lists all GFN transactions available to the project
+     * List GFN transactions
+     */
+    listTransactionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.project === null || requestParameters.project === undefined) {
+                throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listTransactions.');
+            }
+            const queryParameters = {};
+            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.statementId !== undefined) {
+                queryParameters['statementId'] = requestParameters.statementId;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+            }
+            const response = yield this.request({
+                path: `/v1/gfn/transactions`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListTransactions200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Lists all GFN transactions available to the project
+     * List GFN transactions
+     */
+    listTransactions(project_1) {
+        return __awaiter(this, arguments, void 0, function* (project, optionalParameters = {}, initOverrides) {
+            const response = yield this.listTransactionsRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/VariantsApi.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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.4.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 { StockResponse, Variant, VariantStock, VariantsResponse } 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 declare class VariantsApi extends runtime.BaseAPI {
+    /**
+     * Gets the stock level for the GFN variant with the given ID.
+     * Get GFN variant stock
+     */
+    getStockRaw(requestParameters: GetStockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantStock>>;
+    /**
+     * Gets the stock level for the GFN variant with the given ID.
+     * Get GFN variant stock
+     */
+    getStock(project: string, variantId: string, optionalParameters?: runtime.OptionalOnly<GetStockRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantStock>;
+    /**
+     * Gets a GFN variant by the given ID.
+     * Get a GFN variant
+     */
+    getVariantRaw(requestParameters: GetVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Variant>>;
+    /**
+     * Gets a GFN variant by the given ID.
+     * Get a GFN variant
+     */
+    getVariant(project: string, variantId: string, optionalParameters?: runtime.OptionalOnly<GetVariantRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Variant>;
+    /**
+     * Lists the stock levels for all GFN variants available to the project.
+     * List GFN variant stock
+     */
+    listStockRaw(requestParameters: ListStockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StockResponse>>;
+    /**
+     * Lists the stock levels for all GFN variants available to the project.
+     * List GFN variant stock
+     */
+    listStock(project: string, optionalParameters?: runtime.OptionalOnly<ListStockRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StockResponse>;
+    /**
+     * 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
+     */
+    listVariantsRaw(requestParameters: ListVariantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantsResponse>>;
+    /**
+     * 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
+     */
+    listVariants(project: string, optionalParameters?: runtime.OptionalOnly<ListVariantsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantsResponse>;
+}