@handsondigital/idplugger-promotion 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Plataforma de Promoção - Documentação da API
+ *   # Introdução  Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma.  # Sobre a API  Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas.  Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais.  # Começando  Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos:  1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API.  2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades.  3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento.  4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades.  # Autenticação  Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção.  Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato:  | Header | Valor |   | - | - |   | Authorization | bearer `{token}` |  Substitua `{token}` pelo token obtido na autenticação.  IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação.  # Webhooks  Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API.  Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>.  # Ambiente de testes  Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção.  Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico.  Vamos começar a promover o sucesso juntos!  # Postman Collection  [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
+ *
+ * The version of the OpenAPI document: 3.3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Plataforma de Promoção - Documentação da API
+ *   # Introdução  Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma.  # Sobre a API  Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas.  Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais.  # Começando  Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos:  1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API.  2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades.  3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento.  4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades.  # Autenticação  Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção.  Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato:  | Header | Valor |   | - | - |   | Authorization | bearer `{token}` |  Substitua `{token}` pelo token obtido na autenticação.  IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação.  # Webhooks  Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API.  Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>.  # Ambiente de testes  Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção.  Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico.  Vamos começar a promover o sucesso juntos!  # Postman Collection  [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
+ *
+ * The version of the OpenAPI document: 3.3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api"), exports);
+__exportStar(require("./configuration"), exports);

package/docs/AddLuckyNumberCustom.md

