@handsondigital/idplugger-promotion 1.0.0

package/docs/FAQApi.md

@@ -0,0 +1,236 @@
+# FAQApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**faqCreate**](#faqcreate) | **POST** /v3/promotion/{promotion_id}/cms/faq | Cadastra perguntas frequentes na promoção|
+|[**faqDelete**](#faqdelete) | **DELETE** /v3/promotion/{promotion_id}/cms/faq | Esclui perguntas frequentes na promoção|
+|[**faqIndex**](#faqindex) | **GET** /v3/promotion/{promotion_id}/cms/faq | Lista as perguntas frequentes cadastradas na promoção|
+|[**faqUpdate**](#faqupdate) | **PATCH** /v3/promotion/{promotion_id}/cms/faq | Cadastra ou atualiza perguntas frequentes na promoção|
+
+# **faqCreate**
+> FaqCreate200Response faqCreate()
+
+
+### Example
+
+```typescript
+import {
+    FAQApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new FAQApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let faqCreateRequestInner: Array<FaqCreateRequestInner>; // (optional)
+
+const { status, data } = await apiInstance.faqCreate(
+    promotionId,
+    faqCreateRequestInner
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **faqCreateRequestInner** | **Array<FaqCreateRequestInner>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**FaqCreate200Response**
+
+### 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)
+
+# **faqDelete**
+> FaqDelete200Response faqDelete()
+
+A exclusão é feita caso haja uma pergunta frequente com a mesma question enviada.
+
+### Example
+
+```typescript
+import {
+    FAQApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new FAQApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let answer: string; //Pergunta da questão a ser excluída (default to undefined)
+
+const { status, data } = await apiInstance.faqDelete(
+    promotionId,
+    answer
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **answer** | [**string**] | Pergunta da questão a ser excluída | defaults to undefined|
+
+
+### Return type
+
+**FaqDelete200Response**
+
+### 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)
+
+# **faqIndex**
+> FaqIndex200Response faqIndex()
+
+
+### Example
+
+```typescript
+import {
+    FAQApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new FAQApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let question: string; //Pesquisa perguntas frequentes através da questão (optional) (default to undefined)
+let answer: string; //Pesquisa perguntas frequentes através da resposta (optional) (default to undefined)
+
+const { status, data } = await apiInstance.faqIndex(
+    promotionId,
+    question,
+    answer
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **question** | [**string**] | Pesquisa perguntas frequentes através da questão | (optional) defaults to undefined|
+| **answer** | [**string**] | Pesquisa perguntas frequentes através da resposta | (optional) defaults to undefined|
+
+
+### Return type
+
+**FaqIndex200Response**
+
+### 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)
+
+# **faqUpdate**
+> FaqUpdate200Response faqUpdate()
+
+A atualização é feita caso haja uma pergunta frequente com a mesma question enviada para cadastro.
+
+### Example
+
+```typescript
+import {
+    FAQApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new FAQApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let faqCreateRequestInner: Array<FaqCreateRequestInner>; // (optional)
+
+const { status, data } = await apiInstance.faqUpdate(
+    promotionId,
+    faqCreateRequestInner
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **faqCreateRequestInner** | **Array<FaqCreateRequestInner>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**FaqUpdate200Response**
+
+### 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/FaqCreate200Response.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,56 @@
+# FilesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**filesShow**](#filesshow) | **GET** /v3/promotion/{promotion_id}/files/{filename} | Faz o download de um arquivo|
+
+# **filesShow**
+> filesShow()
+
+
+### Example
+
+```typescript
+import {
+    FilesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new FilesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let filename: string; //Nome do arquivo (default to undefined)
+
+const { status, data } = await apiInstance.filesShow(
+    promotionId,
+    filename
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **filename** | [**string**] | Nome do arquivo | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+[[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/Login200Response.md

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