@handsondigital/idplugger-admin 1.0.0

package/docs/RolesStore201ResponseRole.md

@@ -0,0 +1,26 @@
+# RolesStore201ResponseRole
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**is_active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RolesStore201ResponseRole } from '@handsondigital/idplugger-admin';
+
+const instance: RolesStore201ResponseRole = {
+    id,
+    name,
+    description,
+    is_active,
+};
+```
+
+[[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/RolesStore422Response.md

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

@@ -0,0 +1,24 @@
+# RolesStoreRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**is_active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RolesStoreRequest } from '@handsondigital/idplugger-admin';
+
+const instance: RolesStoreRequest = {
+    name,
+    description,
+    is_active,
+};
+```
+
+[[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/RolesUpdate200Response.md

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

@@ -0,0 +1,24 @@
+# RolesUpdateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**is_active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RolesUpdateRequest } from '@handsondigital/idplugger-admin';
+
+const instance: RolesUpdateRequest = {
+    name,
+    description,
+    is_active,
+};
+```
+
+[[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/StepsAllow201Response.md

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

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

@@ -0,0 +1,24 @@
+# StepsAllowRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**promotion_id** | **string** |  | [optional] [default to undefined]
+**endpoint** | **string** |  | [optional] [default to undefined]
+**steps** | **Array<any>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StepsAllowRequest } from '@handsondigital/idplugger-admin';
+
+const instance: StepsAllowRequest = {
+    promotion_id,
+    endpoint,
+    steps,
+};
+```
+
+[[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/StepsApi.md

@@ -0,0 +1,167 @@
+# StepsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**stepsAllow**](#stepsallow) | **POST** /v3/steps/allow | Inclui uma Step em um determinado endpoint|
+|[**stepsIndex**](#stepsindex) | **GET** /v3/steps | Retorna todas as steps existentes|
+|[**stepsUnallow**](#stepsunallow) | **POST** /v3/steps/disallow | Remove uma Step de um determinado endpoint|
+
+# **stepsAllow**
+> StepsAllow201Response stepsAllow()
+
+
+### Example
+
+```typescript
+import {
+    StepsApi,
+    Configuration,
+    StepsAllowRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new StepsApi(configuration);
+
+let stepsAllowRequest: StepsAllowRequest; // (optional)
+
+const { status, data } = await apiInstance.stepsAllow(
+    stepsAllowRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stepsAllowRequest** | **StepsAllowRequest**|  | |
+
+
+### Return type
+
+**StepsAllow201Response**
+
+### 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 |  -  |
+|**409** | 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)
+
+# **stepsIndex**
+> StepsIndex200Response stepsIndex()
+
+
+### Example
+
+```typescript
+import {
+    StepsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new StepsApi(configuration);
+
+let promotionId: string; //UUID da promoção (optional) (default to undefined)
+
+const { status, data } = await apiInstance.stepsIndex(
+    promotionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | UUID da promoção | (optional) defaults to undefined|
+
+
+### Return type
+
+**StepsIndex200Response**
+
+### 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 |  -  |
+|**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)
+
+# **stepsUnallow**
+> StepsUnallow201Response stepsUnallow()
+
+
+### Example
+
+```typescript
+import {
+    StepsApi,
+    Configuration,
+    StepsAllowRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new StepsApi(configuration);
+
+let stepsAllowRequest: StepsAllowRequest; // (optional)
+
+const { status, data } = await apiInstance.stepsUnallow(
+    stepsAllowRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stepsAllowRequest** | **StepsAllowRequest**|  | |
+
+
+### Return type
+
+**StepsUnallow201Response**
+
+### 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 |  -  |
+|**409** | 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/StepsIndex200Response.md

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

@@ -0,0 +1,30 @@
+# StepsIndex200ResponseStepsValueValue
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_default** | **boolean** | Valor padrão da validação | [optional] [default to undefined]
+**title** | **string** | Título da validação | [optional] [default to undefined]
+**description** | **string** | Detalhes da validação | [optional] [default to undefined]
+**active** | **boolean** | Se a validação está ativa | [optional] [default to undefined]
+**depends_on** | **Array<string>** | Dependências de outras validações | [optional] [default to undefined]
+**deprecated** | **boolean** | Se a validação está obsoleta | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StepsIndex200ResponseStepsValueValue } from '@handsondigital/idplugger-admin';
+
+const instance: StepsIndex200ResponseStepsValueValue = {
+    _default,
+    title,
+    description,
+    active,
+    depends_on,
+    deprecated,
+};
+```
+
+[[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/StepsUnallow201Response.md

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

@@ -0,0 +1,26 @@
+# StepsUnallow409Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** |  | [optional] [default to undefined]
+**endpoint** | **string** |  | [optional] [default to undefined]
+**result** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StepsUnallow409Response } from '@handsondigital/idplugger-admin';
+
+const instance: StepsUnallow409Response = {
+    action,
+    endpoint,
+    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)