@handsondigital/idplugger-admin 2.2.4 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/README.md +9 -2
- package/api.ts +441 -0
- package/dist/api.d.ts +315 -0
- package/dist/api.js +261 -1
- package/docs/AdminServiceCustomerBrands200Response.md +26 -0
- package/docs/AdminServiceCustomerBrands200ResponseContentInner.md +24 -0
- package/docs/AdminServiceCustomerClients200Response.md +26 -0
- package/docs/AdminServiceCustomerClients200ResponseContentInner.md +26 -0
- package/docs/AdminServiceCustomerClients200ResponsePaging.md +26 -0
- package/docs/CustomerServiceApi.md +129 -0
- package/package.json +1 -1
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AdminServiceCustomerClients200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**entity** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**action** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**content** | [**Array<AdminServiceCustomerClients200ResponseContentInner>**](AdminServiceCustomerClients200ResponseContentInner.md) | | [optional] [default to undefined]
|
|
11
|
+
**paging** | [**AdminServiceCustomerClients200ResponsePaging**](AdminServiceCustomerClients200ResponsePaging.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminServiceCustomerClients200Response } from '@handsondigital/idplugger-admin';
|
|
17
|
+
|
|
18
|
+
const instance: AdminServiceCustomerClients200Response = {
|
|
19
|
+
entity,
|
|
20
|
+
action,
|
|
21
|
+
content,
|
|
22
|
+
paging,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AdminServiceCustomerClients200ResponseContentInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**nome_fantasia** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**razao_social** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**cnpj_cpf** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminServiceCustomerClients200ResponseContentInner } from '@handsondigital/idplugger-admin';
|
|
17
|
+
|
|
18
|
+
const instance: AdminServiceCustomerClients200ResponseContentInner = {
|
|
19
|
+
id,
|
|
20
|
+
nome_fantasia,
|
|
21
|
+
razao_social,
|
|
22
|
+
cnpj_cpf,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AdminServiceCustomerClients200ResponsePaging
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**current_page** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**last_page** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**per_page** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**total** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminServiceCustomerClients200ResponsePaging } from '@handsondigital/idplugger-admin';
|
|
17
|
+
|
|
18
|
+
const instance: AdminServiceCustomerClients200ResponsePaging = {
|
|
19
|
+
current_page,
|
|
20
|
+
last_page,
|
|
21
|
+
per_page,
|
|
22
|
+
total,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# CustomerServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.idplugger.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**adminServiceCustomerBrands**](#adminservicecustomerbrands) | **GET** /admin/service/customer/brands/{client_id} | Listar marcas de um cliente do serviço de atendimento ao cliente|
|
|
8
|
+
|[**adminServiceCustomerClients**](#adminservicecustomerclients) | **GET** /admin/service/customer/clients | Listar clientes do serviço de atendimento ao cliente|
|
|
9
|
+
|
|
10
|
+
# **adminServiceCustomerBrands**
|
|
11
|
+
> AdminServiceCustomerBrands200Response adminServiceCustomerBrands()
|
|
12
|
+
|
|
13
|
+
Retorna uma lista de marcas de um cliente específico obtidas do serviço de atendimento ao cliente.
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
CustomerServiceApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@handsondigital/idplugger-admin';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new CustomerServiceApi(configuration);
|
|
25
|
+
|
|
26
|
+
let clientId: string; //ID do cliente (default to undefined)
|
|
27
|
+
let search: string; //Termo de busca (optional) (default to undefined)
|
|
28
|
+
let page: number; //Número da página (optional) (default to 1)
|
|
29
|
+
let perPage: number; //Itens por página (optional) (default to 15)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.adminServiceCustomerBrands(
|
|
32
|
+
clientId,
|
|
33
|
+
search,
|
|
34
|
+
page,
|
|
35
|
+
perPage
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **clientId** | [**string**] | ID do cliente | defaults to undefined|
|
|
44
|
+
| **search** | [**string**] | Termo de busca | (optional) defaults to undefined|
|
|
45
|
+
| **page** | [**number**] | Número da página | (optional) defaults to 1|
|
|
46
|
+
| **perPage** | [**number**] | Itens por página | (optional) defaults to 15|
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
**AdminServiceCustomerBrands200Response**
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: Not defined
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Sucesso | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
70
|
+
# **adminServiceCustomerClients**
|
|
71
|
+
> AdminServiceCustomerClients200Response adminServiceCustomerClients()
|
|
72
|
+
|
|
73
|
+
Retorna uma lista de clientes obtidos do serviço de atendimento ao cliente.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
CustomerServiceApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from '@handsondigital/idplugger-admin';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new CustomerServiceApi(configuration);
|
|
85
|
+
|
|
86
|
+
let search: string; //Termo de busca (optional) (default to undefined)
|
|
87
|
+
let isActive: boolean; //Filtrar por clientes ativos (padrão true) (optional) (default to true)
|
|
88
|
+
let page: number; //Número da página (optional) (default to 1)
|
|
89
|
+
let perPage: number; //Itens por página (optional) (default to 15)
|
|
90
|
+
|
|
91
|
+
const { status, data } = await apiInstance.adminServiceCustomerClients(
|
|
92
|
+
search,
|
|
93
|
+
isActive,
|
|
94
|
+
page,
|
|
95
|
+
perPage
|
|
96
|
+
);
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
|Name | Type | Description | Notes|
|
|
102
|
+
|------------- | ------------- | ------------- | -------------|
|
|
103
|
+
| **search** | [**string**] | Termo de busca | (optional) defaults to undefined|
|
|
104
|
+
| **isActive** | [**boolean**] | Filtrar por clientes ativos (padrão true) | (optional) defaults to true|
|
|
105
|
+
| **page** | [**number**] | Número da página | (optional) defaults to 1|
|
|
106
|
+
| **perPage** | [**number**] | Itens por página | (optional) defaults to 15|
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### Return type
|
|
110
|
+
|
|
111
|
+
**AdminServiceCustomerClients200Response**
|
|
112
|
+
|
|
113
|
+
### Authorization
|
|
114
|
+
|
|
115
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
116
|
+
|
|
117
|
+
### HTTP request headers
|
|
118
|
+
|
|
119
|
+
- **Content-Type**: Not defined
|
|
120
|
+
- **Accept**: application/json
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
### HTTP response details
|
|
124
|
+
| Status code | Description | Response headers |
|
|
125
|
+
|-------------|-------------|------------------|
|
|
126
|
+
|**200** | Sucesso | - |
|
|
127
|
+
|
|
128
|
+
[[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)
|
|
129
|
+
|