@handsondigital/idplugger-promotion 1.0.0

package/docs/UserWebhookErrorContent.md

@@ -0,0 +1,58 @@
+# UserWebhookErrorContent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**cpf** | **string** |  | [default to undefined]
+**cnpj** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**birth** | **string** |  | [default to undefined]
+**cep** | **string** |  | [default to undefined]
+**address** | **string** |  | [default to undefined]
+**number** | **string** |  | [default to undefined]
+**neighborhood** | **string** |  | [default to undefined]
+**city** | **string** |  | [default to undefined]
+**state** | **string** |  | [default to undefined]
+**cel** | **string** |  | [optional] [default to undefined]
+**sex** | **string** |  | [default to undefined]
+**newsletter** | **boolean** |  | [optional] [default to undefined]
+**policy_privacy** | **boolean** |  | [optional] [default to undefined]
+**agree_terms** | **boolean** |  | [optional] [default to undefined]
+**custom_data** | [**UserCustomData**](UserCustomData.md) |  | [optional] [default to undefined]
+**errors** | [**UserWebhookErrorContentAllOfErrors**](UserWebhookErrorContentAllOfErrors.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserWebhookErrorContent } from '@handsondigital/idplugger-promotion';
+
+const instance: UserWebhookErrorContent = {
+    id,
+    name,
+    email,
+    cpf,
+    cnpj,
+    phone,
+    birth,
+    cep,
+    address,
+    number,
+    neighborhood,
+    city,
+    state,
+    cel,
+    sex,
+    newsletter,
+    policy_privacy,
+    agree_terms,
+    custom_data,
+    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/UserWebhookErrorContentAllOfErrors.md

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

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

@@ -0,0 +1,304 @@
+# UsersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**usersCreate**](#userscreate) | **POST** /v3/promotion/{promotion_id}/users | Cadastra um usuário na promoção|
+|[**usersDelete**](#usersdelete) | **DELETE** /v3/promotion/{promotion_id}/users/{user_id} | Exclui um usuário da promoção|
+|[**usersIndex**](#usersindex) | **GET** /v3/promotion/{promotion_id}/users | Busca por um usuário cadastrado na promoção|
+|[**usersUpdate**](#usersupdate) | **PATCH** /v3/promotion/{promotion_id}/users | Cadastra ou atualiza um usuário na promoção|
+|[**usersWebhook**](#userswebhook) | **POST** /webhook-do-usuario | Webhook de resposta ao registro de usuário|
+
+# **usersCreate**
+> UsersCreate201Response usersCreate()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UsersCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let usersCreateRequest: UsersCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.usersCreate(
+    promotionId,
+    usersCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **usersCreateRequest** | **UsersCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**UsersCreate201Response**
+
+### 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)
+
+# **usersDelete**
+> UsersDelete200Response usersDelete()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let userId: string; //ID do usuário (default to undefined)
+
+const { status, data } = await apiInstance.usersDelete(
+    promotionId,
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **userId** | [**string**] | ID do usuário | defaults to undefined|
+
+
+### Return type
+
+**UsersDelete200Response**
+
+### 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)
+
+# **usersIndex**
+> UsersIndex200Response usersIndex()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: number; //ID do usuário (optional) (default to undefined)
+let externalId: string; //ID externo do usuário (optional) (default to undefined)
+let username: string; //username do usuário (optional) (default to undefined)
+let email: string; //email do usuário (optional) (default to undefined)
+let cpf: string; //CPF do usuário (optional) (default to undefined)
+let include: string; //Dados relacionados a serem retornados (optional) (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+
+const { status, data } = await apiInstance.usersIndex(
+    promotionId,
+    id,
+    externalId,
+    username,
+    email,
+    cpf,
+    include,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**number**] | ID do usuário | (optional) defaults to undefined|
+| **externalId** | [**string**] | ID externo do usuário | (optional) defaults to undefined|
+| **username** | [**string**] | username do usuário | (optional) defaults to undefined|
+| **email** | [**string**] | email do usuário | (optional) defaults to undefined|
+| **cpf** | [**string**] | CPF do usuário | (optional) defaults to undefined|
+| **include** | [**string**] | Dados relacionados a serem retornados | (optional) defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+
+
+### Return type
+
+**UsersIndex200Response**
+
+### 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)
+
+# **usersUpdate**
+> UsersUpdate201Response usersUpdate()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UsersCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let usersCreateRequest: UsersCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.usersUpdate(
+    promotionId,
+    usersCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **usersCreateRequest** | **UsersCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**UsersUpdate201Response**
+
+### 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)
+
+# **usersWebhook**
+> UsersWebhook200Response usersWebhook()
+
+Este endpoint é apenas um exemplo de como você receberá em seu webhook a notificação do registro de um usuário 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 usuário 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 {
+    UsersApi,
+    Configuration,
+    UsersWebhookRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let usersWebhookRequest: UsersWebhookRequest; // (optional)
+
+const { status, data } = await apiInstance.usersWebhook(
+    usersWebhookRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **usersWebhookRequest** | **UsersWebhookRequest**|  | |
+
+
+### 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/UsersCreate201Response.md

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

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

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

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

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

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

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

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

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

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