@handsondigital/idplugger-admin 2.6.2 → 2.7.1

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)