@teemill/gfn-catalog 1.3.0 → 1.4.0

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.3.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,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   ApiError,
+  ApiValidationError,
   StockResponse,
   Variant,
   VariantStock,
@@ -24,6 +25,8 @@ import type {
 import {
     ApiErrorFromJSON,
     ApiErrorToJSON,
+    ApiValidationErrorFromJSON,
+    ApiValidationErrorToJSON,
     StockResponseFromJSON,
     StockResponseToJSON,
     VariantFromJSON,

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.3.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.3.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;
 }
 

package/src/models/AttributeThumbnail.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.3.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).
@@ -48,7 +48,7 @@ export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof
 /**
  * Check if a given object implements the AttributeThumbnail interface.
  */
-export function instanceOfAttributeThumbnail(value: object): boolean {
+export function instanceOfAttributeThumbnail(value: object): value is AttributeThumbnail {
     return true;
 }
 

package/src/models/ExportTransactionsRequest.ts

@@ -0,0 +1,76 @@
+/* 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 ExportTransactionsRequest
+ */
+export interface ExportTransactionsRequest {
+    /**
+     * The start date for the export
+     * @type {Date}
+     * @memberof ExportTransactionsRequest
+     */
+    start?: Date;
+    /**
+     * The end date for the export
+     * @type {Date}
+     * @memberof ExportTransactionsRequest
+     */
+    end?: Date;
+    /**
+     * Include only transactions from this statement
+     * @type {string}
+     * @memberof ExportTransactionsRequest
+     */
+    statement?: string;
+}
+
+/**
+ * Check if a given object implements the ExportTransactionsRequest interface.
+ */
+export function instanceOfExportTransactionsRequest(value: object): value is ExportTransactionsRequest {
+    return true;
+}
+
+export function ExportTransactionsRequestFromJSON(json: any): ExportTransactionsRequest {
+    return ExportTransactionsRequestFromJSONTyped(json, false);
+}
+
+export function ExportTransactionsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportTransactionsRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'start': json['start'] == null ? undefined : (new Date(json['start'])),
+        'end': json['end'] == null ? undefined : (new Date(json['end'])),
+        'statement': json['statement'] == null ? undefined : json['statement'],
+    };
+}
+
+export function ExportTransactionsRequestToJSON(value?: ExportTransactionsRequest | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'start': value['start'] == null ? undefined : ((value['start']).toISOString()),
+        'end': value['end'] == null ? undefined : ((value['end']).toISOString()),
+        'statement': value['statement'],
+    };
+}
+

package/src/models/Image.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.3.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).
@@ -66,7 +66,7 @@ export interface Image {
 /**
  * Check if a given object implements the Image interface.
  */
-export function instanceOfImage(value: object): boolean {
+export function instanceOfImage(value: object): value is Image {
     return true;
 }
 

package/src/models/ListStatements200Response.ts

@@ -0,0 +1,75 @@
+/* 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';
+import type { Statement } from './Statement';
+import {
+    StatementFromJSON,
+    StatementFromJSONTyped,
+    StatementToJSON,
+} from './Statement';
+
+/**
+ * 
+ * @export
+ * @interface ListStatements200Response
+ */
+export interface ListStatements200Response {
+    /**
+     * 
+     * @type {Array<Statement>}
+     * @memberof ListStatements200Response
+     */
+    statements?: Array<Statement>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListStatements200Response
+     */
+    nextPageToken?: number;
+}
+
+/**
+ * Check if a given object implements the ListStatements200Response interface.
+ */
+export function instanceOfListStatements200Response(value: object): value is ListStatements200Response {
+    return true;
+}
+
+export function ListStatements200ResponseFromJSON(json: any): ListStatements200Response {
+    return ListStatements200ResponseFromJSONTyped(json, false);
+}
+
+export function ListStatements200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListStatements200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'statements': json['statements'] == null ? undefined : ((json['statements'] as Array<any>).map(StatementFromJSON)),
+        'nextPageToken': json['nextPageToken'] == null ? undefined : json['nextPageToken'],
+    };
+}
+
+export function ListStatements200ResponseToJSON(value?: ListStatements200Response | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'statements': value['statements'] == null ? undefined : ((value['statements'] as Array<any>).map(StatementToJSON)),
+        'nextPageToken': value['nextPageToken'],
+    };
+}
+

package/src/models/ListTransactions200Response.ts

@@ -0,0 +1,75 @@
+/* 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';
+import type { Transaction } from './Transaction';
+import {
+    TransactionFromJSON,
+    TransactionFromJSONTyped,
+    TransactionToJSON,
+} from './Transaction';
+
+/**
+ * 
+ * @export
+ * @interface ListTransactions200Response
+ */
+export interface ListTransactions200Response {
+    /**
+     * 
+     * @type {Array<Transaction>}
+     * @memberof ListTransactions200Response
+     */
+    transactions?: Array<Transaction>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListTransactions200Response
+     */
+    nextPageToken?: number;
+}
+
+/**
+ * Check if a given object implements the ListTransactions200Response interface.
+ */
+export function instanceOfListTransactions200Response(value: object): value is ListTransactions200Response {
+    return true;
+}
+
+export function ListTransactions200ResponseFromJSON(json: any): ListTransactions200Response {
+    return ListTransactions200ResponseFromJSONTyped(json, false);
+}
+
+export function ListTransactions200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListTransactions200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'transactions': json['transactions'] == null ? undefined : ((json['transactions'] as Array<any>).map(TransactionFromJSON)),
+        'nextPageToken': json['nextPageToken'] == null ? undefined : json['nextPageToken'],
+    };
+}
+
+export function ListTransactions200ResponseToJSON(value?: ListTransactions200Response | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'transactions': value['transactions'] == null ? undefined : ((value['transactions'] as Array<any>).map(TransactionToJSON)),
+        'nextPageToken': value['nextPageToken'],
+    };
+}
+

package/src/models/Product.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.3.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).
@@ -66,8 +66,8 @@ export interface Product {
 /**
  * Check if a given object implements the Product interface.
  */
-export function instanceOfProduct(value: object): boolean {
-    if (!('title' in value)) return false;
+export function instanceOfProduct(value: object): value is Product {
+    if (!('title' in value) || value['title'] === undefined) return false;
     return true;
 }
 

package/src/models/ProductsResponse.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.3.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).
@@ -43,7 +43,7 @@ export interface ProductsResponse {
 /**
  * Check if a given object implements the ProductsResponse interface.
  */
-export function instanceOfProductsResponse(value: object): boolean {
+export function instanceOfProductsResponse(value: object): value is ProductsResponse {
     return true;
 }