@handsondigital/idplugger-promotion 1.0.0

package/docs/AwardsApi.md

@@ -0,0 +1,243 @@
+# AwardsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**awardsCreate**](#awardscreate) | **POST** /v3/promotion/{promotion_id}/awards | Cadastra um prêmio na promoção|
+|[**awardsDelete**](#awardsdelete) | **DELETE** /v3/promotion/{promotion_id}/awards/{id} | Deleta um prêmio da promoção|
+|[**awardsIndex**](#awardsindex) | **GET** /v3/promotion/{promotion_id}/awards | Pesquisa por prêmios na promoção|
+|[**awardsUpdate**](#awardsupdate) | **PATCH** /v3/promotion/{promotion_id}/awards | Cadastra ou atualiza um prêmio na promoção|
+
+# **awardsCreate**
+> AwardsCreate200Response awardsCreate()
+
+
+### Example
+
+```typescript
+import {
+    AwardsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let award: Array<Award>; // (optional)
+
+const { status, data } = await apiInstance.awardsCreate(
+    promotionId,
+    award
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **award** | **Array<Award>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AwardsCreate200Response**
+
+### 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)
+
+# **awardsDelete**
+> AwardsDelete200Response awardsDelete()
+
+
+### Example
+
+```typescript
+import {
+    AwardsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: string; //ID do prêmio (default to undefined)
+
+const { status, data } = await apiInstance.awardsDelete(
+    promotionId,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**string**] | ID do prêmio | defaults to undefined|
+
+
+### Return type
+
+**AwardsDelete200Response**
+
+### 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)
+
+# **awardsIndex**
+> AwardsIndex200Response awardsIndex()
+
+
+### Example
+
+```typescript
+import {
+    AwardsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardsApi(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 id: string; //Id do prêmio (optional) (default to undefined)
+let raffleId: string; //Id do sorteio (optional) (default to undefined)
+let raffleType: string; //Tipo do sorteio (optional) (default to undefined)
+
+const { status, data } = await apiInstance.awardsIndex(
+    promotionId,
+    fields,
+    include,
+    id,
+    raffleId,
+    raffleType
+);
+```
+
+### 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|
+| **id** | [**string**] | Id do prêmio | (optional) defaults to undefined|
+| **raffleId** | [**string**] | Id do sorteio | (optional) defaults to undefined|
+| **raffleType** | [**string**] | Tipo do sorteio | (optional) defaults to undefined|
+
+
+### Return type
+
+**AwardsIndex200Response**
+
+### 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)
+
+# **awardsUpdate**
+> AwardsUpdate200Response awardsUpdate()
+
+
+### Example
+
+```typescript
+import {
+    AwardsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new AwardsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let award: Array<Award>; // (optional)
+
+const { status, data } = await apiInstance.awardsUpdate(
+    promotionId,
+    award
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **award** | **Array<Award>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AwardsUpdate200Response**
+
+### 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/AwardsCreate200Response.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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