@teemill/gfn-catalog 3.5.0 → 3.6.1

package/docs/TransactionsApi.md

@@ -0,0 +1,205 @@
+# TransactionsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**exportTransactions**](#exporttransactions) | **POST** /v1/gfn/transactions/export | Export GFN transactions|
+|[**listFulfillments**](#listfulfillments) | **GET** /v1/gfn/transactions/fulfillments | Lists the GFN fulfillments of the project|
+|[**listTransactions**](#listtransactions) | **GET** /v1/gfn/transactions | List GFN transactions|
+
+# **exportTransactions**
+> File exportTransactions(exportTransactionsRequest)
+
+Exports all GFN transactions available to the project
+
+### Example
+
+```typescript
+import {
+    TransactionsApi,
+    Configuration,
+    ExportTransactionsRequest
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new TransactionsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let exportTransactionsRequest: ExportTransactionsRequest; //Period selection data for the export
+
+const { status, data } = await apiInstance.exportTransactions(
+    project,
+    exportTransactionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **exportTransactionsRequest** | **ExportTransactionsRequest**| Period selection data for the export | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/csv; charset=utf-8, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Returns the CSV export |  -  |
+|**202** | The export has been queued and will be available shortly |  -  |
+|**204** | Export contains no data |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listFulfillments**
+> InlineObject2 listFulfillments()
+
+Lists all the fulfillments in the project with GFN transactions
+
+### Example
+
+```typescript
+import {
+    TransactionsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+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)
+
+const { status, data } = await apiInstance.listFulfillments(
+    project,
+    pageToken,
+    pageSize,
+    statementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+
+
+### Return type
+
+**InlineObject2**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved GFN fulfillments. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listTransactions**
+> InlineObject1 listTransactions()
+
+Lists all GFN transactions available to the project
+
+### Example
+
+```typescript
+import {
+    TransactionsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+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 search: string; //Search by fulfillment id (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listTransactions(
+    project,
+    pageToken,
+    pageSize,
+    statementId,
+    fulfillmentId,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+| **search** | [**string**] | Search by fulfillment id | (optional) defaults to undefined|
+
+
+### Return type
+
+**InlineObject1**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved GFN transactions. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/Variant.md

@@ -0,0 +1,34 @@
+# Variant
+
+
+## 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]
+**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]
+**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]
+
+## Example
+
+```typescript
+import { Variant } from '@teemill/gfn-catalog';
+
+const instance: Variant = {
+    id,
+    ref,
+    product,
+    sku,
+    attributes,
+    manufacturerOrigin,
+    stock,
+    images,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VariantManufacturerOrigin.md

@@ -0,0 +1,23 @@
+# VariantManufacturerOrigin
+
+Where the product was originally produced or manufactured
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country** | **string** | Country of origin (ISO 3166-1 alpha-2). | [optional] [default to undefined]
+**name** | **string** | Name of the country of origin | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantManufacturerOrigin } from '@teemill/gfn-catalog';
+
+const instance: VariantManufacturerOrigin = {
+    country,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VariantProduct.md

@@ -0,0 +1,22 @@
+# VariantProduct
+
+
+## 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]
+
+## Example
+
+```typescript
+import { VariantProduct } from '@teemill/gfn-catalog';
+
+const instance: VariantProduct = {
+    id,
+    ref,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VariantStock.md

@@ -0,0 +1,26 @@
+# VariantStock
+
+
+## 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]
+**productRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+**stock** | [**Stock**](Stock.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantStock } from '@teemill/gfn-catalog';
+
+const instance: VariantStock = {
+    id,
+    ref,
+    productRef,
+    stock,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VariantsApi.md

@@ -0,0 +1,268 @@
+# VariantsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getStock**](#getstock) | **GET** /v1/gfn/catalog/stock/{variantId} | Get GFN variant stock|
+|[**getVariant**](#getvariant) | **GET** /v1/gfn/catalog/variants/{variantId} | Get a GFN variant|
+|[**listStock**](#liststock) | **GET** /v1/gfn/catalog/stock | List GFN variant stock|
+|[**listVariants**](#listvariants) | **GET** /v1/gfn/catalog/variants | List GFN variants|
+
+# **getStock**
+> VariantStock getStock()
+
+Gets the stock level for the GFN variant with the given ID.
+
+### Example
+
+```typescript
+import {
+    VariantsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new VariantsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let variantId: string; //Variants unique identifier (default to undefined)
+let fulfillmentProjects: string; //Fetch stock levels from specific fulfiller projects (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getStock(
+    project,
+    variantId,
+    fulfillmentProjects
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **variantId** | [**string**] | Variants unique identifier | defaults to undefined|
+| **fulfillmentProjects** | [**string**] | Fetch stock levels from specific fulfiller projects | (optional) defaults to undefined|
+
+
+### Return type
+
+**VariantStock**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a GFN variant stock level. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getVariant**
+> Variant getVariant()
+
+Gets a GFN variant by the given ID.
+
+### Example
+
+```typescript
+import {
+    VariantsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new VariantsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let variantId: string; //Variants unique identifier (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.getVariant(
+    project,
+    variantId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **variantId** | [**string**] | Variants unique identifier | defaults to undefined|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+
+
+### Return type
+
+**Variant**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a GFN variant. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listStock**
+> StockResponse listStock()
+
+Lists the stock levels for all GFN variants available to the project.
+
+### Example
+
+```typescript
+import {
+    VariantsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new VariantsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let fulfillmentProjects: string; //Fetch stock levels from specific fulfiller projects (optional) (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 search: string; //Search terms to filter based on. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listStock(
+    project,
+    fulfillmentProjects,
+    pageToken,
+    pageSize,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **fulfillmentProjects** | [**string**] | Fetch stock levels from specific fulfiller projects | (optional) 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|
+| **search** | [**string**] | Search terms to filter based on. | (optional) defaults to undefined|
+
+
+### Return type
+
+**StockResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all GFN variant stock levels. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listVariants**
+> VariantsResponse listVariants()
+
+Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
+
+### Example
+
+```typescript
+import {
+    VariantsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new VariantsApi(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 fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
+let search: string; //Search terms to filter based on. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listVariants(
+    project,
+    pageToken,
+    pageSize,
+    fields,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+| **search** | [**string**] | Search terms to filter based on. | (optional) defaults to undefined|
+
+
+### Return type
+
+**VariantsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all GFN variants. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/VariantsResponse.md

@@ -0,0 +1,22 @@
+# VariantsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variants** | [**Array<Variant>**](Variant.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantsResponse } from '@teemill/gfn-catalog';
+
+const instance: VariantsResponse = {
+    variants,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

@@ -4,7 +4,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  * 
  *
  * 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.5.0",
+  "version": "3.6.1",
   "description": "OpenAPI client for @teemill/gfn-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {