@handsondigital/idplugger-promotion 1.0.0

package/docs/BrandingUpdate200Response.md

@@ -0,0 +1,26 @@
+# BrandingUpdate200Response
+
+
+## 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 { BrandingUpdate200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: BrandingUpdate200Response = {
+    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/BrandingUpdate400Response.md

@@ -0,0 +1,26 @@
+# BrandingUpdate400Response
+
+
+## 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 { BrandingUpdate400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: BrandingUpdate400Response = {
+    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/BrandingUpdate401Response.md

@@ -0,0 +1,26 @@
+# BrandingUpdate401Response
+
+
+## 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 { BrandingUpdate401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: BrandingUpdate401Response = {
+    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/ConfigWebhook200Response.md

@@ -0,0 +1,26 @@
+# ConfigWebhook200Response
+
+
+## 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 { ConfigWebhook200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ConfigWebhook200Response = {
+    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/ConfigWebhook400Response.md

@@ -0,0 +1,26 @@
+# ConfigWebhook400Response
+
+
+## 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 { ConfigWebhook400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ConfigWebhook400Response = {
+    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/ConfigWebhook401Response.md

@@ -0,0 +1,26 @@
+# ConfigWebhook401Response
+
+
+## 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 { ConfigWebhook401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ConfigWebhook401Response = {
+    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/ConfigWebhookRequest.md

@@ -0,0 +1,22 @@
+# ConfigWebhookRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [optional] [default to undefined]
+**secret** | **string** | O parâmetro secret será enviado para o seu webhook via **authorization: `secret`**. Por tanto, seu app deve validar se o secret é válido. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConfigWebhookRequest } from '@handsondigital/idplugger-promotion';
+
+const instance: ConfigWebhookRequest = {
+    url,
+    secret,
+};
+```
+
+[[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/ConfigsIndex200Response.md

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

@@ -0,0 +1,26 @@
+# ConfigsIndex400Response
+
+
+## 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 { ConfigsIndex400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ConfigsIndex400Response = {
+    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/ConfigsIndex401Response.md

@@ -0,0 +1,26 @@
+# ConfigsIndex401Response
+
+
+## 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 { ConfigsIndex401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ConfigsIndex401Response = {
+    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/Content.md

@@ -0,0 +1,28 @@
+# Content
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Chave que identifica o conteúdo (em caso de conteúdo sem grupo, a chave pode ser uma tag) | [optional] [default to '{uuid}']
+**value** | **string** | Conteúdo (o formato depende do uso, é recomendado json) | [optional] [default to undefined]
+**order** | **number** | Ordem de apresentação, começando em 1 | [optional] [default to undefined]
+**type** | **string** | Tipo do dado armazenado | [optional] [default to TypeEnum_Text]
+**group** | **string** | Grupo ao qual o conteúdo faz parte | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Content } from '@handsondigital/idplugger-promotion';
+
+const instance: Content = {
+    key,
+    value,
+    order,
+    type,
+    group,
+};
+```
+
+[[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/ContentApi.md

@@ -0,0 +1,129 @@
+# ContentApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**contentCreate**](#contentcreate) | **POST** /v3/promotion/{promotion_id}/cms/content | Cria um novo conteúdo para a promoção|
+|[**contentIndex**](#contentindex) | **GET** /v3/promotion/{promotion_id}/cms/content | Dados referentes aos conteúdos (que não são artigos de blog) da promoção|
+
+# **contentCreate**
+> ContentCreate200Response contentCreate()
+
+
+### Example
+
+```typescript
+import {
+    ContentApi,
+    Configuration,
+    Content
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ContentApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let content: Content; // (optional)
+
+const { status, data } = await apiInstance.contentCreate(
+    promotionId,
+    content
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **content** | **Content**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ContentCreate200Response**
+
+### 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 |  -  |
+|**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)
+
+# **contentIndex**
+> ContentIndex200Response contentIndex()
+
+
+### Example
+
+```typescript
+import {
+    ContentApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ContentApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados pela API (optional) (default to undefined)
+let key: string; //Pesquisa pela chave principal do conteúdo (optional) (default to undefined)
+let group: string; //Pesquisa pela chave do grupo do conteúdo (optional) (default to undefined)
+let type: string; //Pesquisa pelo tipo do conteúdo (optional) (default to undefined)
+
+const { status, data } = await apiInstance.contentIndex(
+    promotionId,
+    fields,
+    key,
+    group,
+    type
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados pela API | (optional) defaults to undefined|
+| **key** | [**string**] | Pesquisa pela chave principal do conteúdo | (optional) defaults to undefined|
+| **group** | [**string**] | Pesquisa pela chave do grupo do conteúdo | (optional) defaults to undefined|
+| **type** | [**string**] | Pesquisa pelo tipo do conteúdo | (optional) defaults to undefined|
+
+
+### Return type
+
+**ContentIndex200Response**
+
+### 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)
+

package/docs/ContentCreate200Response.md

@@ -0,0 +1,26 @@
+# ContentCreate200Response
+
+
+## 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 { ContentCreate200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ContentCreate200Response = {
+    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/ContentCreate400Response.md

@@ -0,0 +1,26 @@
+# ContentCreate400Response
+
+
+## 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 { ContentCreate400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ContentCreate400Response = {
+    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/ContentCreate401Response.md

@@ -0,0 +1,26 @@
+# ContentCreate401Response
+
+
+## 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 { ContentCreate401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ContentCreate401Response = {
+    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/ContentIndex200Response.md

@@ -0,0 +1,26 @@
+# ContentIndex200Response
+
+
+## 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<Content>**](Content.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContentIndex200Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ContentIndex200Response = {
+    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/ContentIndex400Response.md

@@ -0,0 +1,26 @@
+# ContentIndex400Response
+
+
+## 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 { ContentIndex400Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ContentIndex400Response = {
+    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/ContentIndex401Response.md

@@ -0,0 +1,26 @@
+# ContentIndex401Response
+
+
+## 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 { ContentIndex401Response } from '@handsondigital/idplugger-promotion';
+
+const instance: ContentIndex401Response = {
+    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/Coupon.md

@@ -0,0 +1,36 @@
+# Coupon
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**user_id** | **number** |  | [default to undefined]
+**purchase_date** | **string** |  | [default to undefined]
+**cnpj** | **string** |  | [default to undefined]
+**code** | **string** |  | [default to undefined]
+**cost** | **number** |  | [default to undefined]
+**serie** | **number** |  | [optional] [default to undefined]
+**products** | [**Array<CouponProductsInner>**](CouponProductsInner.md) |  | [optional] [default to undefined]
+**promotion_codes** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Coupon } from '@handsondigital/idplugger-promotion';
+
+const instance: Coupon = {
+    id,
+    user_id,
+    purchase_date,
+    cnpj,
+    code,
+    cost,
+    serie,
+    products,
+    promotion_codes,
+};
+```
+
+[[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/CouponProductsInner.md

@@ -0,0 +1,26 @@
+# CouponProductsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Obrigatório se não enviado o serial_number | [optional] [default to undefined]
+**serial_number** | **string** | Obrigatório se não enviado o id | [optional] [default to undefined]
+**quantity** | **number** | Quantidade deste produto no cupom (envio obrigatório) | [optional] [default to undefined]
+**cost** | **number** | Valor do produto no cupom (envio obrigatório) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CouponProductsInner } from '@handsondigital/idplugger-promotion';
+
+const instance: CouponProductsInner = {
+    id,
+    serial_number,
+    quantity,
+    cost,
+};
+```
+
+[[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/CouponWebhookError.md

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