@teemill/gfn-catalog 3.9.1 → 3.9.4

package/dist/esm/index.d.ts

@@ -2,7 +2,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/dist/esm/index.js

@@ -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/dist/index.d.ts

@@ -2,7 +2,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/dist/index.js

@@ -5,7 +5,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/docs/ApiError.md

@@ -1,12 +1,13 @@
 # ApiError
 
+Represents an error returned by the API.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [default to undefined]
+**code** | **string** | A machine-readable error code identifying the type of error. | [optional] [default to undefined]
+**message** | **string** | A human-readable message providing more details about the error. | [default to undefined]
 
 ## Example
 

package/docs/ApiValidationError.md

@@ -1,12 +1,13 @@
 # ApiValidationError
 
+Represents a validation error returned by the API, including field-level error details.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**message** | **string** |  | [default to undefined]
-**errors** | **{ [key: string]: Array<string>; }** |  | [default to undefined]
+**message** | **string** | A human-readable summary of the validation error. | [default to undefined]
+**errors** | **{ [key: string]: Array<string>; }** | A map of field names to arrays of validation error messages. | [default to undefined]
 
 ## Example
 

package/docs/Fulfillment.md

@@ -1,14 +1,15 @@
 # Fulfillment
 
+A GFN fulfillment summary showing the total cost of transactions.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** |  | [default to undefined]
-**merchantRef** | **string** |  | [default to undefined]
-**total** | **number** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
+**id** | **number** | The identifier of the fulfillment. | [default to undefined]
+**merchantRef** | **string** | The merchant\'s reference for this fulfillment. | [default to undefined]
+**total** | **number** | The total cost of all transactions for this fulfillment. | [default to undefined]
+**createdAt** | **string** | The timestamp when the fulfillment was created. | [default to undefined]
 
 ## Example
 

package/docs/Image.md

@@ -1,18 +1,18 @@
 # Image
 
-Image description
+An image associated with a product or variant.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**src** | **string** |  | [default to undefined]
-**alt** | **string** |  | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the image. | [optional] [default to undefined]
+**src** | **string** | The URL of the image. | [default to undefined]
+**alt** | **string** | Alternative text for the image. | [optional] [default to undefined]
 **variantIds** | **Array<string>** | List of variant Ids | [optional] [default to undefined]
-**sortOrder** | **number** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
+**sortOrder** | **number** | The display order of the image. | [optional] [default to undefined]
+**createdAt** | **string** | The timestamp when the image was created. | [optional] [default to undefined]
+**updatedAt** | **string** | The timestamp when the image was last updated. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Location.md

@@ -1,5 +1,6 @@
 # Location
 
+A stock location showing the number of units available at a specific warehouse location.
 
 ## Properties
 

package/docs/Product.md

@@ -1,18 +1,19 @@
 # Product
 
+A warehouse product available in the Global Fulfillment Network catalog.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [default to undefined]
-**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
-**title** | **string** |  | [default to undefined]
-**styleCode** | **string** |  | [optional] [default to undefined]
-**material** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**specifications** | **string** |  | [optional] [default to undefined]
-**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | Attributes associated to a product such as Colour and Size. | [default to undefined]
+**id** | **string** | The unique identifier of the product. | [default to undefined]
+**ref** | **string** | A URI reference to this product resource. | [optional] [default to undefined]
+**title** | **string** | The display title of the product. | [default to undefined]
+**styleCode** | **string** | The style code identifying this product type. | [optional] [default to undefined]
+**material** | **string** | The material composition of the product. | [optional] [default to undefined]
+**description** | **string** | A description of the product. | [optional] [default to undefined]
+**specifications** | **string** | Product specifications. | [optional] [default to undefined]
+**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | The available attributes (e.g. Colour, Size) for this product. | [default to undefined]
 **images** | [**Array<ProductImagesInner>**](ProductImagesInner.md) | Images attached to the product. For example, photos of models using/wearing the product. This property currently does not include images linked to specific variants. | [optional] [default to undefined]
 **variants** | [**Array<ProductVariantsInner>**](ProductVariantsInner.md) | Variants | [default to undefined]
 **brand** | [**ProductBrand**](ProductBrand.md) |  | [optional] [default to undefined]

package/docs/ProductBrand.md

@@ -1,5 +1,6 @@
 # ProductBrand
 
+The brand that manufactures or supplies this product.
 
 ## Properties
 

package/docs/ProductsApi.md

