@handsondigital/idplugger-promotion 1.0.0

package/docs/TicketsApi.md

@@ -0,0 +1,249 @@
+# TicketsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**ticketsCreate**](#ticketscreate) | **POST** /v3/promotion/{promotion_id}/tickets | Cadastra um ticket de suporte na promoção|
+|[**ticketsDelete**](#ticketsdelete) | **DELETE** /v3/promotion/{promotion_id}/tickets/{id} | Exclui um ticket de suporte da promoção|
+|[**ticketsIndex**](#ticketsindex) | **GET** /v3/promotion/{promotion_id}/tickets | Busca por tickets de suporte cadastrados na promoção|
+|[**ticketsUpdate**](#ticketsupdate) | **PATCH** /v3/promotion/{promotion_id}/tickets | Cadastra ou atualiza um ticket de suporte na promoção|
+
+# **ticketsCreate**
+> TicketsCreate200Response ticketsCreate()
+
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let ticket: Array<Ticket>; // (optional)
+
+const { status, data } = await apiInstance.ticketsCreate(
+    promotionId,
+    ticket
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticket** | **Array<Ticket>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**TicketsCreate200Response**
+
+### 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)
+
+# **ticketsDelete**
+> TicketsDelete200Response ticketsDelete()
+
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let id: number; //ID do ticket de suporte (default to undefined)
+
+const { status, data } = await apiInstance.ticketsDelete(
+    promotionId,
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **id** | [**number**] | ID do ticket de suporte | defaults to undefined|
+
+
+### Return type
+
+**TicketsDelete200Response**
+
+### 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)
+
+# **ticketsIndex**
+> TicketsIndex200Response ticketsIndex()
+
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Dados associados (optional) (default to undefined)
+let include: string; //Dados associados (optional) (default to undefined)
+let id: string; //Id do ticket (optional) (default to undefined)
+let parentId: string; //Id do ticket que gerou a resposta (optional) (default to undefined)
+let userFromId: string; //Id do remetente (optional) (default to undefined)
+let userToId: string; //Id do destinatário (optional) (default to undefined)
+let status: string; //Status do destinatário (optional) (default to undefined)
+
+const { status, data } = await apiInstance.ticketsIndex(
+    promotionId,
+    fields,
+    include,
+    id,
+    parentId,
+    userFromId,
+    userToId,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Dados associados | (optional) defaults to undefined|
+| **include** | [**string**] | Dados associados | (optional) defaults to undefined|
+| **id** | [**string**] | Id do ticket | (optional) defaults to undefined|
+| **parentId** | [**string**] | Id do ticket que gerou a resposta | (optional) defaults to undefined|
+| **userFromId** | [**string**] | Id do remetente | (optional) defaults to undefined|
+| **userToId** | [**string**] | Id do destinatário | (optional) defaults to undefined|
+| **status** | [**string**] | Status do destinatário | (optional) defaults to undefined|
+
+
+### Return type
+
+**TicketsIndex200Response**
+
+### 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)
+
+# **ticketsUpdate**
+> TicketsUpdate200Response ticketsUpdate()
+
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let ticket: Array<Ticket>; // (optional)
+
+const { status, data } = await apiInstance.ticketsUpdate(
+    promotionId,
+    ticket
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticket** | **Array<Ticket>**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**TicketsUpdate200Response**
+
+### 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/TicketsCreate200Response.md

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,56 @@
+# User
+
+
+## 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]
+
+## Example
+
+```typescript
+import { User } from '@handsondigital/idplugger-promotion';
+
+const instance: User = {
+    id,
+    name,
+    email,
+    cpf,
+    cnpj,
+    phone,
+    birth,
+    cep,
+    address,
+    number,
+    neighborhood,
+    city,
+    state,
+    cel,
+    sex,
+    newsletter,
+    policy_privacy,
+    agree_terms,
+    custom_data,
+};
+```
+
+[[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/UserCustomData.md

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

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