@handsondigital/idplugger-promotion 1.0.0

package/docs/ArticlesUpdate200Response.md

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

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

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

@@ -0,0 +1,105 @@
+# AuthApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**login**](#login) | **POST** /v3/login | Login na API|
+|[**me**](#me) | **GET** /v3/me | Dados na API|
+
+# **login**
+> Login200Response login()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration,
+    LoginRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+let loginRequest: LoginRequest; // (optional)
+
+const { status, data } = await apiInstance.login(
+    loginRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **loginRequest** | **LoginRequest**|  | |
+
+
+### Return type
+
+**Login200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | success |  -  |
+|**401** | failed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **me**
+> Me200Response me()
+
+
+### Example
+
+```typescript
+import {
+    AuthApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AuthApi(configuration);
+
+const { status, data } = await apiInstance.me();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Me200Response**
+
+### 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 |  -  |
+|**401** | failed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/Award.md

@@ -0,0 +1,40 @@
+# Award
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**lottery_id** | **number** |  | [optional] [default to undefined]
+**cod** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**start_validaty** | **string** |  | [optional] [default to undefined]
+**finish_validaty** | **string** |  | [optional] [default to undefined]
+**status** | **number** |  | [optional] [default to undefined]
+**raffle_id** | **number** |  | [optional] [default to undefined]
+**qtd_premios** | **number** |  | [default to undefined]
+**raffle_ordem** | **number** |  | [optional] [default to undefined]
+**raffle_type** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Award } from '@handsondigital/idplugger-promotion';
+
+const instance: Award = {
+    id,
+    lottery_id,
+    cod,
+    name,
+    start_validaty,
+    finish_validaty,
+    status,
+    raffle_id,
+    qtd_premios,
+    raffle_ordem,
+    raffle_type,
+};
+```
+
+[[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/Awarded.md

@@ -0,0 +1,38 @@
+# Awarded
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**raffle_id** | **number** |  | [optional] [default to undefined]
+**lucky_number_id** | **number** |  | [optional] [default to undefined]
+**award_id** | **number** |  | [default to undefined]
+**awarded_state_id** | **number** |  | [default to undefined]
+**checklist** | **string** |  | [optional] [default to undefined]
+**justificativa** | **string** |  | [optional] [default to undefined]
+**observacoes** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Awarded } from '@handsondigital/idplugger-promotion';
+
+const instance: Awarded = {
+    id,
+    raffle_id,
+    lucky_number_id,
+    award_id,
+    awarded_state_id,
+    checklist,
+    justificativa,
+    observacoes,
+    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/AwardedsApi.md

@@ -0,0 +1,184 @@
+# AwardedsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**awardedsSearch**](#awardedssearch) | **GET** /v3/promotion/{promotion_id}/awardeds | Busca por usuários cadastrados na promoção ganhadores de sorteios|
+|[**awardedsStates**](#awardedsstates) | **GET** /v3/promotion/{promotion_id}/awardeds/states | Lista os status de ganhador existentes na promoção|
+|[**awardedsUpdate**](#awardedsupdate) | **PATCH** /v3/promotion/{promotion_id}/awardeds | Atualiza informações referentes aos ganhadores de sorteios da promoção|
+
+# **awardedsSearch**
+> AwardedsSearch200Response awardedsSearch()
+
+
+### Example
+
+```typescript
+import {
+    AwardedsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardedsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let include: string; //Dados relacionados a serem retornados (optional) (default to undefined)
+let userId: string; //Id do usuário (optional) (default to undefined)
+let luckyNumberId: string; //Id do número da sorte (optional) (default to undefined)
+let checklist: string; //Busca ganhadores pelo texto do checklist (optional) (default to undefined)
+let justificativa: string; //Busca ganhadores pelo texto da justificativa (optional) (default to undefined)
+
+const { status, data } = await apiInstance.awardedsSearch(
+    promotionId,
+    fields,
+    include,
+    userId,
+    luckyNumberId,
+    checklist,
+    justificativa
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **include** | [**string**] | Dados relacionados a serem retornados | (optional) defaults to undefined|
+| **userId** | [**string**] | Id do usuário | (optional) defaults to undefined|
+| **luckyNumberId** | [**string**] | Id do número da sorte | (optional) defaults to undefined|
+| **checklist** | [**string**] | Busca ganhadores pelo texto do checklist | (optional) defaults to undefined|
+| **justificativa** | [**string**] | Busca ganhadores pelo texto da justificativa | (optional) defaults to undefined|
+
+
+### Return type
+
+**AwardedsSearch200Response**
+
+### 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)
+
+# **awardedsStates**
+> AwardedsStates200Response awardedsStates()
+
+
+### Example
+
+```typescript
+import {
+    AwardedsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardedsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+
+const { status, data } = await apiInstance.awardedsStates(
+    promotionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AwardedsStates200Response**
+
+### 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)
+
+# **awardedsUpdate**
+> AwardedsUpdate200Response awardedsUpdate()
+
+
+### Example
+
+```typescript
+import {
+    AwardedsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardedsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+
+const { status, data } = await apiInstance.awardedsUpdate(
+    promotionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AwardedsUpdate200Response**
+
+### 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/AwardedsSearch200Response.md

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

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

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

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

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

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

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

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