@teemill/inserts 0.2.1 → 0.3.0

package/docs/InsertsApi.md

@@ -0,0 +1,256 @@
+# InsertsApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createInsert**](#createinsert) | **POST** /v1/inserts | Create an insert|
+|[**getInsert**](#getinsert) | **GET** /v1/inserts/{insertId} | Retrieve an insert for a project|
+|[**listInserts**](#listinserts) | **GET** /v1/inserts | List project inserts|
+|[**updateInsert**](#updateinsert) | **PATCH** /v1/inserts/{insertId} | Update an insert|
+
+# **createInsert**
+> Insert createInsert(createInsertRequest)
+
+Create an insert for a project
+
+### Example
+
+```typescript
+import {
+    InsertsApi,
+    Configuration,
+    CreateInsertRequest
+} from '@teemill/inserts';
+
+const configuration = new Configuration();
+const apiInstance = new InsertsApi(configuration);
+
+let project: string; // (default to undefined)
+let createInsertRequest: CreateInsertRequest; //Create an insert
+
+const { status, data } = await apiInstance.createInsert(
+    project,
+    createInsertRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createInsertRequest** | **CreateInsertRequest**| Create an insert | |
+| **project** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Insert**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successfully retrieved an insert |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorise |  -  |
+|**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)
+
+# **getInsert**
+> Insert getInsert()
+
+Retrieve details for a specific insert for a project
+
+### Example
+
+```typescript
+import {
+    InsertsApi,
+    Configuration
+} from '@teemill/inserts';
+
+const configuration = new Configuration();
+const apiInstance = new InsertsApi(configuration);
+
+let insertId: string; //Filter by insert ID (default to undefined)
+let project: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getInsert(
+    insertId,
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **insertId** | [**string**] | Filter by insert ID | defaults to undefined|
+| **project** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Insert**
+
+### 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 an insert |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorise |  -  |
+|**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)
+
+# **listInserts**
+> ListInserts200Response listInserts()
+
+List your project inserts
+
+### Example
+
+```typescript
+import {
+    InsertsApi,
+    Configuration
+} from '@teemill/inserts';
+
+const configuration = new Configuration();
+const apiInstance = new InsertsApi(configuration);
+
+let project: string; // (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 for inserts by id or name (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listInserts(
+    project,
+    pageToken,
+    pageSize,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] |  | 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 for inserts by id or name | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListInserts200Response**
+
+### 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 list of inserts |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorise |  -  |
+|**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)
+
+# **updateInsert**
+> Insert updateInsert(updateInsertRequest)
+
+Update an insert for a project
+
+### Example
+
+```typescript
+import {
+    InsertsApi,
+    Configuration,
+    UpdateInsertRequest
+} from '@teemill/inserts';
+
+const configuration = new Configuration();
+const apiInstance = new InsertsApi(configuration);
+
+let insertId: string; //Filter by insert ID (default to undefined)
+let project: string; // (default to undefined)
+let updateInsertRequest: UpdateInsertRequest; //Update an insert
+
+const { status, data } = await apiInstance.updateInsert(
+    insertId,
+    project,
+    updateInsertRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateInsertRequest** | **UpdateInsertRequest**| Update an insert | |
+| **insertId** | [**string**] | Filter by insert ID | defaults to undefined|
+| **project** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Insert**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved an insert |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorise |  -  |
+|**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)
+

package/docs/InsertsTypesApi.md

@@ -0,0 +1,132 @@
+# InsertsTypesApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getInsertType**](#getinserttype) | **GET** /v1/inserts/types/{insertTypeId} | Retrieve an insert type|
+|[**listInsertTypes**](#listinserttypes) | **GET** /v1/inserts/types | List insert types|
+
+# **getInsertType**
+> InsertType getInsertType()
+
+Retrieve details for a specific insert type
+
+### Example
+
+```typescript
+import {
+    InsertsTypesApi,
+    Configuration
+} from '@teemill/inserts';
+
+const configuration = new Configuration();
+const apiInstance = new InsertsTypesApi(configuration);
+
+let insertTypeId: string; //Filter by insert type ID (default to undefined)
+let project: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getInsertType(
+    insertTypeId,
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **insertTypeId** | [**string**] | Filter by insert type ID | defaults to undefined|
+| **project** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**InsertType**
+
+### 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 an insert type |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorise |  -  |
+|**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)
+
+# **listInsertTypes**
+> ListInsertTypes200Response listInsertTypes()
+
+List all insert types
+
+### Example
+
+```typescript
+import {
+    InsertsTypesApi,
+    Configuration
+} from '@teemill/inserts';
+
+const configuration = new Configuration();
+const apiInstance = new InsertsTypesApi(configuration);
+
+let project: string; // (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 for inserts by id or name (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listInsertTypes(
+    project,
+    pageToken,
+    pageSize,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] |  | 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 for inserts by id or name | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListInsertTypes200Response**
+
+### 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 list of insert types |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorise |  -  |
+|**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/ListInsertTypes200Response.md

@@ -0,0 +1,22 @@
+# ListInsertTypes200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**insertTypes** | [**Array<InsertType>**](InsertType.md) |  | [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [default to undefined]
+
+## Example
+
+```typescript
+import { ListInsertTypes200Response } from '@teemill/inserts';
+
+const instance: ListInsertTypes200Response = {
+    insertTypes,
+    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/ListInserts200Response.md

@@ -0,0 +1,22 @@
+# ListInserts200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inserts** | [**Array<Insert>**](Insert.md) |  | [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [default to undefined]
+
+## Example
+
+```typescript
+import { ListInserts200Response } from '@teemill/inserts';
+
+const instance: ListInserts200Response = {
+    inserts,
+    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/UpdateInsertRequest.md

@@ -0,0 +1,26 @@
+# UpdateInsertRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** | Whether the insert is enabled | [optional] [default to undefined]
+**variantRef** | **string** | A reference to the variant that will be inserted into the order when this insert rule is triggered | [optional] [default to undefined]
+**typeRef** | **string** | A reference to the insert type that will be inserted into the order when this insert rule is triggered | [optional] [default to undefined]
+**config** | [**UpdateInsertRequestConfig**](UpdateInsertRequestConfig.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateInsertRequest } from '@teemill/inserts';
+
+const instance: UpdateInsertRequest = {
+    enabled,
+    variantRef,
+    typeRef,
+    config,
+};
+```
+
+[[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/UpdateInsertRequestConfig.md

@@ -0,0 +1,20 @@
+# UpdateInsertRequestConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coupon** | [**UpdateInsertRequestConfigCoupon**](UpdateInsertRequestConfigCoupon.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateInsertRequestConfig } from '@teemill/inserts';
+
+const instance: UpdateInsertRequestConfig = {
+    coupon,
+};
+```
+
+[[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/UpdateInsertRequestConfigCoupon.md

@@ -0,0 +1,28 @@
+# UpdateInsertRequestConfigCoupon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **string** | The prefix of the coupon code to apply to the insert | [default to undefined]
+**type** | **string** | The type of coupon to apply to the insert | [default to undefined]
+**value** | **number** | The value of the coupon to apply to the insert | [default to undefined]
+**minimumOrderValue** | **number** | The minimum order value to apply the coupon to | [default to undefined]
+**description** | **string** | The description of the coupon to apply to the insert | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateInsertRequestConfigCoupon } from '@teemill/inserts';
+
+const instance: UpdateInsertRequestConfigCoupon = {
+    prefix,
+    type,
+    value,
+    minimumOrderValue,
+    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)

package/index.ts

@@ -4,7 +4,7 @@
  * Inserts API
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
  *
- * The version of the OpenAPI document: 0.2.1
+ * The version of the OpenAPI document: 0.3.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/inserts",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "OpenAPI client for @teemill/inserts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {