@teemill/gfn-catalog 3.9.1 → 3.9.4

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.20.0
+7.21.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/gfn-catalog@3.9.1
+## @teemill/gfn-catalog@3.9.4
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/gfn-catalog@3.9.1 --save
+npm install @teemill/gfn-catalog@3.9.4 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * GFN Catalog
  * Use this API to access the Global Fulfillment 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: 3.9.1
+ * The version of the OpenAPI document: 3.9.4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,12 +23,30 @@ import type { RequestArgs } from './base';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
 
+/**
+ * Represents an error returned by the API.
+ */
 export interface ApiError {
+    /**
+     * A machine-readable error code identifying the type of error.
+     */
     'code'?: string;
+    /**
+     * A human-readable message providing more details about the error.
+     */
     'message': string;
 }
+/**
+ * Represents a validation error returned by the API, including field-level error details.
+ */
 export interface ApiValidationError {
+    /**
+     * A human-readable summary of the validation error.
+     */
     'message': string;
+    /**
+     * A map of field names to arrays of validation error messages.
+     */
     'errors': { [key: string]: Array<string>; };
 }
 export interface Attribute {
@@ -57,7 +75,7 @@ export interface AttributeThumbnail {
 export const AttributeThumbnailTypeEnum = {
     Text: 'text',
     Color: 'color',
-    Image: 'image'
+    Image: 'image',
 } as const;
 
 export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
@@ -68,28 +86,58 @@ export interface ExportTransactionsRequest {
      */
     'statement'?: string;
 }
+/**
+ * A GFN fulfillment summary showing the total cost of transactions.
+ */
 export interface Fulfillment {
+    /**
+     * The identifier of the fulfillment.
+     */
     'id': number;
+    /**
+     * The merchant\'s reference for this fulfillment.
+     */
     'merchantRef': string;
+    /**
+     * The total cost of all transactions for this fulfillment.
+     */
     'total': number;
+    /**
+     * The timestamp when the fulfillment was created.
+     */
     'createdAt': string;
 }
 /**
- * Image description
+ * An image associated with a product or variant.
  */
 export interface Image {
     /**
-     * Unique object identifier
+     * The unique identifier of the image.
      */
     'id'?: string;
+    /**
+     * The URL of the image.
+     */
     'src': string;
+    /**
+     * Alternative text for the image.
+     */
     'alt'?: string;
     /**
      * List of variant Ids
      */
     'variantIds'?: Array<string>;
+    /**
+     * The display order of the image.
+     */
     'sortOrder'?: number;
+    /**
+     * The timestamp when the image was created.
+     */
     'createdAt'?: string;
+    /**
+     * The timestamp when the image was last updated.
+     */
     'updatedAt'?: string;
 }
 export interface ListFulfillments200Response {
@@ -104,6 +152,9 @@ export interface ListTransactions200Response {
     'transactions'?: Array<Transaction>;
     'nextPageToken'?: number | null;
 }
+/**
+ * A stock location showing the number of units available at a specific warehouse location.
+ */
 export interface Location {
     /**
      * The total number of units available at the location
@@ -114,22 +165,40 @@ export interface Location {
      */
     'country': string;
 }
+/**
+ * A warehouse product available in the Global Fulfillment Network catalog.
+ */
 export interface Product {
     /**
-     * Unique object identifier
+     * The unique identifier of the product.
      */
     'id': string;
     /**
-     * A reference to the resource location
+     * A URI reference to this product resource.
      */
     'ref'?: string;
+    /**
+     * The display title of the product.
+     */
     'title': string;
+    /**
+     * The style code identifying this product type.
+     */
     'styleCode'?: string;
+    /**
+     * The material composition of the product.
+     */
     'material'?: string;
+    /**
+     * A description of the product.
+     */
     'description'?: string;
+    /**
+     * Product specifications.
+     */
     'specifications'?: string;
     /**
-     * Attributes associated to a product such as Colour and Size.
+     * The available attributes (e.g. Colour, Size) for this product.
      */
     'attributes': Array<ProductAttribute>;
     /**
@@ -166,6 +235,9 @@ export interface ProductAttributeValuesInner {
      */
     'value': string;
 }
+/**
+ * The brand that manufactures or supplies this product.
+ */
 export interface ProductBrand {
     /**
      * the name of the brand that manufactures/supplies the product
@@ -199,83 +271,146 @@ export interface ProductsResponse {
     'products'?: Array<Product>;
     'nextPageToken'?: number | null;
 }
+/**
+ * A GFN billing statement summarising fulfillment costs over a period.
+ */
 export interface Statement {
     /**
-     * Unique object identifier
+     * The unique identifier of the statement.
      */
     'id': string;
     /**
-     * A reference to the resource location
+     * A URI reference to this statement resource.
      */
     'ref': string;
+    /**
+     * The total cost of all transactions in this statement.
+     */
     'total': number;
+    /**
+     * The start date of the billing period.
+     */
     'startDate': string;
+    /**
+     * The end date of the billing period.
+     */
     'endDate': string;
+    /**
+     * The timestamp when the statement was created.
+     */
     'createdAt': string;
+    /**
+     * The number of fulfillments included in this statement.
+     */
     'fulfillmentCount': number;
+    /**
+     * The timestamp when the statement was issued.
+     */
     'issuedAt'?: string;
 }
+/**
+ * Stock availability information including total level and per-location breakdown.
+ */
 export interface Stock {
     /**
      * Current stock level
      */
     'level'?: number;
+    /**
+     * Stock levels broken down by warehouse location.
+     */
     'locations'?: Array<Location>;
 }
 export interface StockResponse {
     'variants'?: Array<VariantStock>;
     'nextPageToken'?: number | null;
 }
+/**
+ * A GFN transaction representing a cost incurred for a fulfillment (blank, application, or shipping).
+ */
 export interface Transaction {
     /**
-     * Unique object identifier
+     * The unique identifier of the transaction.
      */
     'id': string;
     /**
-     * A reference to the resource location
+     * A URI reference to this transaction resource.
      */
     'ref': string;
     /**
-     * A reference to the resource location
+     * A reference to the statement this transaction belongs to. Null if not yet included in a statement.
      */
     'statement'?: string | null;
+    /**
+     * The cost of this transaction.
+     */
     'cost'?: number;
+    /**
+     * The number of units this transaction covers.
+     */
     'quantity': number;
+    /**
+     * The type of transaction: \'blank\' for base product cost, \'application\' for design application cost, \'shipping\' for shipping cost.
+     */
     'type'?: TransactionTypeEnum;
+    /**
+     * Whether this transaction is subject to tax.
+     */
     'taxable'?: boolean;
+    /**
+     * The timestamp when the transaction was created.
+     */
     'createdAt': string;
+    /**
+     * The identifier of the fulfillment this transaction relates to.
+     */
     'fulfillmentId'?: number;
+    /**
+     * The identifier of the order this transaction relates to.
+     */
     'orderId'?: number;
+    /**
+     * A human-readable description of the transaction.
+     */
     'description'?: string;
 }
 
 export const TransactionTypeEnum = {
     Blank: 'blank',
     Application: 'application',
-    Shipping: 'shipping'
+    Shipping: 'shipping',
 } as const;
 
 export type TransactionTypeEnum = typeof TransactionTypeEnum[keyof typeof TransactionTypeEnum];
 
+/**
+ * A specific colour/size combination of a GFN catalog product.
+ */
 export interface Variant {
     /**
-     * Unique object identifier
+     * The unique identifier of the variant.
      */
     'id'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to this variant resource.
      */
     'ref'?: string;
     'product'?: VariantProduct;
+    /**
+     * The stock keeping unit code for this variant.
+     */
     'sku': string;
     /**
-     * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
+     * The attributes (e.g. Colour, Size) that define this variant.
      */
     'attributes': Array<Attribute>;
     'manufacturerOrigin'?: VariantManufacturerOrigin;
+    /**
+     * The stock levels for this variant.
+     */
     'stock'?: Stock;
     /**
-     * Images
+     * Product images for this variant.
      */
     'images'?: Array<Image>;
 }
@@ -292,6 +427,9 @@ export interface VariantManufacturerOrigin {
      */
     'name'?: string;
 }
+/**
+ * A reference to the product this variant belongs to.
+ */
 export interface VariantProduct {
     /**
      * Unique object identifier
@@ -306,24 +444,33 @@ export interface VariantProduct {
      */
     'ref'?: string;
 }
+/**
+ * Stock information for a specific variant, including per-location breakdown.
+ */
 export interface VariantStock {
     /**
-     * Unique object identifier
+     * The unique identifier of the variant.
      */
     'id'?: string;
     /**
      * The product name of the variant stock
      */
     'name'?: string;
+    /**
+     * A unique identifier for a specific variant (product + colour + size).
+     */
     'sku'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to this variant resource.
      */
     'ref'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to the product this variant belongs to.
      */
     'productRef'?: string;
+    /**
+     * The stock levels for this variant.
+     */
     'stock'?: Stock;
 }
 export interface VariantsResponse {
@@ -340,7 +487,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
          * Gets a GFN product by the given ID.
          * @summary Get a GFN product
          * @param {string} project What project it is
-         * @param {string} productId 
+         * @param {string} productId The unique identifier of the GFN catalog product.
          * @param {string} [fields] Filter response fields to only include a subset of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -466,7 +613,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
          * Gets a GFN product by the given ID.
          * @summary Get a GFN product
          * @param {string} project What project it is
-         * @param {string} productId 
+         * @param {string} productId The unique identifier of the GFN catalog product.
          * @param {string} [fields] Filter response fields to only include a subset of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -535,6 +682,9 @@ export interface ProductsApiGetProductRequest {
      */
     readonly project: string
 
+    /**
+     * The unique identifier of the GFN catalog product.
+     */
     readonly productId: string
 
     /**
@@ -611,7 +761,7 @@ export const StatementsApiAxiosParamCreator = function (configuration?: Configur
          * Gets a GFN statement by the given ID.
          * @summary Get a GFN statement
          * @param {string} project What project it is
-         * @param {string} statementId 
+         * @param {string} statementId The unique identifier of the GFN statement.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -727,7 +877,7 @@ export const StatementsApiFp = function(configuration?: Configuration) {
          * Gets a GFN statement by the given ID.
          * @summary Get a GFN statement
          * @param {string} project What project it is
-         * @param {string} statementId 
+         * @param {string} statementId The unique identifier of the GFN statement.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -794,6 +944,9 @@ export interface StatementsApiGetStatementRequest {
      */
     readonly project: string
 
+    /**
+     * The unique identifier of the GFN statement.
+     */
     readonly statementId: string
 }
 
@@ -909,7 +1062,7 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
          * Gets a GFN transaction by the given ID.
          * @summary Get a GFN transaction
          * @param {string} project What project it is
-         * @param {string} transactionId 
+         * @param {string} transactionId The unique identifier of the GFN transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -959,7 +1112,7 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [statementId] 
+         * @param {string} [statementId] Filter fulfillments by statement ID.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1018,8 +1171,8 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [statementId] 
-         * @param {string} [fulfillmentId] 
+         * @param {string} [statementId] Filter transactions by statement ID.
+         * @param {string} [fulfillmentId] Filter transactions by fulfillment ID.
          * @param {string} [search] Search by fulfillment id
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1108,7 +1261,7 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
          * Gets a GFN transaction by the given ID.
          * @summary Get a GFN transaction
          * @param {string} project What project it is
-         * @param {string} transactionId 
+         * @param {string} transactionId The unique identifier of the GFN transaction.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1124,7 +1277,7 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [statementId] 
+         * @param {string} [statementId] Filter fulfillments by statement ID.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1140,8 +1293,8 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [statementId] 
-         * @param {string} [fulfillmentId] 
+         * @param {string} [statementId] Filter transactions by statement ID.
+         * @param {string} [fulfillmentId] Filter transactions by fulfillment ID.
          * @param {string} [search] Search by fulfillment id
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1228,6 +1381,9 @@ export interface TransactionsApiGetTransactionRequest {
      */
     readonly project: string
 
+    /**
+     * The unique identifier of the GFN transaction.
+     */
     readonly transactionId: string
 }
 
@@ -1250,6 +1406,9 @@ export interface TransactionsApiListFulfillmentsRequest {
      */
     readonly pageSize?: number
 
+    /**
+     * Filter fulfillments by statement ID.
+     */
     readonly statementId?: string
 }
 
@@ -1272,8 +1431,14 @@ export interface TransactionsApiListTransactionsRequest {
      */
     readonly pageSize?: number
 
+    /**
+     * Filter transactions by statement ID.
+     */
     readonly statementId?: string
 
+    /**
+     * Filter transactions by fulfillment ID.
+     */
     readonly fulfillmentId?: string
 
     /**

package/base.ts

@@ -4,7 +4,7 @@
  * GFN Catalog
  * Use this API to access the Global Fulfillment 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: 3.9.1
+ * The version of the OpenAPI document: 3.9.4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * GFN Catalog
  * Use this API to access the Global Fulfillment 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: 3.9.1
+ * The version of the OpenAPI document: 3.9.4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -3,7 +3,7 @@
  * GFN Catalog
  * Use this API to access the Global Fulfillment 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: 3.9.1
+ * The version of the OpenAPI document: 3.9.4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).