@handsondigital/idplugger-promotion 1.0.0

package/docs/BlacklistCreateRequest.md

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

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

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

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

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

@@ -0,0 +1,24 @@
+# BlacklistIndex200ResponseContentInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**cpf** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BlacklistIndex200ResponseContentInner } from '@handsondigital/idplugger-promotion';
+
+const instance: BlacklistIndex200ResponseContentInner = {
+    id,
+    cpf,
+    created_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/BlacklistIndex400Response.md

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

@@ -0,0 +1,179 @@
+# BlockedUsersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**blacklistCreate**](#blacklistcreate) | **POST** /v3/promotion/{promotion_id}/users/blacklist | Cadastra um CPF na lista de CPFs bloqueados na promoção|
+|[**blacklistDelete**](#blacklistdelete) | **DELETE** /v3/promotion/{promotion_id}/users/blacklist/{id} | Exclui um CPF da lista de CPFs bloqueados da promoção|
+|[**blacklistIndex**](#blacklistindex) | **GET** /v3/promotion/{promotion_id}/users/blacklist | Pesquisa por CPFs bloqueados na promoção|
+
+# **blacklistCreate**
+> BlacklistCreate200Response blacklistCreate()
+
+
+### Example
+
+```typescript
+import {
+    BlockedUsersApi,
+    Configuration,
+    BlacklistCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new BlockedUsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let blacklistCreateRequest: BlacklistCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.blacklistCreate(
+    promotionId,
+    blacklistCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **blacklistCreateRequest** | **BlacklistCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**BlacklistCreate200Response**
+
+### 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)
+
+# **blacklistDelete**
+> BlacklistDelete200Response blacklistDelete()
+
+
+### Example
+
+```typescript
+import {
+    BlockedUsersApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new BlockedUsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: number; //ID do CPF bloqueado na promoção (default to undefined)
+
+const { status, data } = await apiInstance.blacklistDelete(
+    promotionId,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**number**] | ID do CPF bloqueado na promoção | defaults to undefined|
+
+
+### Return type
+
+**BlacklistDelete200Response**
+
+### 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)
+
+# **blacklistIndex**
+> BlacklistIndex200Response blacklistIndex()
+
+
+### Example
+
+```typescript
+import {
+    BlockedUsersApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new BlockedUsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let cpf: string; //CPF bloqueado (optional) (default to undefined)
+
+const { status, data } = await apiInstance.blacklistIndex(
+    promotionId,
+    fields,
+    cpf
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **cpf** | [**string**] | CPF bloqueado | (optional) defaults to undefined|
+
+
+### Return type
+
+**BlacklistIndex200Response**
+
+### 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/Branding.md

@@ -0,0 +1,54 @@
+# Branding
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logomarca** | **string** | Logomarca da promoção ou da empresa promotora da promoção | [optional] [default to undefined]
+**font_primary** | **string** | Fonte utilizada em todo o site | [optional] [default to undefined]
+**font_secondary** | **string** | Fonte utilizada em títulos do Hotsite | [optional] [default to undefined]
+**color_main** | **string** | Cor principal da marca | [optional] [default to undefined]
+**color_menu** | **string** | Cor de fundo do menu principal e do footer | [optional] [default to undefined]
+**color_primary** | **string** | Cor principal dos botões de ação | [optional] [default to undefined]
+**color_secondary** | **string** | Cor secundária para botões de menor nível de importância | [optional] [default to undefined]
+**color_success** | **string** | Cor de textos relacionados a ações bem sucedidas | [optional] [default to undefined]
+**color_info** | **string** | Cor de textos relacionados a informação | [optional] [default to undefined]
+**color_warning** | **string** | Cor de textos relacionados a avisos | [optional] [default to undefined]
+**color_danger** | **string** | Cor de textos relacionados a ações mal sucedidas | [optional] [default to undefined]
+**color_light** | **string** | Cor de fundo clara | [optional] [default to undefined]
+**color_dark** | **string** | Cor de fundo escura | [optional] [default to undefined]
+**color_black** | **string** | Cor mais escura utilizada em todo o site | [optional] [default to undefined]
+**input_border_radius** | **string** | Campos de entrada de dados com ou sem cantos arredondados | [optional] [default to InputBorderRadiusEnum_On]
+**btn_border_radius** | **string** | Botões com ou sem cantos arredondados | [optional] [default to BtnBorderRadiusEnum_On]
+**menu** | [**Array<BrandingMenuInner>**](BrandingMenuInner.md) | Itens do menu do hotsite da promoção | [optional] [default to undefined]
+**social** | [**BrandingSocial**](BrandingSocial.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Branding } from '@handsondigital/idplugger-promotion';
+
+const instance: Branding = {
+    logomarca,
+    font_primary,
+    font_secondary,
+    color_main,
+    color_menu,
+    color_primary,
+    color_secondary,
+    color_success,
+    color_info,
+    color_warning,
+    color_danger,
+    color_light,
+    color_dark,
+    color_black,
+    input_border_radius,
+    btn_border_radius,
+    menu,
+    social,
+};
+```
+
+[[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/BrandingApi.md

@@ -0,0 +1,120 @@
+# BrandingApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**brandingIndex**](#brandingindex) | **GET** /v3/promotion/{promotion_id}/cms/branding | Dados referentes a identidade visual da marca da promoção|
+|[**brandingUpdate**](#brandingupdate) | **POST** /v3/promotion/{promotion_id}/cms/branding | Altera os dados referentes a identidade visual da marca da promoção|
+
+# **brandingIndex**
+> BrandingIndex200Response brandingIndex()
+
+
+### Example
+
+```typescript
+import {
+    BrandingApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new BrandingApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados pela API (optional) (default to undefined)
+
+const { status, data } = await apiInstance.brandingIndex(
+    promotionId,
+    fields
+);
+```
+
+### 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|
+
+
+### Return type
+
+**BrandingIndex200Response**
+
+### 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)
+
+# **brandingUpdate**
+> BrandingUpdate200Response brandingUpdate()
+
+
+### Example
+
+```typescript
+import {
+    BrandingApi,
+    Configuration,
+    Branding
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new BrandingApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let branding: Branding; // (optional)
+
+const { status, data } = await apiInstance.brandingUpdate(
+    promotionId,
+    branding
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **branding** | **Branding**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**BrandingUpdate200Response**
+
+### 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/BrandingIndex200Response.md

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

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

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

@@ -0,0 +1,24 @@
+# BrandingMenuInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Texto do link/botão do menu | [optional] [default to undefined]
+**url** | **string** | url do link/botão do menu | [optional] [default to undefined]
+**target_blank** | **string** | on=Abrir url em nova aba do navegador, off=Abrir url na mesma aba do navegador | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BrandingMenuInner } from '@handsondigital/idplugger-promotion';
+
+const instance: BrandingMenuInner = {
+    title,
+    url,
+    target_blank,
+};
+```
+
+[[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/BrandingSocial.md

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