@handsondigital/idplugger-promotion 1.0.0

package/docs/OrdersUpdate401Response.md

@@ -0,0 +1,26 @@
+# OrdersUpdate401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersUpdate401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: OrdersUpdate401Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/Pagination.md

@@ -0,0 +1,42 @@
+# Pagination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **number** |  | [optional] [default to undefined]
+**first_page_url** | **string** |  | [optional] [default to undefined]
+**from** | **number** |  | [optional] [default to undefined]
+**last_page** | **number** |  | [optional] [default to undefined]
+**last_page_url** | **string** |  | [optional] [default to undefined]
+**links** | [**Array<PaginationLinksInner>**](PaginationLinksInner.md) |  | [optional] [default to undefined]
+**next_page_url** | **string** |  | [optional] [default to undefined]
+**path** | **string** |  | [optional] [default to undefined]
+**per_page** | **string** |  | [optional] [default to undefined]
+**prev_page_url** | **string** |  | [optional] [default to undefined]
+**to** | **number** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Pagination } from '@handsondigital/idplugger-promotion';
+
+const instance: Pagination = {
+    current_page,
+    first_page_url,
+    from,
+    last_page,
+    last_page_url,
+    links,
+    next_page_url,
+    path,
+    per_page,
+    prev_page_url,
+    to,
+    total,
+};
+```
+
+[[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/PaginationLinksInner.md

@@ -0,0 +1,24 @@
+# PaginationLinksInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**active** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationLinksInner } from '@handsondigital/idplugger-promotion';
+
+const instance: PaginationLinksInner = {
+    url,
+    label,
+    active,
+};
+```
+
+[[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/Product.md

@@ -0,0 +1,32 @@
+# Product
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Id do produto | [optional] [default to undefined]
+**serial_number** | **string** | Número serial do produto | [optional] [default to undefined]
+**name** | **string** | Nome do produto | [optional] [default to undefined]
+**lucky_numbers_offer** | **number** | Quantidade de números da sorte oferecidos pelo produto | [optional] [default to undefined]
+**lucky_numbers_multiplier** | **number** | Quantidade de vezes que o produto multiplica o total de números da sorte do cupom | [optional] [default to undefined]
+**status** | **boolean** | Produto ativo ou inativo | [optional] [default to undefined]
+**imagem** | **string** | URL da imagem do produto | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Product } from '@handsondigital/idplugger-promotion';
+
+const instance: Product = {
+    id,
+    serial_number,
+    name,
+    lucky_numbers_offer,
+    lucky_numbers_multiplier,
+    status,
+    imagem,
+};
+```
+
+[[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,242 @@
+# ProductsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**productsCreate**](#productscreate) | **POST** /v3/promotion/{promotion_id}/products | Cadastra um produto na promoção|
+|[**productsDelete**](#productsdelete) | **DELETE** /v3/promotion/{promotion_id}/products/{product_id} | Exclui um produto cadastrado na promoção|
+|[**productsIndex**](#productsindex) | **GET** /v3/promotion/{promotion_id}/products | Busca por produtos cadastrados na promoção|
+|[**productsUpdate**](#productsupdate) | **PATCH** /v3/promotion/{promotion_id}/products | Cadastra ou atualiza produtos na promoção|
+
+# **productsCreate**
+> ProductsCreate200Response productsCreate()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    ProductsCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let productsCreateRequest: ProductsCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.productsCreate(
+    promotionId,
+    productsCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **productsCreateRequest** | **ProductsCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ProductsCreate200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**401** | unauthorized |  -  |
+|**409** | failed |  -  |
+
+[[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)
+
+# **productsDelete**
+> ProductsDelete200Response productsDelete()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let productId: string; //ID do produto (default to undefined)
+
+const { status, data } = await apiInstance.productsDelete(
+    promotionId,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **productId** | [**string**] | ID do produto | defaults to undefined|
+
+
+### Return type
+
+**ProductsDelete200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**400** | failed |  -  |
+|**401** | unauthorized |  -  |
+
+[[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)
+
+# **productsIndex**
+> ProductsIndex200Response productsIndex()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let include: string; //Associações a serem retornadas (optional) (default to undefined)
+let id: string; //Id do produto (optional) (default to undefined)
+let serialNumber: string; //Número serial do produto (optional) (default to undefined)
+
+const { status, data } = await apiInstance.productsIndex(
+    promotionId,
+    fields,
+    include,
+    id,
+    serialNumber
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **include** | [**string**] | Associações a serem retornadas | (optional) defaults to undefined|
+| **id** | [**string**] | Id do produto | (optional) defaults to undefined|
+| **serialNumber** | [**string**] | Número serial do produto | (optional) defaults to undefined|
+
+
+### Return type
+
+**ProductsIndex200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**400** | failed |  -  |
+|**401** | unauthorized |  -  |
+
+[[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)
+
+# **productsUpdate**
+> ProductsUpdate201Response productsUpdate()
+
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    ProductsCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let productsCreateRequest: ProductsCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.productsUpdate(
+    promotionId,
+    productsCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **productsCreateRequest** | **ProductsCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ProductsUpdate201Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | success |  -  |
+|**401** | unauthorized |  -  |
+|**409** | failed |  -  |
+
+[[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/ProductsCreate200Response.md

@@ -0,0 +1,26 @@
+# ProductsCreate200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**content** | [**Array<Product>**](Product.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsCreate200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsCreate200Response = {
+    entity,
+    action,
+    result,
+    content,
+};
+```
+
+[[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/ProductsCreate401Response.md

@@ -0,0 +1,26 @@
+# ProductsCreate401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsCreate401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsCreate401Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ProductsCreate409Response.md

@@ -0,0 +1,26 @@
+# ProductsCreate409Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsCreate409Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsCreate409Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ProductsCreateRequest.md

@@ -0,0 +1,20 @@
+# ProductsCreateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**Array<Product>**](Product.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsCreateRequest } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsCreateRequest = {
+    products,
+};
+```
+
+[[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/ProductsDelete200Response.md

@@ -0,0 +1,26 @@
+# ProductsDelete200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**content** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsDelete200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsDelete200Response = {
+    entity,
+    action,
+    result,
+    content,
+};
+```
+
+[[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/ProductsDelete400Response.md

@@ -0,0 +1,26 @@
+# ProductsDelete400Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsDelete400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsDelete400Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ProductsDelete401Response.md

@@ -0,0 +1,26 @@
+# ProductsDelete401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsDelete401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsDelete401Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ProductsIndex200Response.md

@@ -0,0 +1,28 @@
+# ProductsIndex200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**paging** | [**Array<Pagination>**](Pagination.md) |  | [optional] [default to undefined]
+**content** | [**Array<Product>**](Product.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsIndex200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsIndex200Response = {
+    entity,
+    action,
+    result,
+    paging,
+    content,
+};
+```
+
+[[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/ProductsIndex400Response.md

@@ -0,0 +1,26 @@
+# ProductsIndex400Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsIndex400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsIndex400Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ProductsIndex401Response.md

@@ -0,0 +1,26 @@
+# ProductsIndex401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsIndex401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsIndex401Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[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/ProductsUpdate201Response.md

@@ -0,0 +1,26 @@
+# ProductsUpdate201Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**content** | [**ProductsCreateRequest**](ProductsCreateRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsUpdate201Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsUpdate201Response = {
+    entity,
+    action,
+    result,
+    content,
+};
+```
+
+[[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/ProductsUpdate401Response.md

@@ -0,0 +1,26 @@
+# ProductsUpdate401Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductsUpdate401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ProductsUpdate401Response = {
+    entity,
+    action,
+    result,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)