@@ -0,0 +1,26 @@
+# AddLuckyNumberCustom
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lucky_numbers** | **Array<number>** |  | [default to undefined]
+**serie** | **number** |  | [optional] [default to undefined]
+**valid_from** | **string** |  | [optional] [default to undefined]
+**valid_until** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddLuckyNumberCustom } from '@handsondigital/idplugger-promotion';
+
+const instance: AddLuckyNumberCustom = {
+    lucky_numbers,
+    serie,
+    valid_from,
+    valid_until,
+};
+```
+
+[[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/Article.md

@@ -0,0 +1,40 @@
+# Article
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Identificador único da publicação na promoção | [optional] [default to undefined]
+**author_id** | **number** | Identificador do usuário da promoção autor da publicação | [optional] [default to undefined]
+**title** | **string** | Título da publicação | [default to undefined]
+**guid** | **string** | Identificador global da publicação (será usado na url da publicação) | [optional] [default to undefined]
+**content** | **string** | Conteúdo da publicação | [optional] [default to undefined]
+**description** | **string** | Resumo da publicação | [optional] [default to undefined]
+**status** | **string** | Status da publicação. Opções: publish,future,draft,pending,private | [optional] [default to undefined]
+**date** | **string** | Data em que a publicação será publicada | [optional] [default to undefined]
+**custom_data** | [**Array<ArticleCustomDataInner>**](ArticleCustomDataInner.md) |  | [optional] [default to undefined]
+**created_at** | **string** | Data em que a publicação foi criada | [optional] [default to undefined]
+**updated_at** | **string** | Data em que a publicação foi atualizada | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Article } from '@handsondigital/idplugger-promotion';
+
+const instance: Article = {
+    id,
+    author_id,
+    title,
+    guid,
+    content,
+    description,
+    status,
+    date,
+    custom_data,
+    created_at,
+    updated_at,
+};
+```
+
+[[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/ArticleCustomDataInner.md

@@ -0,0 +1,28 @@
+# ArticleCustomDataInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to 'string']
+**group** | **string** |  | [optional] [default to undefined]
+**details** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArticleCustomDataInner } from '@handsondigital/idplugger-promotion';
+
+const instance: ArticleCustomDataInner = {
+    key,
+    value,
+    type,
+    group,
+    details,
+};
+```
+
+[[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/ArticlesApi.md

@@ -0,0 +1,258 @@
+# ArticlesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**articlesCreate**](#articlescreate) | **POST** /v3/promotion/{promotion_id}/cms/articles | Cadastra publicações na promoção|
+|[**articlesDelete**](#articlesdelete) | **DELETE** /v3/promotion/{promotion_id}/cms/articles/{id} | Exclui uma publicação da promoção|
+|[**articlesIndex**](#articlesindex) | **GET** /v3/promotion/{promotion_id}/cms/articles | Lista as publicações cadastradas na promoção|
+|[**articlesUpdate**](#articlesupdate) | **PATCH** /v3/promotion/{promotion_id}/cms/articles | Cadastra ou atualiza publicações na promoção|
+
+# **articlesCreate**
+> ArticlesCreate200Response articlesCreate()
+
+
+### Example
+
+```typescript
+import {
+    ArticlesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ArticlesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let article: Array<Article>; // (optional)
+
+const { status, data } = await apiInstance.articlesCreate(
+    promotionId,
+    article
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **article** | **Array<Article>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ArticlesCreate200Response**
+
+### 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)
+
+# **articlesDelete**
+> ArticlesDelete200Response articlesDelete()
+
+
+### Example
+
+```typescript
+import {
+    ArticlesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ArticlesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: string; //ID da publicação (default to undefined)
+
+const { status, data } = await apiInstance.articlesDelete(
+    promotionId,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**string**] | ID da publicação | defaults to undefined|
+
+
+### Return type
+
+**ArticlesDelete200Response**
+
+### 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)
+
+# **articlesIndex**
+> ArticlesIndex200Response articlesIndex()
+
+
+### Example
+
+```typescript
+import {
+    ArticlesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ArticlesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Informa quais campos devem ser retornados na pesquisa pela API (optional) (default to undefined)
+let include: string; //Informa se os dados do autor da publicação também deve ser retornado na pesquisa pela API (optional) (default to undefined)
+let page: number; //Informa o número da página da pesquisa (optional) (default to undefined)
+let perPage: number; //Informa o número de publicações por página na pesquisa (optional) (default to undefined)
+let id: string; //Pesquisa publicações cadastradas na promoção pelo id das mesmas (optional) (default to undefined)
+let title: string; //Pesquisa publicações cadastradas na promoção com título que contenha o texto pesquisado (optional) (default to undefined)
+let keyword: string; //Pesquisa publicações cadastradas na promoção com texto que contenha o texto pesquisado (optional) (default to undefined)
+let date: string; //Pesquisa publicações cadastradas na promoção com data de publicação entre as datas informadas (optional) (default to undefined)
+let createdAt: string; //Pesquisa publicações cadastradas na promoção entre as datas informadas (optional) (default to undefined)
+let updatedAt: string; //Pesquisa publicações cadastradas na promoção atualizadas entre as datas informadas (optional) (default to undefined)
+
+const { status, data } = await apiInstance.articlesIndex(
+    promotionId,
+    fields,
+    include,
+    page,
+    perPage,
+    id,
+    title,
+    keyword,
+    date,
+    createdAt,
+    updatedAt
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Informa quais campos devem ser retornados na pesquisa pela API | (optional) defaults to undefined|
+| **include** | [**string**] | Informa se os dados do autor da publicação também deve ser retornado na pesquisa pela API | (optional) defaults to undefined|
+| **page** | [**number**] | Informa o número da página da pesquisa | (optional) defaults to undefined|
+| **perPage** | [**number**] | Informa o número de publicações por página na pesquisa | (optional) defaults to undefined|
+| **id** | [**string**] | Pesquisa publicações cadastradas na promoção pelo id das mesmas | (optional) defaults to undefined|
+| **title** | [**string**] | Pesquisa publicações cadastradas na promoção com título que contenha o texto pesquisado | (optional) defaults to undefined|
+| **keyword** | [**string**] | Pesquisa publicações cadastradas na promoção com texto que contenha o texto pesquisado | (optional) defaults to undefined|
+| **date** | [**string**] | Pesquisa publicações cadastradas na promoção com data de publicação entre as datas informadas | (optional) defaults to undefined|
+| **createdAt** | [**string**] | Pesquisa publicações cadastradas na promoção entre as datas informadas | (optional) defaults to undefined|
+| **updatedAt** | [**string**] | Pesquisa publicações cadastradas na promoção atualizadas entre as datas informadas | (optional) defaults to undefined|
+
+
+### Return type
+
+**ArticlesIndex200Response**
+
+### 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)
+
+# **articlesUpdate**
+> ArticlesUpdate200Response articlesUpdate()
+
+
+### Example
+
+```typescript
+import {
+    ArticlesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new ArticlesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let article: Array<Article>; // (optional)
+
+const { status, data } = await apiInstance.articlesUpdate(
+    promotionId,
+    article
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **article** | **Array<Article>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ArticlesUpdate200Response**
+
+### 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)
+

package/docs/ArticlesCreate200Response.md

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

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

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

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

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

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

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

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

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