@handsondigital/idplugger-promotion 1.0.0

package/docs/StoresApi.md

@@ -0,0 +1,242 @@
+# StoresApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**storesCreate**](#storescreate) | **POST** /v3/promotion/{promotion_id}/stores | Cadastra uma loja na promoção|
+|[**storesDelete**](#storesdelete) | **DELETE** /v3/promotion/{promotion_id}/stores/{store_id} | Exclui um produto cadastrado na promoção|
+|[**storesIndex**](#storesindex) | **GET** /v3/promotion/{promotion_id}/stores | Busca por lojas cadastradas na promoção|
+|[**storesUpdate**](#storesupdate) | **PATCH** /v3/promotion/{promotion_id}/stores | Cadastra ou atualiza lojas na promoção|
+
+# **storesCreate**
+> StoresCreate200Response storesCreate()
+
+
+### Example
+
+```typescript
+import {
+    StoresApi,
+    Configuration,
+    StoresCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new StoresApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let storesCreateRequest: StoresCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.storesCreate(
+    promotionId,
+    storesCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **storesCreateRequest** | **StoresCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**StoresCreate200Response**
+
+### 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 |  -  |
+|**401** | unauthorized |  -  |
+|**409** | 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)
+
+# **storesDelete**
+> StoresDelete200Response storesDelete()
+
+
+### Example
+
+```typescript
+import {
+    StoresApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new StoresApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let storeId: string; //ID da loja (default to undefined)
+
+const { status, data } = await apiInstance.storesDelete(
+    promotionId,
+    storeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **storeId** | [**string**] | ID da loja | defaults to undefined|
+
+
+### Return type
+
+**StoresDelete200Response**
+
+### 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)
+
+# **storesIndex**
+> StoresIndex200Response storesIndex()
+
+
+### Example
+
+```typescript
+import {
+    StoresApi,
+    Configuration
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new StoresApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let fields: string; //Campos a serem retornados (optional) (default to undefined)
+let include: string; //Associações a serem retornadas (optional) (default to undefined)
+let id: string; //Id da loja (optional) (default to undefined)
+let cnpj: string; //CNPJ da loja (optional) (default to undefined)
+
+const { status, data } = await apiInstance.storesIndex(
+    promotionId,
+    fields,
+    include,
+    id,
+    cnpj
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+| **fields** | [**string**] | Campos a serem retornados | (optional) defaults to undefined|
+| **include** | [**string**] | Associações a serem retornadas | (optional) defaults to undefined|
+| **id** | [**string**] | Id da loja | (optional) defaults to undefined|
+| **cnpj** | [**string**] | CNPJ da loja | (optional) defaults to undefined|
+
+
+### Return type
+
+**StoresIndex200Response**
+
+### 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)
+
+# **storesUpdate**
+> StoresUpdate201Response storesUpdate()
+
+
+### Example
+
+```typescript
+import {
+    StoresApi,
+    Configuration,
+    StoresCreateRequest
+} from '@handsondigital/idplugger-promotion';
+
+const configuration = new Configuration();
+const apiInstance = new StoresApi(configuration);
+
+let promotionId: string; //ID da promoção (default to undefined)
+let storesCreateRequest: StoresCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.storesUpdate(
+    promotionId,
+    storesCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **storesCreateRequest** | **StoresCreateRequest**|  | |
+| **promotionId** | [**string**] | ID da promoção | defaults to undefined|
+
+
+### Return type
+
+**StoresUpdate201Response**
+
+### 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 |  -  |
+|**401** | unauthorized |  -  |
+|**409** | 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)
+

package/docs/StoresCreate200Response.md

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,48 @@
+# Ticket
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**parent_id** | **number** |  | [optional] [default to undefined]
+**user_from_id** | **number** |  | [optional] [default to undefined]
+**user_to_id** | **number** |  | [optional] [default to undefined]
+**source_id** | **number** |  | [optional] [default to undefined]
+**assunto** | **string** |  | [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**content** | **string** |  | [optional] [default to undefined]
+**_private** | **number** |  | [optional] [default to undefined]
+**status** | **number** |  | [optional] [default to undefined]
+**tipo** | **string** |  | [optional] [default to undefined]
+**last_user_id** | **number** |  | [optional] [default to undefined]
+**last_update** | **string** |  | [optional] [default to undefined]
+**imagem** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Ticket } from '@handsondigital/idplugger-promotion';
+
+const instance: Ticket = {
+    id,
+    parent_id,
+    user_from_id,
+    user_to_id,
+    source_id,
+    assunto,
+    title,
+    content,
+    _private,
+    status,
+    tipo,
+    last_user_id,
+    last_update,
+    imagem,
+    created_at,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)