@pidginhost/sdk 0.3.0 → 0.5.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 +1 -0
- package/.openapi-generator/VERSION +1 -1
- package/CHANGELOG.md +62 -0
- package/README.md +6 -219
- package/api.ts +11342 -26967
- package/dist/api.d.ts +676 -7136
- package/dist/api.js +10749 -25515
- package/dist/esm/api.d.ts +676 -7136
- package/dist/esm/api.js +11032 -25798
- package/docs/AccountApi.md +142 -1138
- package/docs/AuthApi.md +0 -97
- package/docs/BillingApi.md +134 -1073
- package/docs/CloudApi.md +904 -4985
- package/docs/ClusterAdd.md +2 -0
- package/docs/ClusterDetail.md +8 -0
- package/docs/DedicatedApi.md +0 -272
- package/docs/DomainApi.md +144 -1164
- package/docs/FreednsApi.md +0 -324
- package/docs/HardwareGeneration.md +34 -0
- package/docs/HostingApi.md +0 -160
- package/docs/KubeVersionEnum.md +4 -4
- package/docs/KubernetesApi.md +534 -3739
- package/docs/PatchedClusterDetail.md +8 -0
- package/docs/PatchedResourcePool.md +2 -0
- package/docs/PatchedServerDetail.md +2 -0
- package/docs/ResourcePool.md +2 -0
- package/docs/ResourcePoolAdd.md +2 -0
- package/docs/SchemaApi.md +0 -55
- package/docs/Server.md +2 -0
- package/docs/ServerAdd.md +2 -0
- package/docs/ServerDetail.md +2 -0
- package/docs/SupportApi.md +0 -417
- package/package.json +1 -1
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **number** | | [optional] [readonly] [default to undefined]
|
|
9
9
|
**status** | [**StatusA57Enum**](StatusA57Enum.md) | | [optional] [readonly] [default to undefined]
|
|
10
10
|
**name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**generation** | **string** | | [optional] [readonly] [default to undefined]
|
|
11
12
|
**cluster_type** | **string** | | [optional] [readonly] [default to undefined]
|
|
12
13
|
**kube_version** | **string** | | [optional] [readonly] [default to undefined]
|
|
13
14
|
**price_per_month** | **string** | | [optional] [default to undefined]
|
|
@@ -20,6 +21,9 @@ Name | Type | Description | Notes
|
|
|
20
21
|
**talos_version** | **string** | | [optional] [readonly] [default to undefined]
|
|
21
22
|
**talos_upgrade_available** | **string** | | [optional] [readonly] [default to undefined]
|
|
22
23
|
**talos_next_version** | **string** | | [optional] [readonly] [default to undefined]
|
|
24
|
+
**storage_quota_gb** | **string** | | [optional] [readonly] [default to undefined]
|
|
25
|
+
**last_pool_used_bytes** | **string** | | [optional] [readonly] [default to undefined]
|
|
26
|
+
**last_storage_sync_at** | **string** | | [optional] [readonly] [default to undefined]
|
|
23
27
|
|
|
24
28
|
## Example
|
|
25
29
|
|
|
@@ -30,6 +34,7 @@ const instance: PatchedClusterDetail = {
|
|
|
30
34
|
id,
|
|
31
35
|
status,
|
|
32
36
|
name,
|
|
37
|
+
generation,
|
|
33
38
|
cluster_type,
|
|
34
39
|
kube_version,
|
|
35
40
|
price_per_month,
|
|
@@ -42,6 +47,9 @@ const instance: PatchedClusterDetail = {
|
|
|
42
47
|
talos_version,
|
|
43
48
|
talos_upgrade_available,
|
|
44
49
|
talos_next_version,
|
|
50
|
+
storage_quota_gb,
|
|
51
|
+
last_pool_used_bytes,
|
|
52
|
+
last_storage_sync_at,
|
|
45
53
|
};
|
|
46
54
|
```
|
|
47
55
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **number** | | [optional] [readonly] [default to undefined]
|
|
9
9
|
**_package** | **string** | | [optional] [readonly] [default to undefined]
|
|
10
|
+
**generation** | **string** | | [optional] [readonly] [default to undefined]
|
|
10
11
|
**size** | **string** | | [optional] [readonly] [default to undefined]
|
|
11
12
|
**nodes** | [**Array<ResourcePoolNode>**](ResourcePoolNode.md) | | [optional] [readonly] [default to undefined]
|
|
12
13
|
**new_size** | **number** | | [optional] [default to undefined]
|
|
@@ -19,6 +20,7 @@ import { PatchedResourcePool } from '@pidginhost/sdk';
|
|
|
19
20
|
const instance: PatchedResourcePool = {
|
|
20
21
|
id,
|
|
21
22
|
_package,
|
|
23
|
+
generation,
|
|
22
24
|
size,
|
|
23
25
|
nodes,
|
|
24
26
|
new_size,
|
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**cpus** | **number** | | [optional] [readonly] [default to undefined]
|
|
14
14
|
**memory** | **number** | | [optional] [readonly] [default to undefined]
|
|
15
15
|
**disk_size** | **number** | | [optional] [readonly] [default to undefined]
|
|
16
|
+
**generation** | **string** | | [optional] [readonly] [default to undefined]
|
|
16
17
|
**machine** | **{ [key: string]: any; }** | | [optional] [readonly] [default to undefined]
|
|
17
18
|
**volumes** | [**Array<Volume>**](Volume.md) | | [optional] [readonly] [default to undefined]
|
|
18
19
|
**networks** | **{ [key: string]: any; }** | | [optional] [readonly] [default to undefined]
|
|
@@ -36,6 +37,7 @@ const instance: PatchedServerDetail = {
|
|
|
36
37
|
cpus,
|
|
37
38
|
memory,
|
|
38
39
|
disk_size,
|
|
40
|
+
generation,
|
|
39
41
|
machine,
|
|
40
42
|
volumes,
|
|
41
43
|
networks,
|
package/docs/ResourcePool.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **number** | | [readonly] [default to undefined]
|
|
9
9
|
**_package** | **string** | | [readonly] [default to undefined]
|
|
10
|
+
**generation** | **string** | | [readonly] [default to undefined]
|
|
10
11
|
**size** | **string** | | [readonly] [default to undefined]
|
|
11
12
|
**nodes** | [**Array<ResourcePoolNode>**](ResourcePoolNode.md) | | [readonly] [default to undefined]
|
|
12
13
|
**new_size** | **number** | | [optional] [default to undefined]
|
|
@@ -19,6 +20,7 @@ import { ResourcePool } from '@pidginhost/sdk';
|
|
|
19
20
|
const instance: ResourcePool = {
|
|
20
21
|
id,
|
|
21
22
|
_package,
|
|
23
|
+
generation,
|
|
22
24
|
size,
|
|
23
25
|
nodes,
|
|
24
26
|
new_size,
|
package/docs/ResourcePoolAdd.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**resource_pool_package** | **string** | ID or slug | [default to undefined]
|
|
9
9
|
**resource_pool_size** | **number** | | [default to undefined]
|
|
10
|
+
**generation** | **string** | | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { ResourcePoolAdd } from '@pidginhost/sdk';
|
|
|
16
17
|
const instance: ResourcePoolAdd = {
|
|
17
18
|
resource_pool_package,
|
|
18
19
|
resource_pool_size,
|
|
20
|
+
generation,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
package/docs/SchemaApi.md
CHANGED
|
@@ -5,7 +5,6 @@ All URIs are relative to *https://www.pidginhost.com*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**schemaRetrieve**](#schemaretrieve) | **GET** /api/schema/ | |
|
|
8
|
-
|[**schemaRetrieve2**](#schemaretrieve2) | **GET** /api/v1/schema/ | |
|
|
9
8
|
|
|
10
9
|
# **schemaRetrieve**
|
|
11
10
|
> { [key: string]: any; } schemaRetrieve()
|
|
@@ -61,57 +60,3 @@ const { status, data } = await apiInstance.schemaRetrieve(
|
|
|
61
60
|
|
|
62
61
|
[[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)
|
|
63
62
|
|
|
64
|
-
# **schemaRetrieve2**
|
|
65
|
-
> { [key: string]: any; } schemaRetrieve2()
|
|
66
|
-
|
|
67
|
-
OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
|
|
68
|
-
|
|
69
|
-
### Example
|
|
70
|
-
|
|
71
|
-
```typescript
|
|
72
|
-
import {
|
|
73
|
-
SchemaApi,
|
|
74
|
-
Configuration
|
|
75
|
-
} from '@pidginhost/sdk';
|
|
76
|
-
|
|
77
|
-
const configuration = new Configuration();
|
|
78
|
-
const apiInstance = new SchemaApi(configuration);
|
|
79
|
-
|
|
80
|
-
let format: 'json' | 'yaml'; // (optional) (default to undefined)
|
|
81
|
-
let lang: 'en' | 'ro'; // (optional) (default to undefined)
|
|
82
|
-
|
|
83
|
-
const { status, data } = await apiInstance.schemaRetrieve2(
|
|
84
|
-
format,
|
|
85
|
-
lang
|
|
86
|
-
);
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### Parameters
|
|
90
|
-
|
|
91
|
-
|Name | Type | Description | Notes|
|
|
92
|
-
|------------- | ------------- | ------------- | -------------|
|
|
93
|
-
| **format** | [**'json' | 'yaml'**]**Array<'json' | 'yaml'>** | | (optional) defaults to undefined|
|
|
94
|
-
| **lang** | [**'en' | 'ro'**]**Array<'en' | 'ro'>** | | (optional) defaults to undefined|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
### Return type
|
|
98
|
-
|
|
99
|
-
**{ [key: string]: any; }**
|
|
100
|
-
|
|
101
|
-
### Authorization
|
|
102
|
-
|
|
103
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
104
|
-
|
|
105
|
-
### HTTP request headers
|
|
106
|
-
|
|
107
|
-
- **Content-Type**: Not defined
|
|
108
|
-
- **Accept**: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, application/json
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
### HTTP response details
|
|
112
|
-
| Status code | Description | Response headers |
|
|
113
|
-
|-------------|-------------|------------------|
|
|
114
|
-
|**200** | | - |
|
|
115
|
-
|
|
116
|
-
[[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)
|
|
117
|
-
|
package/docs/Server.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**cpus** | **number** | | [readonly] [default to undefined]
|
|
14
14
|
**memory** | **number** | | [readonly] [default to undefined]
|
|
15
15
|
**disk_size** | **number** | | [readonly] [default to undefined]
|
|
16
|
+
**generation** | **string** | | [readonly] [default to undefined]
|
|
16
17
|
**status** | [**StatusA57Enum**](StatusA57Enum.md) | | [optional] [default to undefined]
|
|
17
18
|
**destroy_protection** | **boolean** | Prevents the server from being destroyed until disabled. | [readonly] [default to undefined]
|
|
18
19
|
**ha_enabled** | **boolean** | Enables Proxmox HA — automatic restart and migration on node failure. | [readonly] [default to undefined]
|
|
@@ -32,6 +33,7 @@ const instance: Server = {
|
|
|
32
33
|
cpus,
|
|
33
34
|
memory,
|
|
34
35
|
disk_size,
|
|
36
|
+
generation,
|
|
35
37
|
status,
|
|
36
38
|
destroy_protection,
|
|
37
39
|
ha_enabled,
|
package/docs/ServerAdd.md
CHANGED
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**extra_volume_size** | **number** | | [optional] [default to 0]
|
|
26
26
|
**no_network_acknowledged** | **boolean** | | [optional] [default to undefined]
|
|
27
27
|
**enable_ha** | **boolean** | | [optional] [default to false]
|
|
28
|
+
**generation** | **string** | | [optional] [default to undefined]
|
|
28
29
|
|
|
29
30
|
## Example
|
|
30
31
|
|
|
@@ -52,6 +53,7 @@ const instance: ServerAdd = {
|
|
|
52
53
|
extra_volume_size,
|
|
53
54
|
no_network_acknowledged,
|
|
54
55
|
enable_ha,
|
|
56
|
+
generation,
|
|
55
57
|
};
|
|
56
58
|
```
|
|
57
59
|
|
package/docs/ServerDetail.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**cpus** | **number** | | [readonly] [default to undefined]
|
|
14
14
|
**memory** | **number** | | [readonly] [default to undefined]
|
|
15
15
|
**disk_size** | **number** | | [readonly] [default to undefined]
|
|
16
|
+
**generation** | **string** | | [readonly] [default to undefined]
|
|
16
17
|
**machine** | **{ [key: string]: any; }** | | [readonly] [default to undefined]
|
|
17
18
|
**volumes** | [**Array<Volume>**](Volume.md) | | [readonly] [default to undefined]
|
|
18
19
|
**networks** | **{ [key: string]: any; }** | | [readonly] [default to undefined]
|
|
@@ -36,6 +37,7 @@ const instance: ServerDetail = {
|
|
|
36
37
|
cpus,
|
|
37
38
|
memory,
|
|
38
39
|
disk_size,
|
|
40
|
+
generation,
|
|
39
41
|
machine,
|
|
40
42
|
volumes,
|
|
41
43
|
networks,
|
package/docs/SupportApi.md
CHANGED
|
@@ -5,21 +5,13 @@ All URIs are relative to *https://www.pidginhost.com*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**supportDepartmentsList**](#supportdepartmentslist) | **GET** /api/support/departments/ | |
|
|
8
|
-
|[**supportDepartmentsList2**](#supportdepartmentslist2) | **GET** /api/v1/support/departments/ | |
|
|
9
8
|
|[**supportTicketsCloseCreate**](#supportticketsclosecreate) | **POST** /api/support/tickets/{id}/close/ | |
|
|
10
|
-
|[**supportTicketsCloseCreate2**](#supportticketsclosecreate2) | **POST** /api/v1/support/tickets/{id}/close/ | |
|
|
11
9
|
|[**supportTicketsCreate**](#supportticketscreate) | **POST** /api/support/tickets/ | |
|
|
12
|
-
|[**supportTicketsCreate2**](#supportticketscreate2) | **POST** /api/v1/support/tickets/ | |
|
|
13
10
|
|[**supportTicketsList**](#supportticketslist) | **GET** /api/support/tickets/ | |
|
|
14
|
-
|[**supportTicketsList2**](#supportticketslist2) | **GET** /api/v1/support/tickets/ | |
|
|
15
11
|
|[**supportTicketsMessagesAttachmentRetrieve**](#supportticketsmessagesattachmentretrieve) | **GET** /api/support/tickets/{id}/messages/{message_id}/attachment/ | |
|
|
16
|
-
|[**supportTicketsMessagesAttachmentRetrieve2**](#supportticketsmessagesattachmentretrieve2) | **GET** /api/v1/support/tickets/{id}/messages/{message_id}/attachment/ | |
|
|
17
12
|
|[**supportTicketsReopenCreate**](#supportticketsreopencreate) | **POST** /api/support/tickets/{id}/reopen/ | |
|
|
18
|
-
|[**supportTicketsReopenCreate2**](#supportticketsreopencreate2) | **POST** /api/v1/support/tickets/{id}/reopen/ | |
|
|
19
13
|
|[**supportTicketsReplyCreate**](#supportticketsreplycreate) | **POST** /api/support/tickets/{id}/reply/ | |
|
|
20
|
-
|[**supportTicketsReplyCreate2**](#supportticketsreplycreate2) | **POST** /api/v1/support/tickets/{id}/reply/ | |
|
|
21
14
|
|[**supportTicketsRetrieve**](#supportticketsretrieve) | **GET** /api/support/tickets/{id}/ | |
|
|
22
|
-
|[**supportTicketsRetrieve2**](#supportticketsretrieve2) | **GET** /api/v1/support/tickets/{id}/ | |
|
|
23
15
|
|
|
24
16
|
# **supportDepartmentsList**
|
|
25
17
|
> Array<Department> supportDepartmentsList()
|
|
@@ -44,50 +36,6 @@ const { status, data } = await apiInstance.supportDepartmentsList();
|
|
|
44
36
|
This endpoint does not have any parameters.
|
|
45
37
|
|
|
46
38
|
|
|
47
|
-
### Return type
|
|
48
|
-
|
|
49
|
-
**Array<Department>**
|
|
50
|
-
|
|
51
|
-
### Authorization
|
|
52
|
-
|
|
53
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
54
|
-
|
|
55
|
-
### HTTP request headers
|
|
56
|
-
|
|
57
|
-
- **Content-Type**: Not defined
|
|
58
|
-
- **Accept**: application/json
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
### HTTP response details
|
|
62
|
-
| Status code | Description | Response headers |
|
|
63
|
-
|-------------|-------------|------------------|
|
|
64
|
-
|**200** | | - |
|
|
65
|
-
|
|
66
|
-
[[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)
|
|
67
|
-
|
|
68
|
-
# **supportDepartmentsList2**
|
|
69
|
-
> Array<Department> supportDepartmentsList2()
|
|
70
|
-
|
|
71
|
-
List available support departments.
|
|
72
|
-
|
|
73
|
-
### Example
|
|
74
|
-
|
|
75
|
-
```typescript
|
|
76
|
-
import {
|
|
77
|
-
SupportApi,
|
|
78
|
-
Configuration
|
|
79
|
-
} from '@pidginhost/sdk';
|
|
80
|
-
|
|
81
|
-
const configuration = new Configuration();
|
|
82
|
-
const apiInstance = new SupportApi(configuration);
|
|
83
|
-
|
|
84
|
-
const { status, data } = await apiInstance.supportDepartmentsList2();
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Parameters
|
|
88
|
-
This endpoint does not have any parameters.
|
|
89
|
-
|
|
90
|
-
|
|
91
39
|
### Return type
|
|
92
40
|
|
|
93
41
|
**Array<Department>**
|
|
@@ -139,57 +87,6 @@ const { status, data } = await apiInstance.supportTicketsCloseCreate(
|
|
|
139
87
|
| **id** | [**string**] | | defaults to undefined|
|
|
140
88
|
|
|
141
89
|
|
|
142
|
-
### Return type
|
|
143
|
-
|
|
144
|
-
**TicketCloseResponse**
|
|
145
|
-
|
|
146
|
-
### Authorization
|
|
147
|
-
|
|
148
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
149
|
-
|
|
150
|
-
### HTTP request headers
|
|
151
|
-
|
|
152
|
-
- **Content-Type**: Not defined
|
|
153
|
-
- **Accept**: application/json
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
### HTTP response details
|
|
157
|
-
| Status code | Description | Response headers |
|
|
158
|
-
|-------------|-------------|------------------|
|
|
159
|
-
|**200** | | - |
|
|
160
|
-
|
|
161
|
-
[[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)
|
|
162
|
-
|
|
163
|
-
# **supportTicketsCloseCreate2**
|
|
164
|
-
> TicketCloseResponse supportTicketsCloseCreate2()
|
|
165
|
-
|
|
166
|
-
Close a ticket.
|
|
167
|
-
|
|
168
|
-
### Example
|
|
169
|
-
|
|
170
|
-
```typescript
|
|
171
|
-
import {
|
|
172
|
-
SupportApi,
|
|
173
|
-
Configuration
|
|
174
|
-
} from '@pidginhost/sdk';
|
|
175
|
-
|
|
176
|
-
const configuration = new Configuration();
|
|
177
|
-
const apiInstance = new SupportApi(configuration);
|
|
178
|
-
|
|
179
|
-
let id: string; // (default to undefined)
|
|
180
|
-
|
|
181
|
-
const { status, data } = await apiInstance.supportTicketsCloseCreate2(
|
|
182
|
-
id
|
|
183
|
-
);
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
### Parameters
|
|
187
|
-
|
|
188
|
-
|Name | Type | Description | Notes|
|
|
189
|
-
|------------- | ------------- | ------------- | -------------|
|
|
190
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
191
|
-
|
|
192
|
-
|
|
193
90
|
### Return type
|
|
194
91
|
|
|
195
92
|
**TicketCloseResponse**
|
|
@@ -242,58 +139,6 @@ const { status, data } = await apiInstance.supportTicketsCreate(
|
|
|
242
139
|
| **ticketCreate** | **TicketCreate**| | |
|
|
243
140
|
|
|
244
141
|
|
|
245
|
-
### Return type
|
|
246
|
-
|
|
247
|
-
**TicketDetail**
|
|
248
|
-
|
|
249
|
-
### Authorization
|
|
250
|
-
|
|
251
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
252
|
-
|
|
253
|
-
### HTTP request headers
|
|
254
|
-
|
|
255
|
-
- **Content-Type**: application/json
|
|
256
|
-
- **Accept**: application/json
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
### HTTP response details
|
|
260
|
-
| Status code | Description | Response headers |
|
|
261
|
-
|-------------|-------------|------------------|
|
|
262
|
-
|**201** | | - |
|
|
263
|
-
|
|
264
|
-
[[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)
|
|
265
|
-
|
|
266
|
-
# **supportTicketsCreate2**
|
|
267
|
-
> TicketDetail supportTicketsCreate2(ticketCreate)
|
|
268
|
-
|
|
269
|
-
Create a new support ticket.
|
|
270
|
-
|
|
271
|
-
### Example
|
|
272
|
-
|
|
273
|
-
```typescript
|
|
274
|
-
import {
|
|
275
|
-
SupportApi,
|
|
276
|
-
Configuration,
|
|
277
|
-
TicketCreate
|
|
278
|
-
} from '@pidginhost/sdk';
|
|
279
|
-
|
|
280
|
-
const configuration = new Configuration();
|
|
281
|
-
const apiInstance = new SupportApi(configuration);
|
|
282
|
-
|
|
283
|
-
let ticketCreate: TicketCreate; //
|
|
284
|
-
|
|
285
|
-
const { status, data } = await apiInstance.supportTicketsCreate2(
|
|
286
|
-
ticketCreate
|
|
287
|
-
);
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### Parameters
|
|
291
|
-
|
|
292
|
-
|Name | Type | Description | Notes|
|
|
293
|
-
|------------- | ------------- | ------------- | -------------|
|
|
294
|
-
| **ticketCreate** | **TicketCreate**| | |
|
|
295
|
-
|
|
296
|
-
|
|
297
142
|
### Return type
|
|
298
143
|
|
|
299
144
|
**TicketDetail**
|
|
@@ -345,57 +190,6 @@ const { status, data } = await apiInstance.supportTicketsList(
|
|
|
345
190
|
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
346
191
|
|
|
347
192
|
|
|
348
|
-
### Return type
|
|
349
|
-
|
|
350
|
-
**PaginatedTicketListList**
|
|
351
|
-
|
|
352
|
-
### Authorization
|
|
353
|
-
|
|
354
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
355
|
-
|
|
356
|
-
### HTTP request headers
|
|
357
|
-
|
|
358
|
-
- **Content-Type**: Not defined
|
|
359
|
-
- **Accept**: application/json
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
### HTTP response details
|
|
363
|
-
| Status code | Description | Response headers |
|
|
364
|
-
|-------------|-------------|------------------|
|
|
365
|
-
|**200** | | - |
|
|
366
|
-
|
|
367
|
-
[[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)
|
|
368
|
-
|
|
369
|
-
# **supportTicketsList2**
|
|
370
|
-
> PaginatedTicketListList supportTicketsList2()
|
|
371
|
-
|
|
372
|
-
List, create, and manage support tickets.
|
|
373
|
-
|
|
374
|
-
### Example
|
|
375
|
-
|
|
376
|
-
```typescript
|
|
377
|
-
import {
|
|
378
|
-
SupportApi,
|
|
379
|
-
Configuration
|
|
380
|
-
} from '@pidginhost/sdk';
|
|
381
|
-
|
|
382
|
-
const configuration = new Configuration();
|
|
383
|
-
const apiInstance = new SupportApi(configuration);
|
|
384
|
-
|
|
385
|
-
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
386
|
-
|
|
387
|
-
const { status, data } = await apiInstance.supportTicketsList2(
|
|
388
|
-
page
|
|
389
|
-
);
|
|
390
|
-
```
|
|
391
|
-
|
|
392
|
-
### Parameters
|
|
393
|
-
|
|
394
|
-
|Name | Type | Description | Notes|
|
|
395
|
-
|------------- | ------------- | ------------- | -------------|
|
|
396
|
-
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
397
|
-
|
|
398
|
-
|
|
399
193
|
### Return type
|
|
400
194
|
|
|
401
195
|
**PaginatedTicketListList**
|
|
@@ -450,60 +244,6 @@ const { status, data } = await apiInstance.supportTicketsMessagesAttachmentRetri
|
|
|
450
244
|
| **messageId** | [**string**] | | defaults to undefined|
|
|
451
245
|
|
|
452
246
|
|
|
453
|
-
### Return type
|
|
454
|
-
|
|
455
|
-
**File**
|
|
456
|
-
|
|
457
|
-
### Authorization
|
|
458
|
-
|
|
459
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
460
|
-
|
|
461
|
-
### HTTP request headers
|
|
462
|
-
|
|
463
|
-
- **Content-Type**: Not defined
|
|
464
|
-
- **Accept**: application/json
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
### HTTP response details
|
|
468
|
-
| Status code | Description | Response headers |
|
|
469
|
-
|-------------|-------------|------------------|
|
|
470
|
-
|**200** | | - |
|
|
471
|
-
|
|
472
|
-
[[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)
|
|
473
|
-
|
|
474
|
-
# **supportTicketsMessagesAttachmentRetrieve2**
|
|
475
|
-
> File supportTicketsMessagesAttachmentRetrieve2()
|
|
476
|
-
|
|
477
|
-
Download an attachment from a ticket message.
|
|
478
|
-
|
|
479
|
-
### Example
|
|
480
|
-
|
|
481
|
-
```typescript
|
|
482
|
-
import {
|
|
483
|
-
SupportApi,
|
|
484
|
-
Configuration
|
|
485
|
-
} from '@pidginhost/sdk';
|
|
486
|
-
|
|
487
|
-
const configuration = new Configuration();
|
|
488
|
-
const apiInstance = new SupportApi(configuration);
|
|
489
|
-
|
|
490
|
-
let id: string; // (default to undefined)
|
|
491
|
-
let messageId: string; // (default to undefined)
|
|
492
|
-
|
|
493
|
-
const { status, data } = await apiInstance.supportTicketsMessagesAttachmentRetrieve2(
|
|
494
|
-
id,
|
|
495
|
-
messageId
|
|
496
|
-
);
|
|
497
|
-
```
|
|
498
|
-
|
|
499
|
-
### Parameters
|
|
500
|
-
|
|
501
|
-
|Name | Type | Description | Notes|
|
|
502
|
-
|------------- | ------------- | ------------- | -------------|
|
|
503
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
504
|
-
| **messageId** | [**string**] | | defaults to undefined|
|
|
505
|
-
|
|
506
|
-
|
|
507
247
|
### Return type
|
|
508
248
|
|
|
509
249
|
**File**
|
|
@@ -555,57 +295,6 @@ const { status, data } = await apiInstance.supportTicketsReopenCreate(
|
|
|
555
295
|
| **id** | [**string**] | | defaults to undefined|
|
|
556
296
|
|
|
557
297
|
|
|
558
|
-
### Return type
|
|
559
|
-
|
|
560
|
-
**TicketReopenResponse**
|
|
561
|
-
|
|
562
|
-
### Authorization
|
|
563
|
-
|
|
564
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
565
|
-
|
|
566
|
-
### HTTP request headers
|
|
567
|
-
|
|
568
|
-
- **Content-Type**: Not defined
|
|
569
|
-
- **Accept**: application/json
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
### HTTP response details
|
|
573
|
-
| Status code | Description | Response headers |
|
|
574
|
-
|-------------|-------------|------------------|
|
|
575
|
-
|**200** | | - |
|
|
576
|
-
|
|
577
|
-
[[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)
|
|
578
|
-
|
|
579
|
-
# **supportTicketsReopenCreate2**
|
|
580
|
-
> TicketReopenResponse supportTicketsReopenCreate2()
|
|
581
|
-
|
|
582
|
-
Reopen a closed ticket.
|
|
583
|
-
|
|
584
|
-
### Example
|
|
585
|
-
|
|
586
|
-
```typescript
|
|
587
|
-
import {
|
|
588
|
-
SupportApi,
|
|
589
|
-
Configuration
|
|
590
|
-
} from '@pidginhost/sdk';
|
|
591
|
-
|
|
592
|
-
const configuration = new Configuration();
|
|
593
|
-
const apiInstance = new SupportApi(configuration);
|
|
594
|
-
|
|
595
|
-
let id: string; // (default to undefined)
|
|
596
|
-
|
|
597
|
-
const { status, data } = await apiInstance.supportTicketsReopenCreate2(
|
|
598
|
-
id
|
|
599
|
-
);
|
|
600
|
-
```
|
|
601
|
-
|
|
602
|
-
### Parameters
|
|
603
|
-
|
|
604
|
-
|Name | Type | Description | Notes|
|
|
605
|
-
|------------- | ------------- | ------------- | -------------|
|
|
606
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
607
|
-
|
|
608
|
-
|
|
609
298
|
### Return type
|
|
610
299
|
|
|
611
300
|
**TicketReopenResponse**
|
|
@@ -661,61 +350,6 @@ const { status, data } = await apiInstance.supportTicketsReplyCreate(
|
|
|
661
350
|
| **id** | [**string**] | | defaults to undefined|
|
|
662
351
|
|
|
663
352
|
|
|
664
|
-
### Return type
|
|
665
|
-
|
|
666
|
-
**TicketReplyResponse**
|
|
667
|
-
|
|
668
|
-
### Authorization
|
|
669
|
-
|
|
670
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
671
|
-
|
|
672
|
-
### HTTP request headers
|
|
673
|
-
|
|
674
|
-
- **Content-Type**: application/json
|
|
675
|
-
- **Accept**: application/json
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
### HTTP response details
|
|
679
|
-
| Status code | Description | Response headers |
|
|
680
|
-
|-------------|-------------|------------------|
|
|
681
|
-
|**201** | | - |
|
|
682
|
-
|
|
683
|
-
[[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)
|
|
684
|
-
|
|
685
|
-
# **supportTicketsReplyCreate2**
|
|
686
|
-
> TicketReplyResponse supportTicketsReplyCreate2(ticketReply)
|
|
687
|
-
|
|
688
|
-
Reply to a ticket.
|
|
689
|
-
|
|
690
|
-
### Example
|
|
691
|
-
|
|
692
|
-
```typescript
|
|
693
|
-
import {
|
|
694
|
-
SupportApi,
|
|
695
|
-
Configuration,
|
|
696
|
-
TicketReply
|
|
697
|
-
} from '@pidginhost/sdk';
|
|
698
|
-
|
|
699
|
-
const configuration = new Configuration();
|
|
700
|
-
const apiInstance = new SupportApi(configuration);
|
|
701
|
-
|
|
702
|
-
let id: string; // (default to undefined)
|
|
703
|
-
let ticketReply: TicketReply; //
|
|
704
|
-
|
|
705
|
-
const { status, data } = await apiInstance.supportTicketsReplyCreate2(
|
|
706
|
-
id,
|
|
707
|
-
ticketReply
|
|
708
|
-
);
|
|
709
|
-
```
|
|
710
|
-
|
|
711
|
-
### Parameters
|
|
712
|
-
|
|
713
|
-
|Name | Type | Description | Notes|
|
|
714
|
-
|------------- | ------------- | ------------- | -------------|
|
|
715
|
-
| **ticketReply** | **TicketReply**| | |
|
|
716
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
717
|
-
|
|
718
|
-
|
|
719
353
|
### Return type
|
|
720
354
|
|
|
721
355
|
**TicketReplyResponse**
|
|
@@ -788,54 +422,3 @@ const { status, data } = await apiInstance.supportTicketsRetrieve(
|
|
|
788
422
|
|
|
789
423
|
[[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)
|
|
790
424
|
|
|
791
|
-
# **supportTicketsRetrieve2**
|
|
792
|
-
> TicketDetail supportTicketsRetrieve2()
|
|
793
|
-
|
|
794
|
-
List, create, and manage support tickets.
|
|
795
|
-
|
|
796
|
-
### Example
|
|
797
|
-
|
|
798
|
-
```typescript
|
|
799
|
-
import {
|
|
800
|
-
SupportApi,
|
|
801
|
-
Configuration
|
|
802
|
-
} from '@pidginhost/sdk';
|
|
803
|
-
|
|
804
|
-
const configuration = new Configuration();
|
|
805
|
-
const apiInstance = new SupportApi(configuration);
|
|
806
|
-
|
|
807
|
-
let id: string; // (default to undefined)
|
|
808
|
-
|
|
809
|
-
const { status, data } = await apiInstance.supportTicketsRetrieve2(
|
|
810
|
-
id
|
|
811
|
-
);
|
|
812
|
-
```
|
|
813
|
-
|
|
814
|
-
### Parameters
|
|
815
|
-
|
|
816
|
-
|Name | Type | Description | Notes|
|
|
817
|
-
|------------- | ------------- | ------------- | -------------|
|
|
818
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
### Return type
|
|
822
|
-
|
|
823
|
-
**TicketDetail**
|
|
824
|
-
|
|
825
|
-
### Authorization
|
|
826
|
-
|
|
827
|
-
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
828
|
-
|
|
829
|
-
### HTTP request headers
|
|
830
|
-
|
|
831
|
-
- **Content-Type**: Not defined
|
|
832
|
-
- **Accept**: application/json
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
### HTTP response details
|
|
836
|
-
| Status code | Description | Response headers |
|
|
837
|
-
|-------------|-------------|------------------|
|
|
838
|
-
|**200** | | - |
|
|
839
|
-
|
|
840
|
-
[[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)
|
|
841
|
-
|