@handsondigital/idplugger-promotion 1.0.0

package/docs/CouponsIndex401Response.md

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

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

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

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

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

@@ -0,0 +1,173 @@
+# DocumentRulesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**documentRulesIndex**](#documentrulesindex) | **GET** /v3/promotion/{promotion_id}/cms/document_rules | Termos de uso, regulamentos e política de privacidade da promoção|
+|[**documentRulesRegulationDelete**](#documentrulesregulationdelete) | **DELETE** /v3/promotion/{promotion_id}/cms/document_rules/regulation/{regulation_id} | Exclui um regulamento da promoção|
+|[**documentRulesUpdate**](#documentrulesupdate) | **POST** /v3/promotion/{promotion_id}/cms/document_rules | Atualiza os termos de uso e regulamento da promoção|
+
+# **documentRulesIndex**
+> DocumentRulesIndex200Response documentRulesIndex()
+
+
+### Example
+
+```typescript
+import {
+    DocumentRulesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentRulesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+
+const { status, data } = await apiInstance.documentRulesIndex(
+    promotionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**DocumentRulesIndex200Response**
+
+### 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)
+
+# **documentRulesRegulationDelete**
+> DocumentRulesRegulationDelete200Response documentRulesRegulationDelete()
+
+
+### Example
+
+```typescript
+import {
+    DocumentRulesApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentRulesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let regulationId: string; //ID do regulamento (default to undefined)
+
+const { status, data } = await apiInstance.documentRulesRegulationDelete(
+    promotionId,
+    regulationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **regulationId** | [**string**] | ID do regulamento | defaults to undefined|
+
+
+### Return type
+
+**DocumentRulesRegulationDelete200Response**
+
+### 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)
+
+# **documentRulesUpdate**
+> DocumentRulesUpdate200Response documentRulesUpdate()
+
+
+### Example
+
+```typescript
+import {
+    DocumentRulesApi,
+    Configuration,
+    DocumentRulesUpdateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentRulesApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let documentRulesUpdateRequest: DocumentRulesUpdateRequest; // (optional)
+
+const { status, data } = await apiInstance.documentRulesUpdate(
+    promotionId,
+    documentRulesUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentRulesUpdateRequest** | **DocumentRulesUpdateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**DocumentRulesUpdate200Response**
+
+### 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/DocumentRulesIndex200Response.md

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,24 @@
+# DocumentRulesUpdateRequestRegulationsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Informe este uuid para atualizar | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**content** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentRulesUpdateRequestRegulationsInner } from '@handsondigital/idplugger-promotion';
+
+const instance: DocumentRulesUpdateRequestRegulationsInner = {
+    key,
+    title,
+    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)