@teemill/gfn-catalog 3.5.0 → 3.6.1

package/docs/ProductAttributeValuesInner.md

@@ -0,0 +1,22 @@
+# ProductAttributeValuesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sortOrder** | **number** | Position of the attribute value when ordered | [default to undefined]
+**value** | **string** | Value of the attribute | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAttributeValuesInner } from '@teemill/gfn-catalog';
+
+const instance: ProductAttributeValuesInner = {
+    sortOrder,
+    value,
+};
+```
+
+[[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/ProductBrand.md

@@ -0,0 +1,22 @@
+# ProductBrand
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | the name of the brand that manufactures/supplies the product | [default to undefined]
+**logo** | **string** | a URL to the brand\'s logo | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductBrand } from '@teemill/gfn-catalog';
+
+const instance: ProductBrand = {
+    name,
+    logo,
+};
+```
+
+[[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/ProductImagesInner.md

@@ -0,0 +1,26 @@
+# ProductImagesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**src** | **string** |  | [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductImagesInner } from '@teemill/gfn-catalog';
+
+const instance: ProductImagesInner = {
+    id,
+    src,
+    alt,
+    sortOrder,
+};
+```
+
+[[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/ProductVariantsInner.md

@@ -0,0 +1,22 @@
+# ProductVariantsInner
+
+
+## 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]
+
+## Example
+
+```typescript
+import { ProductVariantsInner } from '@teemill/gfn-catalog';
+
+const instance: ProductVariantsInner = {
+    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/ProductsApi.md

@@ -0,0 +1,138 @@
+# ProductsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getProduct**](#getproduct) | **GET** /v1/gfn/catalog/products/{productId} | Get a GFN product|
+|[**listProducts**](#listproducts) | **GET** /v1/gfn/catalog/products | List GFN products|
+
+# **getProduct**
+> Product getProduct()
+
+Gets a GFN product by the given ID.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+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 fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getProduct(
+    project,
+    productId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] |  | defaults to undefined|
+| **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+
+
+### Return type
+
+**Product**
+
+### 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 single GFN product |  -  |
+|**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)
+
+# **listProducts**
+> ProductsResponse listProducts()
+
+Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(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 50)
+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.listProducts(
+    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 50|
+| **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
+
+**ProductsResponse**
+
+### 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 products. |  -  |
+|**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/ProductsResponse.md

@@ -0,0 +1,22 @@
+# ProductsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**Array<Product>**](Product.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsResponse } from '@teemill/gfn-catalog';
+
+const instance: ProductsResponse = {
+    products,
+    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/docs/Statement.md

@@ -0,0 +1,34 @@
+# Statement
+
+
+## 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]
+
+## Example
+
+```typescript
+import { Statement } from '@teemill/gfn-catalog';
+
+const instance: Statement = {
+    id,
+    ref,
+    total,
+    startDate,
+    endDate,
+    createdAt,
+    fulfillmentCount,
+    issuedAt,
+};
+```
+
+[[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/StatementsApi.md

@@ -0,0 +1,132 @@
+# StatementsApi
+
+All URIs are relative to *https://api.podos.io*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getStatement**](#getstatement) | **GET** /v1/gfn/statements/{statementId} | Get a GFN statement|
+|[**listStatements**](#liststatements) | **GET** /v1/gfn/statements | List GFN statements|
+
+# **getStatement**
+> Statement getStatement()
+
+Gets a GFN statement by the given ID.
+
+### Example
+
+```typescript
+import {
+    StatementsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+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)
+
+const { status, data } = await apiInstance.getStatement(
+    project,
+    statementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **statementId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Statement**
+
+### 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 statement. |  -  |
+|**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)
+
+# **listStatements**
+> InlineObject listStatements()
+
+Lists GFN statements available to the project
+
+### Example
+
+```typescript
+import {
+    StatementsApi,
+    Configuration
+} from '@teemill/gfn-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new StatementsApi(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 search: string; //Search term used to filter results by (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listStatements(
+    project,
+    pageToken,
+    pageSize,
+    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|
+| **search** | [**string**] | Search term used to filter results by | (optional) defaults to undefined|
+
+
+### Return type
+
+**InlineObject**
+
+### 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 statements. |  -  |
+|**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/Stock.md

@@ -0,0 +1,22 @@
+# Stock
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **number** | Current stock level | [optional] [default to undefined]
+**locations** | [**Array<Location>**](Location.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Stock } from '@teemill/gfn-catalog';
+
+const instance: Stock = {
+    level,
+    locations,
+};
+```
+
+[[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/StockResponse.md

@@ -0,0 +1,22 @@
+# StockResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variants** | [**Array<VariantStock>**](VariantStock.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockResponse } from '@teemill/gfn-catalog';
+
+const instance: StockResponse = {
+    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/docs/Transaction.md

@@ -0,0 +1,38 @@
+# Transaction
+
+
+## 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]
+**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]
+
+## Example
+
+```typescript
+import { Transaction } from '@teemill/gfn-catalog';
+
+const instance: Transaction = {
+    id,
+    ref,
+    statement,
+    cost,
+    type,
+    taxable,
+    createdAt,
+    fulfillmentId,
+    orderId,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)