@handsondigital/idplugger-admin 2.6.2 → 2.7.0

package/docs/AdminPromotionConfigsIndex200Response.md

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

@@ -0,0 +1,28 @@
+# AdminPromotionConfigsIndex200ResponseConfigsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**key** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**grupo** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminPromotionConfigsIndex200ResponseConfigsInner } from '@handsondigital/idplugger-admin';
+
+const instance: AdminPromotionConfigsIndex200ResponseConfigsInner = {
+    id,
+    key,
+    value,
+    type,
+    grupo,
+};
+```
+
+[[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/AdminPromotionConfigsIndex500Response.md

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

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

@@ -0,0 +1,28 @@
+# AdminPromotionConfigsShow200ResponseConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**key** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**grupo** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminPromotionConfigsShow200ResponseConfig } from '@handsondigital/idplugger-admin';
+
+const instance: AdminPromotionConfigsShow200ResponseConfig = {
+    id,
+    key,
+    value,
+    type,
+    grupo,
+};
+```
+
+[[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/AdminPromotionConfigsShow404Response.md

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

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

@@ -0,0 +1,26 @@
+# AdminPromotionConfigsStoreRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Chave da configuração (deve estar no ConfigKeyEnum) | [default to undefined]
+**value** | **any** | Valor da configuração (string, object ou array - será encodado se type for json) | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to TypeEnum_Text]
+**grupo** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminPromotionConfigsStoreRequest } from '@handsondigital/idplugger-admin';
+
+const instance: AdminPromotionConfigsStoreRequest = {
+    key,
+    value,
+    type,
+    grupo,
+};
+```
+
+[[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/AdminPromotionConfigsUpdate200Response.md

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

@@ -0,0 +1,24 @@
+# AdminPromotionConfigsUpdateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **any** | Novo valor da configuração (string, object ou array - será encodado se type for json) | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**grupo** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminPromotionConfigsUpdateRequest } from '@handsondigital/idplugger-admin';
+
+const instance: AdminPromotionConfigsUpdateRequest = {
+    value,
+    type,
+    grupo,
+};
+```
+
+[[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/AdminPromotionConfigsUpsert200Response.md

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

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

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

@@ -0,0 +1,348 @@
+# ConfigsApi
+
+All URIs are relative to *https://api.idplugger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminPromotionConfigsIndex**](#adminpromotionconfigsindex) | **GET** /v3/admin/promotion/{promotion_id}/configs | Listar configurações de uma promoção|
+|[**adminPromotionConfigsShow**](#adminpromotionconfigsshow) | **GET** /v3/admin/promotion/{promotion_id}/configs/{key} | Buscar configuração por chave|
+|[**adminPromotionConfigsStore**](#adminpromotionconfigsstore) | **POST** /v3/admin/promotion/{promotion_id}/configs | Criar nova configuração|
+|[**adminPromotionConfigsUpdate**](#adminpromotionconfigsupdate) | **PUT** /v3/admin/promotion/{promotion_id}/configs/{key} | Atualizar configuração por chave|
+|[**adminPromotionConfigsUpsert**](#adminpromotionconfigsupsert) | **POST** /v3/admin/promotion/{promotion_id}/configs/upsert | Criar ou atualizar configuração por chave (upsert)|
+|[**adminPromotionConfigsValidKeys**](#adminpromotionconfigsvalidkeys) | **GET** /v3/admin/promotion/{promotion_id}/configs/valid-keys | Listar chaves válidas do ConfigKeyEnum|
+
+# **adminPromotionConfigsIndex**
+> AdminPromotionConfigsIndex200Response adminPromotionConfigsIndex()
+
+
+### Example
+
+```typescript
+import {
+    ConfigsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigsApi(configuration);
+
+let promotionId: string; //UUID da promoção (default to undefined)
+let key: string; //Filtrar por chave (busca parcial) (optional) (default to undefined)
+let grupo: string; //Filtrar por grupo (optional) (default to undefined)
+let type: 'text' | 'uuid' | 'html' | 'url' | 'path_url' | 'integer' | 'double' | 'file' | 'json' | 'date' | 'datetime'; //Filtrar por tipo (optional) (default to undefined)
+let perPage: number; //Itens por página (optional) (default to 15)
+
+const { status, data } = await apiInstance.adminPromotionConfigsIndex(
+    promotionId,
+    key,
+    grupo,
+    type,
+    perPage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
+| **key** | [**string**] | Filtrar por chave (busca parcial) | (optional) defaults to undefined|
+| **grupo** | [**string**] | Filtrar por grupo | (optional) defaults to undefined|
+| **type** | [**&#39;text&#39; | &#39;uuid&#39; | &#39;html&#39; | &#39;url&#39; | &#39;path_url&#39; | &#39;integer&#39; | &#39;double&#39; | &#39;file&#39; | &#39;json&#39; | &#39;date&#39; | &#39;datetime&#39;**]**Array<&#39;text&#39; &#124; &#39;uuid&#39; &#124; &#39;html&#39; &#124; &#39;url&#39; &#124; &#39;path_url&#39; &#124; &#39;integer&#39; &#124; &#39;double&#39; &#124; &#39;file&#39; &#124; &#39;json&#39; &#124; &#39;date&#39; &#124; &#39;datetime&#39;>** | Filtrar por tipo | (optional) defaults to undefined|
+| **perPage** | [**number**] | Itens por página | (optional) defaults to 15|
+
+
+### Return type
+
+**AdminPromotionConfigsIndex200Response**
+
+### 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 |  -  |
+|**500** | 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)
+
+# **adminPromotionConfigsShow**
+> AdminPromotionConfigsShow200Response adminPromotionConfigsShow()
+
+
+### Example
+
+```typescript
+import {
+    ConfigsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigsApi(configuration);
+
+let promotionId: string; //UUID da promoção (default to undefined)
+let key: string; //Chave da configuração (default to undefined)
+
+const { status, data } = await apiInstance.adminPromotionConfigsShow(
+    promotionId,
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
+| **key** | [**string**] | Chave da configuração | defaults to undefined|
+
+
+### Return type
+
+**AdminPromotionConfigsShow200Response**
+
+### 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 |  -  |
+|**404** | not found |  -  |
+
+[[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)
+
+# **adminPromotionConfigsStore**
+> AdminPromotionConfigsStore201Response adminPromotionConfigsStore(adminPromotionConfigsStoreRequest)
+
+
+### Example
+
+```typescript
+import {
+    ConfigsApi,
+    Configuration,
+    AdminPromotionConfigsStoreRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigsApi(configuration);
+
+let promotionId: string; //UUID da promoção (default to undefined)
+let adminPromotionConfigsStoreRequest: AdminPromotionConfigsStoreRequest; //
+
+const { status, data } = await apiInstance.adminPromotionConfigsStore(
+    promotionId,
+    adminPromotionConfigsStoreRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminPromotionConfigsStoreRequest** | **AdminPromotionConfigsStoreRequest**|  | |
+| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AdminPromotionConfigsStore201Response**
+
+### 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 |  -  |
+|**422** | Validation error |  -  |
+|**500** | 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)
+
+# **adminPromotionConfigsUpdate**
+> AdminPromotionConfigsUpdate200Response adminPromotionConfigsUpdate(adminPromotionConfigsUpdateRequest)
+
+
+### Example
+
+```typescript
+import {
+    ConfigsApi,
+    Configuration,
+    AdminPromotionConfigsUpdateRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigsApi(configuration);
+
+let promotionId: string; //UUID da promoção (default to undefined)
+let key: string; //Chave da configuração (default to undefined)
+let adminPromotionConfigsUpdateRequest: AdminPromotionConfigsUpdateRequest; //
+
+const { status, data } = await apiInstance.adminPromotionConfigsUpdate(
+    promotionId,
+    key,
+    adminPromotionConfigsUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminPromotionConfigsUpdateRequest** | **AdminPromotionConfigsUpdateRequest**|  | |
+| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
+| **key** | [**string**] | Chave da configuração | defaults to undefined|
+
+
+### Return type
+
+**AdminPromotionConfigsUpdate200Response**
+
+### 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 |  -  |
+|**404** | not found |  -  |
+
+[[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)
+
+# **adminPromotionConfigsUpsert**
+> AdminPromotionConfigsUpsert200Response adminPromotionConfigsUpsert(adminPromotionConfigsStoreRequest)
+
+
+### Example
+
+```typescript
+import {
+    ConfigsApi,
+    Configuration,
+    AdminPromotionConfigsStoreRequest
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigsApi(configuration);
+
+let promotionId: string; //UUID da promoção (default to undefined)
+let adminPromotionConfigsStoreRequest: AdminPromotionConfigsStoreRequest; //
+
+const { status, data } = await apiInstance.adminPromotionConfigsUpsert(
+    promotionId,
+    adminPromotionConfigsStoreRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminPromotionConfigsStoreRequest** | **AdminPromotionConfigsStoreRequest**|  | |
+| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AdminPromotionConfigsUpsert200Response**
+
+### 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)
+
+# **adminPromotionConfigsValidKeys**
+> AdminPromotionConfigsValidKeys200Response adminPromotionConfigsValidKeys()
+
+
+### Example
+
+```typescript
+import {
+    ConfigsApi,
+    Configuration
+} from '@handsondigital/idplugger-admin';
+
+const configuration = new Configuration();
+const apiInstance = new ConfigsApi(configuration);
+
+let promotionId: string; //UUID da promoção (default to undefined)
+
+const { status, data } = await apiInstance.adminPromotionConfigsValidKeys(
+    promotionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
+
+
+### Return type
+
+**AdminPromotionConfigsValidKeys200Response**
+
+### 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 |  -  |
+
+[[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)
+