@teemill/gfn-catalog 1.2.0 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/gfn-catalog",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "OpenAPI client for @teemill/gfn-catalog",
   "author": "OpenAPI-Generator",
   "repository": {
@@ -9,11 +9,13 @@
   },
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc -p tsconfig.esm.json",
     "prepare": "npm run build"
   },
   "devDependencies": {
-    "typescript": "^4.0"
+    "typescript": "^4.0 || ^5.0"
   }
 }

package/src/apis/ProductsApi.ts

@@ -4,7 +4,7 @@
  * 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.2.0
+ * 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).
@@ -16,11 +16,14 @@
 import * as runtime from '../runtime';
 import type {
   ApiError,
+  ApiValidationError,
   ProductsResponse,
 } from '../models/index';
 import {
     ApiErrorFromJSON,
     ApiErrorToJSON,
+    ApiValidationErrorFromJSON,
+    ApiValidationErrorToJSON,
     ProductsResponseFromJSON,
     ProductsResponseToJSON,
 } from '../models/index';

package/src/apis/StatementsApi.ts

@@ -0,0 +1,177 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ApiError,
+  ApiValidationError,
+  ListStatements200Response,
+  Statement,
+} from '../models/index';
+import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    ApiValidationErrorFromJSON,
+    ApiValidationErrorToJSON,
+    ListStatements200ResponseFromJSON,
+    ListStatements200ResponseToJSON,
+    StatementFromJSON,
+    StatementToJSON,
+} from '../models/index';
+
+export interface GetStatementRequest {
+    project: string;
+    statementId: string;
+}
+
+export interface ListStatementsRequest {
+    project: string;
+    pageToken?: number;
+    pageSize?: number;
+    search?: string;
+}
+
+/**
+ * 
+ */
+export class StatementsApi extends runtime.BaseAPI {
+
+    /**
+     * Gets a GFN statement by the given ID.
+     * Get a GFN statement
+     */
+    async getStatementRaw(requestParameters: GetStatementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Statement>> {
+        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: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        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/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
+     */
+    async getStatement(
+        project: string, statementId: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<Statement> {
+        const response = await this.getStatementRaw(
+            {
+                project: project,statementId: statementId,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * Lists GFN statements available to the project
+     * List GFN statements
+     */
+    async listStatementsRaw(requestParameters: ListStatementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListStatements200Response>> {
+        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: 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.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/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
+     */
+    async listStatements(
+        project: string, 
+        optionalParameters: runtime.OptionalOnly<ListStatementsRequest> = {},
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ListStatements200Response> {
+        const response = await this.listStatementsRaw(
+            {
+                project: project,
+                ...optionalParameters,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+}

package/src/apis/TransactionsApi.ts

@@ -0,0 +1,180 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ApiError,
+  ApiValidationError,
+  ExportTransactionsRequest,
+  ListTransactions200Response,
+} from '../models/index';
+import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    ApiValidationErrorFromJSON,
+    ApiValidationErrorToJSON,
+    ExportTransactionsRequestFromJSON,
+    ExportTransactionsRequestToJSON,
+    ListTransactions200ResponseFromJSON,
+    ListTransactions200ResponseToJSON,
+} from '../models/index';
+
+export interface ExportTransactionsOperationRequest {
+    project: string;
+    exportTransactionsRequest: ExportTransactionsRequest;
+}
+
+export interface ListTransactionsRequest {
+    project: string;
+    pageToken?: number;
+    pageSize?: number;
+    statementId?: string;
+}
+
+/**
+ * 
+ */
+export class TransactionsApi extends runtime.BaseAPI {
+
+    /**
+     * Exports all GFN transactions available to the project
+     * Export GFN transactions
+     */
+    async exportTransactionsRaw(requestParameters: ExportTransactionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        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: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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/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
+     */
+    async exportTransactions(
+        project: string, exportTransactionsRequest: ExportTransactionsRequest, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<Blob> {
+        const response = await this.exportTransactionsRaw(
+            {
+                project: project,exportTransactionsRequest: exportTransactionsRequest,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * Lists all GFN transactions available to the project
+     * List GFN transactions
+     */
+    async listTransactionsRaw(requestParameters: ListTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListTransactions200Response>> {
+        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: 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.statementId !== undefined) {
+            queryParameters['statementId'] = requestParameters.statementId;
+        }
+
+        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/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
+     */
+    async listTransactions(
+        project: string, 
+        optionalParameters: runtime.OptionalOnly<ListTransactionsRequest> = {},
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ListTransactions200Response> {
+        const response = await this.listTransactionsRaw(
+            {
+                project: project,
+                ...optionalParameters,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+}

package/src/apis/VariantsApi.ts

@@ -4,7 +4,7 @@
  * 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.2.0
+ * 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).
@@ -16,21 +16,33 @@
 import * as runtime from '../runtime';
 import type {
   ApiError,
+  ApiValidationError,
   StockResponse,
   Variant,
+  VariantStock,
   VariantsResponse,
 } from '../models/index';
 import {
     ApiErrorFromJSON,
     ApiErrorToJSON,
+    ApiValidationErrorFromJSON,
+    ApiValidationErrorToJSON,
     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;
@@ -39,8 +51,10 @@ export interface GetVariantRequest {
 
 export interface ListStockRequest {
     project: string;
+    fulfillmentProjects?: string;
     pageToken?: number;
     pageSize?: number;
+    search?: string;
 }
 
 export interface ListVariantsRequest {
@@ -56,6 +70,70 @@ export interface ListVariantsRequest {
  */
 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
@@ -135,6 +213,10 @@ export class VariantsApi extends runtime.BaseAPI {
             queryParameters['project'] = requestParameters.project;
         }
 
+        if (requestParameters.fulfillmentProjects !== undefined) {
+            queryParameters['fulfillmentProjects'] = requestParameters.fulfillmentProjects;
+        }
+
         if (requestParameters.pageToken !== undefined) {
             queryParameters['pageToken'] = requestParameters.pageToken;
         }
@@ -143,6 +225,10 @@ export class VariantsApi extends runtime.BaseAPI {
             queryParameters['pageSize'] = requestParameters.pageSize;
         }
 
+        if (requestParameters.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {

package/src/apis/index.ts

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

package/src/models/ApiError.ts

@@ -4,7 +4,7 @@
  * 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.2.0
+ * 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).
@@ -36,8 +36,8 @@ export interface ApiError {
 /**
  * Check if a given object implements the ApiError interface.
  */
-export function instanceOfApiError(value: object): boolean {
-    if (!('message' in value)) return false;
+export function instanceOfApiError(value: object): value is ApiError {
+    if (!('message' in value) || value['message'] === undefined) return false;
     return true;
 }
 

package/src/models/ApiValidationError.ts

@@ -0,0 +1,70 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ApiValidationError
+ */
+export interface ApiValidationError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiValidationError
+     */
+    message: string;
+    /**
+     * 
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof ApiValidationError
+     */
+    errors: { [key: string]: Array<string>; };
+}
+
+/**
+ * Check if a given object implements the ApiValidationError interface.
+ */
+export function instanceOfApiValidationError(value: object): value is ApiValidationError {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('errors' in value) || value['errors'] === undefined) return false;
+    return true;
+}
+
+export function ApiValidationErrorFromJSON(json: any): ApiValidationError {
+    return ApiValidationErrorFromJSONTyped(json, false);
+}
+
+export function ApiValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiValidationError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'errors': json['errors'],
+    };
+}
+
+export function ApiValidationErrorToJSON(value?: ApiValidationError | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'message': value['message'],
+        'errors': value['errors'],
+    };
+}
+

package/src/models/Attribute.ts

@@ -4,7 +4,7 @@
  * 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.2.0
+ * 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).
@@ -55,9 +55,9 @@ export interface Attribute {
 /**
  * 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;
+export function instanceOfAttribute(value: object): value is Attribute {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
     return true;
 }