@handsondigital/idplugger-promotion 1.0.0

package/docs/CouponWebhookErrorContent.md

@@ -0,0 +1,38 @@
+# CouponWebhookErrorContent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**user_id** | **number** |  | [default to undefined]
+**purchase_date** | **string** |  | [default to undefined]
+**cnpj** | **string** |  | [default to undefined]
+**code** | **string** |  | [default to undefined]
+**cost** | **number** |  | [default to undefined]
+**serie** | **number** |  | [optional] [default to undefined]
+**products** | [**Array<CouponProductsInner>**](CouponProductsInner.md) |  | [optional] [default to undefined]
+**promotion_codes** | **Array<string>** |  | [optional] [default to undefined]
+**errors** | [**CouponWebhookErrorContentAllOfErrors**](CouponWebhookErrorContentAllOfErrors.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CouponWebhookErrorContent } from '@handsondigital/idplugger-promotion';
+
+const instance: CouponWebhookErrorContent = {
+    id,
+    user_id,
+    purchase_date,
+    cnpj,
+    code,
+    cost,
+    serie,
+    products,
+    promotion_codes,
+    errors,
+};
+```
+
+[[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/CouponWebhookErrorContentAllOfErrors.md

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

@@ -0,0 +1,26 @@
+# CouponWebhookSuccess
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **string** |  | [optional] [default to undefined]
+**action** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**content** | [**CouponsIndex200ResponseContentInner**](CouponsIndex200ResponseContentInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CouponWebhookSuccess } from '@handsondigital/idplugger-promotion';
+
+const instance: CouponWebhookSuccess = {
+    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/CouponsApi.md

@@ -0,0 +1,311 @@
+# CouponsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**couponsCreate**](#couponscreate) | **POST** /v3/promotion/{promotion_id}/users/{user_id}/coupons | Cadastra um cupom para um usuário cadastrado na promoção|
+|[**couponsDelete**](#couponsdelete) | **DELETE** /v3/promotion/{promotion_id}/users/{user_id}/coupons/{coupon_id} | Exclui um cupom de um usuário cadastrado na promoção|
+|[**couponsIndex**](#couponsindex) | **GET** /v3/promotion/{promotion_id}/users/{user_id}/coupons | Busca por cupons de um usuário cadastrado na promoção|
+|[**couponsUpdate**](#couponsupdate) | **PATCH** /v3/promotion/{promotion_id}/users/{user_id}/coupons | Cadastra ou atualiza um cupom para um usuário cadastrado na promoção|
+|[**cuponsWebhook**](#cuponswebhook) | **POST** /webhook-do-cupom | Webhook de resposta ao registro de cupons|
+
+# **couponsCreate**
+> CouponsCreate200Response couponsCreate()
+
+Os registros de cupons são processados individualmente e o resultado é enviado via webhook
+
+### Example
+
+```typescript
+import {
+    CouponsApi,
+    Configuration,
+    CouponsCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new CouponsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: number; //ID do usuário (default to undefined)
+let couponsCreateRequest: CouponsCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.couponsCreate(
+    promotionId,
+    userId,
+    couponsCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **couponsCreateRequest** | **CouponsCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**number**] | ID do usuário | defaults to undefined|
+
+
+### Return type
+
+**CouponsCreate200Response**
+
+### 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 |  -  |
+|**401** | unauthorized |  -  |
+|**409** | 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)
+
+# **couponsDelete**
+> CouponsDelete200Response couponsDelete()
+
+
+### Example
+
+```typescript
+import {
+    CouponsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new CouponsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: string; //ID do usuário (default to undefined)
+let couponId: string; //ID do cupom (default to undefined)
+
+const { status, data } = await apiInstance.couponsDelete(
+    promotionId,
+    userId,
+    couponId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**string**] | ID do usuário | defaults to undefined|
+| **couponId** | [**string**] | ID do cupom | defaults to undefined|
+
+
+### Return type
+
+**CouponsDelete200Response**
+
+### 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)
+
+# **couponsIndex**
+> CouponsIndex200Response couponsIndex()
+
+
+### Example
+
+```typescript
+import {
+    CouponsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new CouponsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: number; //ID do usuário (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let include: string; //Campos a serem retornados (optional) (default to undefined)
+let id: string; //Id do cupom (optional) (default to undefined)
+let userId2: string; //Id do usuário associado ao cupom (optional) (default to undefined)
+let externalUserId: string; //Id externo do usuário associado ao cupom (optional) (default to undefined)
+
+const { status, data } = await apiInstance.couponsIndex(
+    promotionId,
+    userId,
+    fields,
+    include,
+    id,
+    userId2,
+    externalUserId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**number**] | ID do usuário | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **include** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **id** | [**string**] | Id do cupom | (optional) defaults to undefined|
+| **userId2** | [**string**] | Id do usuário associado ao cupom | (optional) defaults to undefined|
+| **externalUserId** | [**string**] | Id externo do usuário associado ao cupom | (optional) defaults to undefined|
+
+
+### Return type
+
+**CouponsIndex200Response**
+
+### 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)
+
+# **couponsUpdate**
+> CouponsUpdate201Response couponsUpdate()
+
+
+### Example
+
+```typescript
+import {
+    CouponsApi,
+    Configuration,
+    CouponsCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new CouponsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: number; //ID do usuário (default to undefined)
+let couponsCreateRequest: CouponsCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.couponsUpdate(
+    promotionId,
+    userId,
+    couponsCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **couponsCreateRequest** | **CouponsCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**number**] | ID do usuário | defaults to undefined|
+
+
+### Return type
+
+**CouponsUpdate201Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | success |  -  |
+|**401** | unauthorized |  -  |
+|**409** | 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)
+
+# **cuponsWebhook**
+> UsersWebhook200Response cuponsWebhook()
+
+Este endpoint é apenas um exemplo de como você receberá em seu webhook a notificação do registro de um cupons na promoção.  Em **Request body** clique em **Schema** para ver todos as variações de requisições que a API faz.  Alguns erros são apenas informativos de que alguma parte não essencial do cadastro não funcionou. Para identificar se o cupons foi cadastrado ou não, verifique se o parâmetro `content.id` está incluso na requisição e é um número maior que zero.
+
+### Example
+
+```typescript
+import {
+    CouponsApi,
+    Configuration,
+    CuponsWebhookRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new CouponsApi(configuration);
+
+let cuponsWebhookRequest: CuponsWebhookRequest; // (optional)
+
+const { status, data } = await apiInstance.cuponsWebhook(
+    cuponsWebhookRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cuponsWebhookRequest** | **CuponsWebhookRequest**|  | |
+
+
+### Return type
+
+**UsersWebhook200Response**
+
+### 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 |  -  |
+
+[[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/CouponsCreate200Response.md

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

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

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

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

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

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

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

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

@@ -0,0 +1,38 @@
+# CouponsIndex200ResponseContentInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**user_id** | **number** |  | [default to undefined]
+**purchase_date** | **string** |  | [default to undefined]
+**cnpj** | **string** |  | [default to undefined]
+**code** | **string** |  | [default to undefined]
+**cost** | **number** |  | [default to undefined]
+**serie** | **number** |  | [optional] [default to undefined]
+**products** | [**Array<CouponProductsInner>**](CouponProductsInner.md) |  | [optional] [default to undefined]
+**promotion_codes** | **Array<string>** |  | [optional] [default to undefined]
+**lucky_numbers** | [**Array<LuckyNumber>**](LuckyNumber.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CouponsIndex200ResponseContentInner } from '@handsondigital/idplugger-promotion';
+
+const instance: CouponsIndex200ResponseContentInner = {
+    id,
+    user_id,
+    purchase_date,
+    cnpj,
+    code,
+    cost,
+    serie,
+    products,
+    promotion_codes,
+    lucky_numbers,
+};
+```
+
+[[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/CouponsIndex400Response.md

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