@handsondigital/idplugger-promotion 1.0.0

package/docs/RafflesCreateRequestInner.md

@@ -0,0 +1,30 @@
+# RafflesCreateRequestInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**raffle_date_start** | **string** |  | [optional] [default to undefined]
+**raffle_date_end** | **string** |  | [optional] [default to undefined]
+**raffle_date** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RafflesCreateRequestInner } from '@handsondigital/idplugger-promotion';
+
+const instance: RafflesCreateRequestInner = {
+    name,
+    description,
+    raffle_date_start,
+    raffle_date_end,
+    raffle_date,
+    status,
+};
+```
+
+[[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/RafflesDelete200Response.md

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,24 @@
+# SerieNumber
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serie_number** | **string** |  | [default to undefined]
+**qty** | **number** |  | [default to undefined]
+**cost** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SerieNumber } from '@handsondigital/idplugger-promotion';
+
+const instance: SerieNumber = {
+    serie_number,
+    qty,
+    cost,
+};
+```
+
+[[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/SettingsApi.md

@@ -0,0 +1,65 @@
+# SettingsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**configWebhook**](#configwebhook) | **POST** /v3/promotion/{promotion_id}/webhook | Configura o webhook da promoção|
+
+# **configWebhook**
+> ConfigWebhook200Response configWebhook()
+
+Este endpoint é responsável por configurar o webhook da promoção. Ao cadastrar um usuário ou um cupom na promoção, a API irá armazenar estas informações para processar em segundo plano. Ao fim do processamento (ou em caso de falha) do cadastro a API irá fazer uma requisição do tipo POST para o webhook configurado.  O `secret` cadastrado será enviado através do header `authorization`.
+
+### Example
+
+```typescript
+import {
+    SettingsApi,
+    Configuration,
+    ConfigWebhookRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new SettingsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let configWebhookRequest: ConfigWebhookRequest; // (optional)
+
+const { status, data } = await apiInstance.configWebhook(
+    promotionId,
+    configWebhookRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **configWebhookRequest** | **ConfigWebhookRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**ConfigWebhook200Response**
+
+### 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/Store.md

@@ -0,0 +1,38 @@
+# Store
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Id da loja | [optional] [default to undefined]
+**code** | **string** | Código da loja | [optional] [default to undefined]
+**cnpj** | **string** | CNPJ da loja | [default to undefined]
+**name** | **string** | Nome da loja | [default to undefined]
+**address** | **string** | Endereço da loja | [optional] [default to undefined]
+**status** | **boolean** | Loja ativa ou inativa | [optional] [default to undefined]
+**city** | **string** | Cidade da loja | [optional] [default to undefined]
+**state** | **string** | Estado da loja | [optional] [default to undefined]
+**latitude** | **string** | Latitude da loja | [optional] [default to undefined]
+**longitude** | **string** | Longitude da loja | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Store } from '@handsondigital/idplugger-promotion';
+
+const instance: Store = {
+    id,
+    code,
+    cnpj,
+    name,
+    address,
+    status,
+    city,
+    state,
+    latitude,
+    longitude,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)