@@ -24,7 +24,7 @@ const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
-let productId: string; // (default to undefined)
+let productId: string; //The unique identifier of the GFN catalog product. (default to undefined)
 let fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getProduct(
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.getProduct(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
-| **productId** | [**string**] |  | defaults to undefined|
+| **productId** | [**string**] | The unique identifier of the GFN catalog product. | defaults to undefined|
 | **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
 
 

package/docs/Statement.md

@@ -1,18 +1,19 @@
 # Statement
 
+A GFN billing statement summarising fulfillment costs over a period.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [default to undefined]
-**ref** | **string** | A reference to the resource location | [default to undefined]
-**total** | **number** |  | [default to undefined]
-**startDate** | **string** |  | [default to undefined]
-**endDate** | **string** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**fulfillmentCount** | **number** |  | [default to undefined]
-**issuedAt** | **string** |  | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the statement. | [default to undefined]
+**ref** | **string** | A URI reference to this statement resource. | [default to undefined]
+**total** | **number** | The total cost of all transactions in this statement. | [default to undefined]
+**startDate** | **string** | The start date of the billing period. | [default to undefined]
+**endDate** | **string** | The end date of the billing period. | [default to undefined]
+**createdAt** | **string** | The timestamp when the statement was created. | [default to undefined]
+**fulfillmentCount** | **number** | The number of fulfillments included in this statement. | [default to undefined]
+**issuedAt** | **string** | The timestamp when the statement was issued. | [optional] [default to undefined]
 
 ## Example
 

package/docs/StatementsApi.md

@@ -24,7 +24,7 @@ const configuration = new Configuration();
 const apiInstance = new StatementsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
-let statementId: string; // (default to undefined)
+let statementId: string; //The unique identifier of the GFN statement. (default to undefined)
 
 const { status, data } = await apiInstance.getStatement(
     project,
@@ -37,7 +37,7 @@ const { status, data } = await apiInstance.getStatement(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
-| **statementId** | [**string**] |  | defaults to undefined|
+| **statementId** | [**string**] | The unique identifier of the GFN statement. | defaults to undefined|
 
 
 ### Return type

package/docs/Stock.md

@@ -1,12 +1,13 @@
 # Stock
 
+Stock availability information including total level and per-location breakdown.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **level** | **number** | Current stock level | [optional] [default to undefined]
-**locations** | [**Array<Location>**](Location.md) |  | [optional] [default to undefined]
+**locations** | [**Array<Location>**](Location.md) | Stock levels broken down by warehouse location. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Transaction.md

@@ -1,21 +1,22 @@
 # Transaction
 
+A GFN transaction representing a cost incurred for a fulfillment (blank, application, or shipping).
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [default to undefined]
-**ref** | **string** | A reference to the resource location | [default to undefined]
-**statement** | **string** | A reference to the resource location | [optional] [default to undefined]
-**cost** | **number** |  | [optional] [default to undefined]
-**quantity** | **number** |  | [default to undefined]
-**type** | **string** |  | [optional] [default to undefined]
-**taxable** | **boolean** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**fulfillmentId** | **number** |  | [optional] [default to undefined]
-**orderId** | **number** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the transaction. | [default to undefined]
+**ref** | **string** | A URI reference to this transaction resource. | [default to undefined]
+**statement** | **string** | A reference to the statement this transaction belongs to. Null if not yet included in a statement. | [optional] [default to undefined]
+**cost** | **number** | The cost of this transaction. | [optional] [default to undefined]
+**quantity** | **number** | The number of units this transaction covers. | [default to undefined]
+**type** | **string** | The type of transaction: \'blank\' for base product cost, \'application\' for design application cost, \'shipping\' for shipping cost. | [optional] [default to undefined]
+**taxable** | **boolean** | Whether this transaction is subject to tax. | [optional] [default to undefined]
+**createdAt** | **string** | The timestamp when the transaction was created. | [default to undefined]
+**fulfillmentId** | **number** | The identifier of the fulfillment this transaction relates to. | [optional] [default to undefined]
+**orderId** | **number** | The identifier of the order this transaction relates to. | [optional] [default to undefined]
+**description** | **string** | A human-readable description of the transaction. | [optional] [default to undefined]
 
 ## Example
 

package/docs/TransactionsApi.md

@@ -60,8 +60,8 @@ const { status, data } = await apiInstance.exportTransactions(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Returns the CSV export |  -  |
-|**202** | The export has been queued and will be available shortly |  -  |
+|**200** | The dataset is small enough to return immediately. Returns the CSV export directly. |  -  |
+|**202** | The dataset is too large to return immediately. The export has been queued and a notification will be sent when it is ready for download. |  -  |
 |**204** | Export contains no data |  -  |
 |**400** | Failed validation. |  -  |
 |**401** | Not authorised to access this resource. |  -  |
@@ -88,7 +88,7 @@ const configuration = new Configuration();
 const apiInstance = new TransactionsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
-let transactionId: string; // (default to undefined)
+let transactionId: string; //The unique identifier of the GFN transaction. (default to undefined)
 
 const { status, data } = await apiInstance.getTransaction(
     project,
@@ -101,7 +101,7 @@ const { status, data } = await apiInstance.getTransaction(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
-| **transactionId** | [**string**] |  | defaults to undefined|
+| **transactionId** | [**string**] | The unique identifier of the GFN transaction. | defaults to undefined|
 
 
 ### Return type
@@ -149,7 +149,7 @@ const apiInstance = new TransactionsApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
-let statementId: string; // (optional) (default to undefined)
+let statementId: string; //Filter fulfillments by statement ID. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listFulfillments(
     project,
@@ -166,7 +166,7 @@ const { status, data } = await apiInstance.listFulfillments(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **statementId** | [**string**] |  | (optional) defaults to undefined|
+| **statementId** | [**string**] | Filter fulfillments by statement ID. | (optional) defaults to undefined|
 
 
 ### Return type
@@ -213,8 +213,8 @@ const apiInstance = new TransactionsApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
-let statementId: string; // (optional) (default to undefined)
-let fulfillmentId: string; // (optional) (default to undefined)
+let statementId: string; //Filter transactions by statement ID. (optional) (default to undefined)
+let fulfillmentId: string; //Filter transactions by fulfillment ID. (optional) (default to undefined)
 let search: string; //Search by fulfillment id (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listTransactions(
@@ -234,8 +234,8 @@ const { status, data } = await apiInstance.listTransactions(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **statementId** | [**string**] |  | (optional) defaults to undefined|
-| **fulfillmentId** | [**string**] |  | (optional) defaults to undefined|
+| **statementId** | [**string**] | Filter transactions by statement ID. | (optional) defaults to undefined|
+| **fulfillmentId** | [**string**] | Filter transactions by fulfillment ID. | (optional) defaults to undefined|
 | **search** | [**string**] | Search by fulfillment id | (optional) defaults to undefined|
 
 

package/docs/Variant.md

@@ -1,18 +1,19 @@
 # Variant
 
+A specific colour/size combination of a GFN catalog product.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the variant. | [optional] [default to undefined]
+**ref** | **string** | A URI reference to this variant resource. | [optional] [default to undefined]
 **product** | [**VariantProduct**](VariantProduct.md) |  | [optional] [default to undefined]
-**sku** | **string** |  | [default to undefined]
-**attributes** | [**Array<Attribute>**](Attribute.md) | 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. | [default to undefined]
+**sku** | **string** | The stock keeping unit code for this variant. | [default to undefined]
+**attributes** | [**Array<Attribute>**](Attribute.md) | The attributes (e.g. Colour, Size) that define this variant. | [default to undefined]
 **manufacturerOrigin** | [**VariantManufacturerOrigin**](VariantManufacturerOrigin.md) |  | [optional] [default to undefined]
-**stock** | [**Stock**](Stock.md) |  | [optional] [default to undefined]
-**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
+**stock** | [**Stock**](Stock.md) | The stock levels for this variant. | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) | Product images for this variant. | [optional] [default to undefined]
 
 ## Example
 

package/docs/VariantProduct.md

@@ -1,5 +1,6 @@
 # VariantProduct
 
+A reference to the product this variant belongs to.
 
 ## Properties
 

package/docs/VariantStock.md

@@ -1,16 +1,17 @@
 # VariantStock
 
+Stock information for a specific variant, including per-location breakdown.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the variant. | [optional] [default to undefined]
 **name** | **string** | The product name of the variant stock | [optional] [default to undefined]
-**sku** | **string** |  | [optional] [default to undefined]
-**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
-**productRef** | **string** | A reference to the resource location | [optional] [default to undefined]
-**stock** | [**Stock**](Stock.md) |  | [optional] [default to undefined]
+**sku** | **string** | A unique identifier for a specific variant (product + colour + size). | [optional] [default to undefined]
+**ref** | **string** | A URI reference to this variant resource. | [optional] [default to undefined]
+**productRef** | **string** | A URI reference to the product this variant belongs to. | [optional] [default to undefined]
+**stock** | [**Stock**](Stock.md) | The stock levels for this variant. | [optional] [default to undefined]
 
 ## Example
 

package/index.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/gfn-catalog",
-  "version": "3.9.1",
+  "version": "3.9.4",
   "description": "OpenAPI client for @teemill/gfn-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -24,7 +24,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "axios": "1.13.5"
+    "axios": "1.15.0"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",