kleisterjs 2.7.0 → 2.9.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/.codacy.yml +3 -0
- package/.github/RELEASE +1 -1
- package/.github/settings.yml +3 -0
- package/.openapi-generator/FILES +87 -0
- package/.openapi-generator/VERSION +1 -1
- package/CHANGELOG.md +15 -0
- package/README.md +2 -2
- package/docs/AttachBuildToVersionRequest.md +22 -0
- package/docs/AttachMinecraftToBuildRequest.md +22 -0
- package/docs/AuthApi.md +366 -0
- package/docs/AuthToken.md +22 -0
- package/docs/AuthVerify.md +22 -0
- package/docs/Build.md +59 -0
- package/docs/BuildVersion.md +31 -0
- package/docs/CreateBuildRequest.md +40 -0
- package/docs/CreateGroupRequest.md +22 -0
- package/docs/CreateModRequest.md +34 -0
- package/docs/CreatePackRequest.md +26 -0
- package/docs/CreateUserRequest.md +30 -0
- package/docs/CreateVersionRequest.md +24 -0
- package/docs/DeleteGroupFromModRequest.md +20 -0
- package/docs/DeleteGroupFromPackRequest.md +20 -0
- package/docs/DeletePackFromGroupRequest.md +20 -0
- package/docs/DeletePackFromUserRequest.md +20 -0
- package/docs/Fabric.md +27 -0
- package/docs/FabricApi.md +297 -0
- package/docs/Forge.md +29 -0
- package/docs/ForgeApi.md +297 -0
- package/docs/Group.md +29 -0
- package/docs/GroupApi.md +1050 -0
- package/docs/GroupMod.md +33 -0
- package/docs/GroupPack.md +33 -0
- package/docs/ListBuildVersions200Response.md +30 -0
- package/docs/ListBuilds200Response.md +28 -0
- package/docs/ListFabricBuilds200Response.md +28 -0
- package/docs/ListFabrics200Response.md +26 -0
- package/docs/ListForgeBuilds200Response.md +28 -0
- package/docs/ListForges200Response.md +26 -0
- package/docs/ListGroupMods200Response.md +28 -0
- package/docs/ListGroupPacks200Response.md +28 -0
- package/docs/ListGroupUsers200Response.md +28 -0
- package/docs/ListGroups200Response.md +26 -0
- package/docs/ListMinecraftBuilds200Response.md +28 -0
- package/docs/ListMinecrafts200Response.md +26 -0
- package/docs/ListModGroups200Response.md +28 -0
- package/docs/ListModUsers200Response.md +28 -0
- package/docs/ListMods200Response.md +26 -0
- package/docs/ListNeoforgeBuilds200Response.md +28 -0
- package/docs/ListNeoforges200Response.md +26 -0
- package/docs/ListPackGroups200Response.md +28 -0
- package/docs/ListPackUsers200Response.md +28 -0
- package/docs/ListPacks200Response.md +26 -0
- package/docs/ListProviders200Response.md +22 -0
- package/docs/ListQuiltBuilds200Response.md +28 -0
- package/docs/ListQuilts200Response.md +26 -0
- package/docs/ListUserGroups200Response.md +28 -0
- package/docs/ListUserMods200Response.md +28 -0
- package/docs/ListUserPacks200Response.md +28 -0
- package/docs/ListUsers200Response.md +26 -0
- package/docs/ListVersionBuilds200Response.md +30 -0
- package/docs/ListVersions200Response.md +28 -0
- package/docs/LoginAuthRequest.md +22 -0
- package/docs/Minecraft.md +29 -0
- package/docs/MinecraftApi.md +297 -0
- package/docs/Mod.md +43 -0
- package/docs/ModApi.md +1533 -0
- package/docs/ModAvatar.md +27 -0
- package/docs/Neoforge.md +27 -0
- package/docs/NeoforgeApi.md +297 -0
- package/docs/Notification.md +25 -0
- package/docs/Pack.md +35 -0
- package/docs/PackApi.md +1305 -0
- package/docs/PackAvatar.md +27 -0
- package/docs/PermitGroupModRequest.md +22 -0
- package/docs/PermitGroupPackRequest.md +22 -0
- package/docs/PermitPackGroupRequest.md +22 -0
- package/docs/PermitPackUserRequest.md +22 -0
- package/docs/Profile.md +47 -0
- package/docs/ProfileApi.md +155 -0
- package/docs/Provider.md +27 -0
- package/docs/Quilt.md +27 -0
- package/docs/QuiltApi.md +297 -0
- package/docs/RedirectAuthRequest.md +20 -0
- package/docs/UpdateProfileRequest.md +26 -0
- package/docs/UpdateUserRequest.md +30 -0
- package/docs/User.md +41 -0
- package/docs/UserApi.md +1050 -0
- package/docs/UserAuth.md +27 -0
- package/docs/UserGroup.md +33 -0
- package/docs/UserMod.md +33 -0
- package/docs/UserPack.md +33 -0
- package/docs/Validation.md +23 -0
- package/docs/Version.md +33 -0
- package/docs/VersionFile.md +33 -0
- package/flake.lock +9 -9
- package/openapi.yml +1 -1
- package/package.json +2 -2
package/docs/PackApi.md
ADDED
|
@@ -0,0 +1,1305 @@
|
|
|
1
|
+
# PackApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://try.kleister.eu/api/v1*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**attachBuildToVersion**](#attachbuildtoversion) | **POST** /packs/{pack_id}/builds/{build_id}/versions | Attach a version to a build|
|
|
8
|
+
|[**attachPackToGroup**](#attachpacktogroup) | **POST** /packs/{pack_id}/groups | Attach a group to pack|
|
|
9
|
+
|[**attachPackToUser**](#attachpacktouser) | **POST** /packs/{pack_id}/users | Attach a user to pack|
|
|
10
|
+
|[**createBuild**](#createbuild) | **POST** /packs/{pack_id}/builds | Create a new build for a pack|
|
|
11
|
+
|[**createPack**](#createpack) | **POST** /packs | Create a new pack|
|
|
12
|
+
|[**deleteBuild**](#deletebuild) | **DELETE** /packs/{pack_id}/builds/{build_id} | Delete a specific build for a pack|
|
|
13
|
+
|[**deleteBuildFromVersion**](#deletebuildfromversion) | **DELETE** /packs/{pack_id}/builds/{build_id}/versions | Unlink a version from a build|
|
|
14
|
+
|[**deletePack**](#deletepack) | **DELETE** /packs/{pack_id} | Delete a specific pack|
|
|
15
|
+
|[**deletePackFromGroup**](#deletepackfromgroup) | **DELETE** /packs/{pack_id}/groups | Unlink a group from pack|
|
|
16
|
+
|[**deletePackFromUser**](#deletepackfromuser) | **DELETE** /packs/{pack_id}/users | Unlink a user from pack|
|
|
17
|
+
|[**listBuildVersions**](#listbuildversions) | **GET** /packs/{pack_id}/builds/{build_id}/versions | Fetch all versions attached to build|
|
|
18
|
+
|[**listBuilds**](#listbuilds) | **GET** /packs/{pack_id}/builds | Fetch all available builds for a pack|
|
|
19
|
+
|[**listPackGroups**](#listpackgroups) | **GET** /packs/{pack_id}/groups | Fetch all groups attached to pack|
|
|
20
|
+
|[**listPackUsers**](#listpackusers) | **GET** /packs/{pack_id}/users | Fetch all users attached to pack|
|
|
21
|
+
|[**listPacks**](#listpacks) | **GET** /packs | Fetch all available packs|
|
|
22
|
+
|[**permitPackGroup**](#permitpackgroup) | **PUT** /packs/{pack_id}/groups | Update group perms for pack|
|
|
23
|
+
|[**permitPackUser**](#permitpackuser) | **PUT** /packs/{pack_id}/users | Update user perms for pack|
|
|
24
|
+
|[**showBuild**](#showbuild) | **GET** /packs/{pack_id}/builds/{build_id} | Fetch a specific build for a pack|
|
|
25
|
+
|[**showPack**](#showpack) | **GET** /packs/{pack_id} | Fetch a specific pack|
|
|
26
|
+
|[**updateBuild**](#updatebuild) | **PUT** /packs/{pack_id}/builds/{build_id} | Update a specific build for a pack|
|
|
27
|
+
|[**updatePack**](#updatepack) | **PUT** /packs/{pack_id} | Update a specific pack|
|
|
28
|
+
|
|
29
|
+
# **attachBuildToVersion**
|
|
30
|
+
> Notification attachBuildToVersion(attachBuildToVersionRequest)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Example
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import {
|
|
37
|
+
PackApi,
|
|
38
|
+
Configuration,
|
|
39
|
+
AttachBuildToVersionRequest
|
|
40
|
+
} from 'kleisterjs';
|
|
41
|
+
|
|
42
|
+
const configuration = new Configuration();
|
|
43
|
+
const apiInstance = new PackApi(configuration);
|
|
44
|
+
|
|
45
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
46
|
+
let buildId: string; //A build identifier or slug (default to undefined)
|
|
47
|
+
let attachBuildToVersionRequest: AttachBuildToVersionRequest; //The build version data to create or delete
|
|
48
|
+
|
|
49
|
+
const { status, data } = await apiInstance.attachBuildToVersion(
|
|
50
|
+
packId,
|
|
51
|
+
buildId,
|
|
52
|
+
attachBuildToVersionRequest
|
|
53
|
+
);
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
|Name | Type | Description | Notes|
|
|
59
|
+
|------------- | ------------- | ------------- | -------------|
|
|
60
|
+
| **attachBuildToVersionRequest** | **AttachBuildToVersionRequest**| The build version data to create or delete | |
|
|
61
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
62
|
+
| **buildId** | [**string**] | A build identifier or slug | defaults to undefined|
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
**Notification**
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: application/json
|
|
76
|
+
- **Accept**: application/json
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
### HTTP response details
|
|
80
|
+
| Status code | Description | Response headers |
|
|
81
|
+
|-------------|-------------|------------------|
|
|
82
|
+
|**200** | Plain success message | - |
|
|
83
|
+
|**400** | Failed to parse request | - |
|
|
84
|
+
|**403** | User is not authorized | - |
|
|
85
|
+
|**404** | Resource not found | - |
|
|
86
|
+
|**412** | Resource is already attached | - |
|
|
87
|
+
|**422** | Failed to validate request | - |
|
|
88
|
+
|**500** | Some internal server error | - |
|
|
89
|
+
|
|
90
|
+
[[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)
|
|
91
|
+
|
|
92
|
+
# **attachPackToGroup**
|
|
93
|
+
> Notification attachPackToGroup(permitPackGroupRequest)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Example
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import {
|
|
100
|
+
PackApi,
|
|
101
|
+
Configuration,
|
|
102
|
+
PermitPackGroupRequest
|
|
103
|
+
} from 'kleisterjs';
|
|
104
|
+
|
|
105
|
+
const configuration = new Configuration();
|
|
106
|
+
const apiInstance = new PackApi(configuration);
|
|
107
|
+
|
|
108
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
109
|
+
let permitPackGroupRequest: PermitPackGroupRequest; //The pack group data to permit
|
|
110
|
+
|
|
111
|
+
const { status, data } = await apiInstance.attachPackToGroup(
|
|
112
|
+
packId,
|
|
113
|
+
permitPackGroupRequest
|
|
114
|
+
);
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Parameters
|
|
118
|
+
|
|
119
|
+
|Name | Type | Description | Notes|
|
|
120
|
+
|------------- | ------------- | ------------- | -------------|
|
|
121
|
+
| **permitPackGroupRequest** | **PermitPackGroupRequest**| The pack group data to permit | |
|
|
122
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
### Return type
|
|
126
|
+
|
|
127
|
+
**Notification**
|
|
128
|
+
|
|
129
|
+
### Authorization
|
|
130
|
+
|
|
131
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
132
|
+
|
|
133
|
+
### HTTP request headers
|
|
134
|
+
|
|
135
|
+
- **Content-Type**: application/json
|
|
136
|
+
- **Accept**: application/json
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
### HTTP response details
|
|
140
|
+
| Status code | Description | Response headers |
|
|
141
|
+
|-------------|-------------|------------------|
|
|
142
|
+
|**200** | Plain success message | - |
|
|
143
|
+
|**400** | Failed to parse request | - |
|
|
144
|
+
|**403** | User is not authorized | - |
|
|
145
|
+
|**404** | Resource not found | - |
|
|
146
|
+
|**412** | Resource is already attached | - |
|
|
147
|
+
|**422** | Failed to validate request | - |
|
|
148
|
+
|**500** | Some internal server error | - |
|
|
149
|
+
|
|
150
|
+
[[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)
|
|
151
|
+
|
|
152
|
+
# **attachPackToUser**
|
|
153
|
+
> Notification attachPackToUser(permitPackUserRequest)
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### Example
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
import {
|
|
160
|
+
PackApi,
|
|
161
|
+
Configuration,
|
|
162
|
+
PermitPackUserRequest
|
|
163
|
+
} from 'kleisterjs';
|
|
164
|
+
|
|
165
|
+
const configuration = new Configuration();
|
|
166
|
+
const apiInstance = new PackApi(configuration);
|
|
167
|
+
|
|
168
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
169
|
+
let permitPackUserRequest: PermitPackUserRequest; //The pack user data to permit
|
|
170
|
+
|
|
171
|
+
const { status, data } = await apiInstance.attachPackToUser(
|
|
172
|
+
packId,
|
|
173
|
+
permitPackUserRequest
|
|
174
|
+
);
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
|Name | Type | Description | Notes|
|
|
180
|
+
|------------- | ------------- | ------------- | -------------|
|
|
181
|
+
| **permitPackUserRequest** | **PermitPackUserRequest**| The pack user data to permit | |
|
|
182
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
### Return type
|
|
186
|
+
|
|
187
|
+
**Notification**
|
|
188
|
+
|
|
189
|
+
### Authorization
|
|
190
|
+
|
|
191
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
192
|
+
|
|
193
|
+
### HTTP request headers
|
|
194
|
+
|
|
195
|
+
- **Content-Type**: application/json
|
|
196
|
+
- **Accept**: application/json
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### HTTP response details
|
|
200
|
+
| Status code | Description | Response headers |
|
|
201
|
+
|-------------|-------------|------------------|
|
|
202
|
+
|**200** | Plain success message | - |
|
|
203
|
+
|**400** | Failed to parse request | - |
|
|
204
|
+
|**403** | User is not authorized | - |
|
|
205
|
+
|**404** | Resource not found | - |
|
|
206
|
+
|**412** | Resource is already attached | - |
|
|
207
|
+
|**422** | Failed to validate request | - |
|
|
208
|
+
|**500** | Some internal server error | - |
|
|
209
|
+
|
|
210
|
+
[[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)
|
|
211
|
+
|
|
212
|
+
# **createBuild**
|
|
213
|
+
> Build createBuild(createBuildRequest)
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### Example
|
|
217
|
+
|
|
218
|
+
```typescript
|
|
219
|
+
import {
|
|
220
|
+
PackApi,
|
|
221
|
+
Configuration,
|
|
222
|
+
CreateBuildRequest
|
|
223
|
+
} from 'kleisterjs';
|
|
224
|
+
|
|
225
|
+
const configuration = new Configuration();
|
|
226
|
+
const apiInstance = new PackApi(configuration);
|
|
227
|
+
|
|
228
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
229
|
+
let createBuildRequest: CreateBuildRequest; //The build data to create
|
|
230
|
+
|
|
231
|
+
const { status, data } = await apiInstance.createBuild(
|
|
232
|
+
packId,
|
|
233
|
+
createBuildRequest
|
|
234
|
+
);
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Parameters
|
|
238
|
+
|
|
239
|
+
|Name | Type | Description | Notes|
|
|
240
|
+
|------------- | ------------- | ------------- | -------------|
|
|
241
|
+
| **createBuildRequest** | **CreateBuildRequest**| The build data to create | |
|
|
242
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### Return type
|
|
246
|
+
|
|
247
|
+
**Build**
|
|
248
|
+
|
|
249
|
+
### Authorization
|
|
250
|
+
|
|
251
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
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
|
+
|**200** | The details for a build | - |
|
|
263
|
+
|**400** | Failed to parse request | - |
|
|
264
|
+
|**403** | User is not authorized | - |
|
|
265
|
+
|**404** | Resource not found | - |
|
|
266
|
+
|**422** | Failed to validate request | - |
|
|
267
|
+
|**500** | Some internal server error | - |
|
|
268
|
+
|
|
269
|
+
[[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)
|
|
270
|
+
|
|
271
|
+
# **createPack**
|
|
272
|
+
> Pack createPack(createPackRequest)
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
### Example
|
|
276
|
+
|
|
277
|
+
```typescript
|
|
278
|
+
import {
|
|
279
|
+
PackApi,
|
|
280
|
+
Configuration,
|
|
281
|
+
CreatePackRequest
|
|
282
|
+
} from 'kleisterjs';
|
|
283
|
+
|
|
284
|
+
const configuration = new Configuration();
|
|
285
|
+
const apiInstance = new PackApi(configuration);
|
|
286
|
+
|
|
287
|
+
let createPackRequest: CreatePackRequest; //The pack data to create
|
|
288
|
+
|
|
289
|
+
const { status, data } = await apiInstance.createPack(
|
|
290
|
+
createPackRequest
|
|
291
|
+
);
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Parameters
|
|
295
|
+
|
|
296
|
+
|Name | Type | Description | Notes|
|
|
297
|
+
|------------- | ------------- | ------------- | -------------|
|
|
298
|
+
| **createPackRequest** | **CreatePackRequest**| The pack data to create | |
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
### Return type
|
|
302
|
+
|
|
303
|
+
**Pack**
|
|
304
|
+
|
|
305
|
+
### Authorization
|
|
306
|
+
|
|
307
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
308
|
+
|
|
309
|
+
### HTTP request headers
|
|
310
|
+
|
|
311
|
+
- **Content-Type**: application/json
|
|
312
|
+
- **Accept**: application/json
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### HTTP response details
|
|
316
|
+
| Status code | Description | Response headers |
|
|
317
|
+
|-------------|-------------|------------------|
|
|
318
|
+
|**200** | The details for a pack | - |
|
|
319
|
+
|**400** | Failed to parse request | - |
|
|
320
|
+
|**403** | User is not authorized | - |
|
|
321
|
+
|**422** | Failed to validate request | - |
|
|
322
|
+
|**500** | Some internal server error | - |
|
|
323
|
+
|
|
324
|
+
[[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)
|
|
325
|
+
|
|
326
|
+
# **deleteBuild**
|
|
327
|
+
> Notification deleteBuild()
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Example
|
|
331
|
+
|
|
332
|
+
```typescript
|
|
333
|
+
import {
|
|
334
|
+
PackApi,
|
|
335
|
+
Configuration
|
|
336
|
+
} from 'kleisterjs';
|
|
337
|
+
|
|
338
|
+
const configuration = new Configuration();
|
|
339
|
+
const apiInstance = new PackApi(configuration);
|
|
340
|
+
|
|
341
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
342
|
+
let buildId: string; //A build identifier or slug (default to undefined)
|
|
343
|
+
|
|
344
|
+
const { status, data } = await apiInstance.deleteBuild(
|
|
345
|
+
packId,
|
|
346
|
+
buildId
|
|
347
|
+
);
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Parameters
|
|
351
|
+
|
|
352
|
+
|Name | Type | Description | Notes|
|
|
353
|
+
|------------- | ------------- | ------------- | -------------|
|
|
354
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
355
|
+
| **buildId** | [**string**] | A build identifier or slug | defaults to undefined|
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
### Return type
|
|
359
|
+
|
|
360
|
+
**Notification**
|
|
361
|
+
|
|
362
|
+
### Authorization
|
|
363
|
+
|
|
364
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
365
|
+
|
|
366
|
+
### HTTP request headers
|
|
367
|
+
|
|
368
|
+
- **Content-Type**: Not defined
|
|
369
|
+
- **Accept**: application/json
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
### HTTP response details
|
|
373
|
+
| Status code | Description | Response headers |
|
|
374
|
+
|-------------|-------------|------------------|
|
|
375
|
+
|**200** | Plain success message | - |
|
|
376
|
+
|**403** | User is not authorized | - |
|
|
377
|
+
|**404** | Resource not found | - |
|
|
378
|
+
|**400** | Failed to execute action for resource | - |
|
|
379
|
+
|**500** | Some internal server error | - |
|
|
380
|
+
|
|
381
|
+
[[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)
|
|
382
|
+
|
|
383
|
+
# **deleteBuildFromVersion**
|
|
384
|
+
> Notification deleteBuildFromVersion(attachBuildToVersionRequest)
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
### Example
|
|
388
|
+
|
|
389
|
+
```typescript
|
|
390
|
+
import {
|
|
391
|
+
PackApi,
|
|
392
|
+
Configuration,
|
|
393
|
+
AttachBuildToVersionRequest
|
|
394
|
+
} from 'kleisterjs';
|
|
395
|
+
|
|
396
|
+
const configuration = new Configuration();
|
|
397
|
+
const apiInstance = new PackApi(configuration);
|
|
398
|
+
|
|
399
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
400
|
+
let buildId: string; //A build identifier or slug (default to undefined)
|
|
401
|
+
let attachBuildToVersionRequest: AttachBuildToVersionRequest; //The build version data to create or delete
|
|
402
|
+
|
|
403
|
+
const { status, data } = await apiInstance.deleteBuildFromVersion(
|
|
404
|
+
packId,
|
|
405
|
+
buildId,
|
|
406
|
+
attachBuildToVersionRequest
|
|
407
|
+
);
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
### Parameters
|
|
411
|
+
|
|
412
|
+
|Name | Type | Description | Notes|
|
|
413
|
+
|------------- | ------------- | ------------- | -------------|
|
|
414
|
+
| **attachBuildToVersionRequest** | **AttachBuildToVersionRequest**| The build version data to create or delete | |
|
|
415
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
416
|
+
| **buildId** | [**string**] | A build identifier or slug | defaults to undefined|
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
### Return type
|
|
420
|
+
|
|
421
|
+
**Notification**
|
|
422
|
+
|
|
423
|
+
### Authorization
|
|
424
|
+
|
|
425
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
426
|
+
|
|
427
|
+
### HTTP request headers
|
|
428
|
+
|
|
429
|
+
- **Content-Type**: application/json
|
|
430
|
+
- **Accept**: application/json
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
### HTTP response details
|
|
434
|
+
| Status code | Description | Response headers |
|
|
435
|
+
|-------------|-------------|------------------|
|
|
436
|
+
|**200** | Plain success message | - |
|
|
437
|
+
|**400** | Failed to parse request | - |
|
|
438
|
+
|**403** | User is not authorized | - |
|
|
439
|
+
|**404** | Resource not found | - |
|
|
440
|
+
|**412** | Resource is not attached | - |
|
|
441
|
+
|**500** | Some internal server error | - |
|
|
442
|
+
|
|
443
|
+
[[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)
|
|
444
|
+
|
|
445
|
+
# **deletePack**
|
|
446
|
+
> Notification deletePack()
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
### Example
|
|
450
|
+
|
|
451
|
+
```typescript
|
|
452
|
+
import {
|
|
453
|
+
PackApi,
|
|
454
|
+
Configuration
|
|
455
|
+
} from 'kleisterjs';
|
|
456
|
+
|
|
457
|
+
const configuration = new Configuration();
|
|
458
|
+
const apiInstance = new PackApi(configuration);
|
|
459
|
+
|
|
460
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
461
|
+
|
|
462
|
+
const { status, data } = await apiInstance.deletePack(
|
|
463
|
+
packId
|
|
464
|
+
);
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### Parameters
|
|
468
|
+
|
|
469
|
+
|Name | Type | Description | Notes|
|
|
470
|
+
|------------- | ------------- | ------------- | -------------|
|
|
471
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
### Return type
|
|
475
|
+
|
|
476
|
+
**Notification**
|
|
477
|
+
|
|
478
|
+
### Authorization
|
|
479
|
+
|
|
480
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
481
|
+
|
|
482
|
+
### HTTP request headers
|
|
483
|
+
|
|
484
|
+
- **Content-Type**: Not defined
|
|
485
|
+
- **Accept**: application/json
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
### HTTP response details
|
|
489
|
+
| Status code | Description | Response headers |
|
|
490
|
+
|-------------|-------------|------------------|
|
|
491
|
+
|**200** | Plain success message | - |
|
|
492
|
+
|**403** | User is not authorized | - |
|
|
493
|
+
|**404** | Resource not found | - |
|
|
494
|
+
|**400** | Failed to execute action for resource | - |
|
|
495
|
+
|**500** | Some internal server error | - |
|
|
496
|
+
|
|
497
|
+
[[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)
|
|
498
|
+
|
|
499
|
+
# **deletePackFromGroup**
|
|
500
|
+
> Notification deletePackFromGroup(deletePackFromGroupRequest)
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
### Example
|
|
504
|
+
|
|
505
|
+
```typescript
|
|
506
|
+
import {
|
|
507
|
+
PackApi,
|
|
508
|
+
Configuration,
|
|
509
|
+
DeletePackFromGroupRequest
|
|
510
|
+
} from 'kleisterjs';
|
|
511
|
+
|
|
512
|
+
const configuration = new Configuration();
|
|
513
|
+
const apiInstance = new PackApi(configuration);
|
|
514
|
+
|
|
515
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
516
|
+
let deletePackFromGroupRequest: DeletePackFromGroupRequest; //The pack group data to unlink
|
|
517
|
+
|
|
518
|
+
const { status, data } = await apiInstance.deletePackFromGroup(
|
|
519
|
+
packId,
|
|
520
|
+
deletePackFromGroupRequest
|
|
521
|
+
);
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### Parameters
|
|
525
|
+
|
|
526
|
+
|Name | Type | Description | Notes|
|
|
527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
528
|
+
| **deletePackFromGroupRequest** | **DeletePackFromGroupRequest**| The pack group data to unlink | |
|
|
529
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
### Return type
|
|
533
|
+
|
|
534
|
+
**Notification**
|
|
535
|
+
|
|
536
|
+
### Authorization
|
|
537
|
+
|
|
538
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
539
|
+
|
|
540
|
+
### HTTP request headers
|
|
541
|
+
|
|
542
|
+
- **Content-Type**: application/json
|
|
543
|
+
- **Accept**: application/json
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
### HTTP response details
|
|
547
|
+
| Status code | Description | Response headers |
|
|
548
|
+
|-------------|-------------|------------------|
|
|
549
|
+
|**200** | Plain success message | - |
|
|
550
|
+
|**400** | Failed to parse request | - |
|
|
551
|
+
|**403** | User is not authorized | - |
|
|
552
|
+
|**404** | Resource not found | - |
|
|
553
|
+
|**412** | Resource is not attached | - |
|
|
554
|
+
|**500** | Some internal server error | - |
|
|
555
|
+
|
|
556
|
+
[[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)
|
|
557
|
+
|
|
558
|
+
# **deletePackFromUser**
|
|
559
|
+
> Notification deletePackFromUser(deletePackFromUserRequest)
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
### Example
|
|
563
|
+
|
|
564
|
+
```typescript
|
|
565
|
+
import {
|
|
566
|
+
PackApi,
|
|
567
|
+
Configuration,
|
|
568
|
+
DeletePackFromUserRequest
|
|
569
|
+
} from 'kleisterjs';
|
|
570
|
+
|
|
571
|
+
const configuration = new Configuration();
|
|
572
|
+
const apiInstance = new PackApi(configuration);
|
|
573
|
+
|
|
574
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
575
|
+
let deletePackFromUserRequest: DeletePackFromUserRequest; //The pack user data to unlink
|
|
576
|
+
|
|
577
|
+
const { status, data } = await apiInstance.deletePackFromUser(
|
|
578
|
+
packId,
|
|
579
|
+
deletePackFromUserRequest
|
|
580
|
+
);
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
### Parameters
|
|
584
|
+
|
|
585
|
+
|Name | Type | Description | Notes|
|
|
586
|
+
|------------- | ------------- | ------------- | -------------|
|
|
587
|
+
| **deletePackFromUserRequest** | **DeletePackFromUserRequest**| The pack user data to unlink | |
|
|
588
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
### Return type
|
|
592
|
+
|
|
593
|
+
**Notification**
|
|
594
|
+
|
|
595
|
+
### Authorization
|
|
596
|
+
|
|
597
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
598
|
+
|
|
599
|
+
### HTTP request headers
|
|
600
|
+
|
|
601
|
+
- **Content-Type**: application/json
|
|
602
|
+
- **Accept**: application/json
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
### HTTP response details
|
|
606
|
+
| Status code | Description | Response headers |
|
|
607
|
+
|-------------|-------------|------------------|
|
|
608
|
+
|**200** | Plain success message | - |
|
|
609
|
+
|**400** | Failed to parse request | - |
|
|
610
|
+
|**403** | User is not authorized | - |
|
|
611
|
+
|**404** | Resource not found | - |
|
|
612
|
+
|**412** | Resource is not attached | - |
|
|
613
|
+
|**500** | Some internal server error | - |
|
|
614
|
+
|
|
615
|
+
[[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)
|
|
616
|
+
|
|
617
|
+
# **listBuildVersions**
|
|
618
|
+
> ListBuildVersions200Response listBuildVersions()
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
### Example
|
|
622
|
+
|
|
623
|
+
```typescript
|
|
624
|
+
import {
|
|
625
|
+
PackApi,
|
|
626
|
+
Configuration
|
|
627
|
+
} from 'kleisterjs';
|
|
628
|
+
|
|
629
|
+
const configuration = new Configuration();
|
|
630
|
+
const apiInstance = new PackApi(configuration);
|
|
631
|
+
|
|
632
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
633
|
+
let buildId: string; //A build identifier or slug (default to undefined)
|
|
634
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
635
|
+
let sort: string; //Sorting column (optional) (default to undefined)
|
|
636
|
+
let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
|
|
637
|
+
let limit: number; //Paging limit (optional) (default to 100)
|
|
638
|
+
let offset: number; //Paging offset (optional) (default to 0)
|
|
639
|
+
|
|
640
|
+
const { status, data } = await apiInstance.listBuildVersions(
|
|
641
|
+
packId,
|
|
642
|
+
buildId,
|
|
643
|
+
search,
|
|
644
|
+
sort,
|
|
645
|
+
order,
|
|
646
|
+
limit,
|
|
647
|
+
offset
|
|
648
|
+
);
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Parameters
|
|
652
|
+
|
|
653
|
+
|Name | Type | Description | Notes|
|
|
654
|
+
|------------- | ------------- | ------------- | -------------|
|
|
655
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
656
|
+
| **buildId** | [**string**] | A build identifier or slug | defaults to undefined|
|
|
657
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
658
|
+
| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
|
|
659
|
+
| **order** | [**'asc' | 'desc'**]**Array<'asc' | 'desc'>** | Sorting order | (optional) defaults to 'asc'|
|
|
660
|
+
| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
|
|
661
|
+
| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
### Return type
|
|
665
|
+
|
|
666
|
+
**ListBuildVersions200Response**
|
|
667
|
+
|
|
668
|
+
### Authorization
|
|
669
|
+
|
|
670
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
671
|
+
|
|
672
|
+
### HTTP request headers
|
|
673
|
+
|
|
674
|
+
- **Content-Type**: Not defined
|
|
675
|
+
- **Accept**: application/json
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
### HTTP response details
|
|
679
|
+
| Status code | Description | Response headers |
|
|
680
|
+
|-------------|-------------|------------------|
|
|
681
|
+
|**200** | A collection of version builds | - |
|
|
682
|
+
|**403** | User is not authorized | - |
|
|
683
|
+
|**404** | Resource not found | - |
|
|
684
|
+
|**500** | Some internal server error | - |
|
|
685
|
+
|
|
686
|
+
[[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)
|
|
687
|
+
|
|
688
|
+
# **listBuilds**
|
|
689
|
+
> ListBuilds200Response listBuilds()
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
### Example
|
|
693
|
+
|
|
694
|
+
```typescript
|
|
695
|
+
import {
|
|
696
|
+
PackApi,
|
|
697
|
+
Configuration
|
|
698
|
+
} from 'kleisterjs';
|
|
699
|
+
|
|
700
|
+
const configuration = new Configuration();
|
|
701
|
+
const apiInstance = new PackApi(configuration);
|
|
702
|
+
|
|
703
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
704
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
705
|
+
let sort: string; //Sorting column (optional) (default to undefined)
|
|
706
|
+
let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
|
|
707
|
+
let limit: number; //Paging limit (optional) (default to 100)
|
|
708
|
+
let offset: number; //Paging offset (optional) (default to 0)
|
|
709
|
+
|
|
710
|
+
const { status, data } = await apiInstance.listBuilds(
|
|
711
|
+
packId,
|
|
712
|
+
search,
|
|
713
|
+
sort,
|
|
714
|
+
order,
|
|
715
|
+
limit,
|
|
716
|
+
offset
|
|
717
|
+
);
|
|
718
|
+
```
|
|
719
|
+
|
|
720
|
+
### Parameters
|
|
721
|
+
|
|
722
|
+
|Name | Type | Description | Notes|
|
|
723
|
+
|------------- | ------------- | ------------- | -------------|
|
|
724
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
725
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
726
|
+
| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
|
|
727
|
+
| **order** | [**'asc' | 'desc'**]**Array<'asc' | 'desc'>** | Sorting order | (optional) defaults to 'asc'|
|
|
728
|
+
| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
|
|
729
|
+
| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
### Return type
|
|
733
|
+
|
|
734
|
+
**ListBuilds200Response**
|
|
735
|
+
|
|
736
|
+
### Authorization
|
|
737
|
+
|
|
738
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
739
|
+
|
|
740
|
+
### HTTP request headers
|
|
741
|
+
|
|
742
|
+
- **Content-Type**: Not defined
|
|
743
|
+
- **Accept**: application/json
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
### HTTP response details
|
|
747
|
+
| Status code | Description | Response headers |
|
|
748
|
+
|-------------|-------------|------------------|
|
|
749
|
+
|**200** | A collection of build | - |
|
|
750
|
+
|**403** | User is not authorized | - |
|
|
751
|
+
|**404** | Resource not found | - |
|
|
752
|
+
|**500** | Some internal server error | - |
|
|
753
|
+
|
|
754
|
+
[[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)
|
|
755
|
+
|
|
756
|
+
# **listPackGroups**
|
|
757
|
+
> ListPackGroups200Response listPackGroups()
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
### Example
|
|
761
|
+
|
|
762
|
+
```typescript
|
|
763
|
+
import {
|
|
764
|
+
PackApi,
|
|
765
|
+
Configuration
|
|
766
|
+
} from 'kleisterjs';
|
|
767
|
+
|
|
768
|
+
const configuration = new Configuration();
|
|
769
|
+
const apiInstance = new PackApi(configuration);
|
|
770
|
+
|
|
771
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
772
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
773
|
+
let sort: string; //Sorting column (optional) (default to undefined)
|
|
774
|
+
let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
|
|
775
|
+
let limit: number; //Paging limit (optional) (default to 100)
|
|
776
|
+
let offset: number; //Paging offset (optional) (default to 0)
|
|
777
|
+
|
|
778
|
+
const { status, data } = await apiInstance.listPackGroups(
|
|
779
|
+
packId,
|
|
780
|
+
search,
|
|
781
|
+
sort,
|
|
782
|
+
order,
|
|
783
|
+
limit,
|
|
784
|
+
offset
|
|
785
|
+
);
|
|
786
|
+
```
|
|
787
|
+
|
|
788
|
+
### Parameters
|
|
789
|
+
|
|
790
|
+
|Name | Type | Description | Notes|
|
|
791
|
+
|------------- | ------------- | ------------- | -------------|
|
|
792
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
793
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
794
|
+
| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
|
|
795
|
+
| **order** | [**'asc' | 'desc'**]**Array<'asc' | 'desc'>** | Sorting order | (optional) defaults to 'asc'|
|
|
796
|
+
| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
|
|
797
|
+
| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
### Return type
|
|
801
|
+
|
|
802
|
+
**ListPackGroups200Response**
|
|
803
|
+
|
|
804
|
+
### Authorization
|
|
805
|
+
|
|
806
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
807
|
+
|
|
808
|
+
### HTTP request headers
|
|
809
|
+
|
|
810
|
+
- **Content-Type**: Not defined
|
|
811
|
+
- **Accept**: application/json
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
### HTTP response details
|
|
815
|
+
| Status code | Description | Response headers |
|
|
816
|
+
|-------------|-------------|------------------|
|
|
817
|
+
|**200** | A collection of pack groups | - |
|
|
818
|
+
|**403** | User is not authorized | - |
|
|
819
|
+
|**404** | Resource not found | - |
|
|
820
|
+
|**500** | Some internal server error | - |
|
|
821
|
+
|
|
822
|
+
[[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)
|
|
823
|
+
|
|
824
|
+
# **listPackUsers**
|
|
825
|
+
> ListPackUsers200Response listPackUsers()
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
### Example
|
|
829
|
+
|
|
830
|
+
```typescript
|
|
831
|
+
import {
|
|
832
|
+
PackApi,
|
|
833
|
+
Configuration
|
|
834
|
+
} from 'kleisterjs';
|
|
835
|
+
|
|
836
|
+
const configuration = new Configuration();
|
|
837
|
+
const apiInstance = new PackApi(configuration);
|
|
838
|
+
|
|
839
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
840
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
841
|
+
let sort: string; //Sorting column (optional) (default to undefined)
|
|
842
|
+
let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
|
|
843
|
+
let limit: number; //Paging limit (optional) (default to 100)
|
|
844
|
+
let offset: number; //Paging offset (optional) (default to 0)
|
|
845
|
+
|
|
846
|
+
const { status, data } = await apiInstance.listPackUsers(
|
|
847
|
+
packId,
|
|
848
|
+
search,
|
|
849
|
+
sort,
|
|
850
|
+
order,
|
|
851
|
+
limit,
|
|
852
|
+
offset
|
|
853
|
+
);
|
|
854
|
+
```
|
|
855
|
+
|
|
856
|
+
### Parameters
|
|
857
|
+
|
|
858
|
+
|Name | Type | Description | Notes|
|
|
859
|
+
|------------- | ------------- | ------------- | -------------|
|
|
860
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
861
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
862
|
+
| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
|
|
863
|
+
| **order** | [**'asc' | 'desc'**]**Array<'asc' | 'desc'>** | Sorting order | (optional) defaults to 'asc'|
|
|
864
|
+
| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
|
|
865
|
+
| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
### Return type
|
|
869
|
+
|
|
870
|
+
**ListPackUsers200Response**
|
|
871
|
+
|
|
872
|
+
### Authorization
|
|
873
|
+
|
|
874
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
875
|
+
|
|
876
|
+
### HTTP request headers
|
|
877
|
+
|
|
878
|
+
- **Content-Type**: Not defined
|
|
879
|
+
- **Accept**: application/json
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
### HTTP response details
|
|
883
|
+
| Status code | Description | Response headers |
|
|
884
|
+
|-------------|-------------|------------------|
|
|
885
|
+
|**200** | A collection of pack users | - |
|
|
886
|
+
|**403** | User is not authorized | - |
|
|
887
|
+
|**404** | Resource not found | - |
|
|
888
|
+
|**500** | Some internal server error | - |
|
|
889
|
+
|
|
890
|
+
[[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)
|
|
891
|
+
|
|
892
|
+
# **listPacks**
|
|
893
|
+
> ListPacks200Response listPacks()
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
### Example
|
|
897
|
+
|
|
898
|
+
```typescript
|
|
899
|
+
import {
|
|
900
|
+
PackApi,
|
|
901
|
+
Configuration
|
|
902
|
+
} from 'kleisterjs';
|
|
903
|
+
|
|
904
|
+
const configuration = new Configuration();
|
|
905
|
+
const apiInstance = new PackApi(configuration);
|
|
906
|
+
|
|
907
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
908
|
+
let sort: string; //Sorting column (optional) (default to undefined)
|
|
909
|
+
let order: 'asc' | 'desc'; //Sorting order (optional) (default to 'asc')
|
|
910
|
+
let limit: number; //Paging limit (optional) (default to 100)
|
|
911
|
+
let offset: number; //Paging offset (optional) (default to 0)
|
|
912
|
+
|
|
913
|
+
const { status, data } = await apiInstance.listPacks(
|
|
914
|
+
search,
|
|
915
|
+
sort,
|
|
916
|
+
order,
|
|
917
|
+
limit,
|
|
918
|
+
offset
|
|
919
|
+
);
|
|
920
|
+
```
|
|
921
|
+
|
|
922
|
+
### Parameters
|
|
923
|
+
|
|
924
|
+
|Name | Type | Description | Notes|
|
|
925
|
+
|------------- | ------------- | ------------- | -------------|
|
|
926
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
927
|
+
| **sort** | [**string**] | Sorting column | (optional) defaults to undefined|
|
|
928
|
+
| **order** | [**'asc' | 'desc'**]**Array<'asc' | 'desc'>** | Sorting order | (optional) defaults to 'asc'|
|
|
929
|
+
| **limit** | [**number**] | Paging limit | (optional) defaults to 100|
|
|
930
|
+
| **offset** | [**number**] | Paging offset | (optional) defaults to 0|
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
**ListPacks200Response**
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: Not defined
|
|
944
|
+
- **Accept**: application/json
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
### HTTP response details
|
|
948
|
+
| Status code | Description | Response headers |
|
|
949
|
+
|-------------|-------------|------------------|
|
|
950
|
+
|**200** | A collection of packs | - |
|
|
951
|
+
|**403** | User is not authorized | - |
|
|
952
|
+
|**500** | Some internal server error | - |
|
|
953
|
+
|
|
954
|
+
[[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)
|
|
955
|
+
|
|
956
|
+
# **permitPackGroup**
|
|
957
|
+
> Notification permitPackGroup(permitPackGroupRequest)
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
### Example
|
|
961
|
+
|
|
962
|
+
```typescript
|
|
963
|
+
import {
|
|
964
|
+
PackApi,
|
|
965
|
+
Configuration,
|
|
966
|
+
PermitPackGroupRequest
|
|
967
|
+
} from 'kleisterjs';
|
|
968
|
+
|
|
969
|
+
const configuration = new Configuration();
|
|
970
|
+
const apiInstance = new PackApi(configuration);
|
|
971
|
+
|
|
972
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
973
|
+
let permitPackGroupRequest: PermitPackGroupRequest; //The pack group data to permit
|
|
974
|
+
|
|
975
|
+
const { status, data } = await apiInstance.permitPackGroup(
|
|
976
|
+
packId,
|
|
977
|
+
permitPackGroupRequest
|
|
978
|
+
);
|
|
979
|
+
```
|
|
980
|
+
|
|
981
|
+
### Parameters
|
|
982
|
+
|
|
983
|
+
|Name | Type | Description | Notes|
|
|
984
|
+
|------------- | ------------- | ------------- | -------------|
|
|
985
|
+
| **permitPackGroupRequest** | **PermitPackGroupRequest**| The pack group data to permit | |
|
|
986
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
### Return type
|
|
990
|
+
|
|
991
|
+
**Notification**
|
|
992
|
+
|
|
993
|
+
### Authorization
|
|
994
|
+
|
|
995
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
996
|
+
|
|
997
|
+
### HTTP request headers
|
|
998
|
+
|
|
999
|
+
- **Content-Type**: application/json
|
|
1000
|
+
- **Accept**: application/json
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
### HTTP response details
|
|
1004
|
+
| Status code | Description | Response headers |
|
|
1005
|
+
|-------------|-------------|------------------|
|
|
1006
|
+
|**200** | Plain success message | - |
|
|
1007
|
+
|**400** | Failed to parse request | - |
|
|
1008
|
+
|**403** | User is not authorized | - |
|
|
1009
|
+
|**404** | Resource not found | - |
|
|
1010
|
+
|**412** | Resource is not attached | - |
|
|
1011
|
+
|**422** | Failed to validate request | - |
|
|
1012
|
+
|**500** | Some internal server error | - |
|
|
1013
|
+
|
|
1014
|
+
[[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)
|
|
1015
|
+
|
|
1016
|
+
# **permitPackUser**
|
|
1017
|
+
> Notification permitPackUser(permitPackUserRequest)
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
### Example
|
|
1021
|
+
|
|
1022
|
+
```typescript
|
|
1023
|
+
import {
|
|
1024
|
+
PackApi,
|
|
1025
|
+
Configuration,
|
|
1026
|
+
PermitPackUserRequest
|
|
1027
|
+
} from 'kleisterjs';
|
|
1028
|
+
|
|
1029
|
+
const configuration = new Configuration();
|
|
1030
|
+
const apiInstance = new PackApi(configuration);
|
|
1031
|
+
|
|
1032
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
1033
|
+
let permitPackUserRequest: PermitPackUserRequest; //The pack user data to permit
|
|
1034
|
+
|
|
1035
|
+
const { status, data } = await apiInstance.permitPackUser(
|
|
1036
|
+
packId,
|
|
1037
|
+
permitPackUserRequest
|
|
1038
|
+
);
|
|
1039
|
+
```
|
|
1040
|
+
|
|
1041
|
+
### Parameters
|
|
1042
|
+
|
|
1043
|
+
|Name | Type | Description | Notes|
|
|
1044
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1045
|
+
| **permitPackUserRequest** | **PermitPackUserRequest**| The pack user data to permit | |
|
|
1046
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
### Return type
|
|
1050
|
+
|
|
1051
|
+
**Notification**
|
|
1052
|
+
|
|
1053
|
+
### Authorization
|
|
1054
|
+
|
|
1055
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
1056
|
+
|
|
1057
|
+
### HTTP request headers
|
|
1058
|
+
|
|
1059
|
+
- **Content-Type**: application/json
|
|
1060
|
+
- **Accept**: application/json
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
### HTTP response details
|
|
1064
|
+
| Status code | Description | Response headers |
|
|
1065
|
+
|-------------|-------------|------------------|
|
|
1066
|
+
|**200** | Plain success message | - |
|
|
1067
|
+
|**400** | Failed to parse request | - |
|
|
1068
|
+
|**403** | User is not authorized | - |
|
|
1069
|
+
|**404** | Resource not found | - |
|
|
1070
|
+
|**412** | Resource is not attached | - |
|
|
1071
|
+
|**422** | Failed to validate request | - |
|
|
1072
|
+
|**500** | Some internal server error | - |
|
|
1073
|
+
|
|
1074
|
+
[[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)
|
|
1075
|
+
|
|
1076
|
+
# **showBuild**
|
|
1077
|
+
> Build showBuild()
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
### Example
|
|
1081
|
+
|
|
1082
|
+
```typescript
|
|
1083
|
+
import {
|
|
1084
|
+
PackApi,
|
|
1085
|
+
Configuration
|
|
1086
|
+
} from 'kleisterjs';
|
|
1087
|
+
|
|
1088
|
+
const configuration = new Configuration();
|
|
1089
|
+
const apiInstance = new PackApi(configuration);
|
|
1090
|
+
|
|
1091
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
1092
|
+
let buildId: string; //A build identifier or slug (default to undefined)
|
|
1093
|
+
|
|
1094
|
+
const { status, data } = await apiInstance.showBuild(
|
|
1095
|
+
packId,
|
|
1096
|
+
buildId
|
|
1097
|
+
);
|
|
1098
|
+
```
|
|
1099
|
+
|
|
1100
|
+
### Parameters
|
|
1101
|
+
|
|
1102
|
+
|Name | Type | Description | Notes|
|
|
1103
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1104
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
1105
|
+
| **buildId** | [**string**] | A build identifier or slug | defaults to undefined|
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
### Return type
|
|
1109
|
+
|
|
1110
|
+
**Build**
|
|
1111
|
+
|
|
1112
|
+
### Authorization
|
|
1113
|
+
|
|
1114
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
1115
|
+
|
|
1116
|
+
### HTTP request headers
|
|
1117
|
+
|
|
1118
|
+
- **Content-Type**: Not defined
|
|
1119
|
+
- **Accept**: application/json
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
### HTTP response details
|
|
1123
|
+
| Status code | Description | Response headers |
|
|
1124
|
+
|-------------|-------------|------------------|
|
|
1125
|
+
|**200** | The details for a build | - |
|
|
1126
|
+
|**403** | User is not authorized | - |
|
|
1127
|
+
|**404** | Resource not found | - |
|
|
1128
|
+
|**500** | Some internal server error | - |
|
|
1129
|
+
|
|
1130
|
+
[[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)
|
|
1131
|
+
|
|
1132
|
+
# **showPack**
|
|
1133
|
+
> Pack showPack()
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
### Example
|
|
1137
|
+
|
|
1138
|
+
```typescript
|
|
1139
|
+
import {
|
|
1140
|
+
PackApi,
|
|
1141
|
+
Configuration
|
|
1142
|
+
} from 'kleisterjs';
|
|
1143
|
+
|
|
1144
|
+
const configuration = new Configuration();
|
|
1145
|
+
const apiInstance = new PackApi(configuration);
|
|
1146
|
+
|
|
1147
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
1148
|
+
|
|
1149
|
+
const { status, data } = await apiInstance.showPack(
|
|
1150
|
+
packId
|
|
1151
|
+
);
|
|
1152
|
+
```
|
|
1153
|
+
|
|
1154
|
+
### Parameters
|
|
1155
|
+
|
|
1156
|
+
|Name | Type | Description | Notes|
|
|
1157
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1158
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
### Return type
|
|
1162
|
+
|
|
1163
|
+
**Pack**
|
|
1164
|
+
|
|
1165
|
+
### Authorization
|
|
1166
|
+
|
|
1167
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
1168
|
+
|
|
1169
|
+
### HTTP request headers
|
|
1170
|
+
|
|
1171
|
+
- **Content-Type**: Not defined
|
|
1172
|
+
- **Accept**: application/json
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
### HTTP response details
|
|
1176
|
+
| Status code | Description | Response headers |
|
|
1177
|
+
|-------------|-------------|------------------|
|
|
1178
|
+
|**200** | The details for a pack | - |
|
|
1179
|
+
|**403** | User is not authorized | - |
|
|
1180
|
+
|**404** | Resource not found | - |
|
|
1181
|
+
|**500** | Some internal server error | - |
|
|
1182
|
+
|
|
1183
|
+
[[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)
|
|
1184
|
+
|
|
1185
|
+
# **updateBuild**
|
|
1186
|
+
> Build updateBuild(createBuildRequest)
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
### Example
|
|
1190
|
+
|
|
1191
|
+
```typescript
|
|
1192
|
+
import {
|
|
1193
|
+
PackApi,
|
|
1194
|
+
Configuration,
|
|
1195
|
+
CreateBuildRequest
|
|
1196
|
+
} from 'kleisterjs';
|
|
1197
|
+
|
|
1198
|
+
const configuration = new Configuration();
|
|
1199
|
+
const apiInstance = new PackApi(configuration);
|
|
1200
|
+
|
|
1201
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
1202
|
+
let buildId: string; //A build identifier or slug (default to undefined)
|
|
1203
|
+
let createBuildRequest: CreateBuildRequest; //The build data to update
|
|
1204
|
+
|
|
1205
|
+
const { status, data } = await apiInstance.updateBuild(
|
|
1206
|
+
packId,
|
|
1207
|
+
buildId,
|
|
1208
|
+
createBuildRequest
|
|
1209
|
+
);
|
|
1210
|
+
```
|
|
1211
|
+
|
|
1212
|
+
### Parameters
|
|
1213
|
+
|
|
1214
|
+
|Name | Type | Description | Notes|
|
|
1215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1216
|
+
| **createBuildRequest** | **CreateBuildRequest**| The build data to update | |
|
|
1217
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
1218
|
+
| **buildId** | [**string**] | A build identifier or slug | defaults to undefined|
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
### Return type
|
|
1222
|
+
|
|
1223
|
+
**Build**
|
|
1224
|
+
|
|
1225
|
+
### Authorization
|
|
1226
|
+
|
|
1227
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
1228
|
+
|
|
1229
|
+
### HTTP request headers
|
|
1230
|
+
|
|
1231
|
+
- **Content-Type**: application/json
|
|
1232
|
+
- **Accept**: application/json
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
### HTTP response details
|
|
1236
|
+
| Status code | Description | Response headers |
|
|
1237
|
+
|-------------|-------------|------------------|
|
|
1238
|
+
|**200** | The details for a build | - |
|
|
1239
|
+
|**400** | Failed to parse request | - |
|
|
1240
|
+
|**403** | User is not authorized | - |
|
|
1241
|
+
|**404** | Resource not found | - |
|
|
1242
|
+
|**422** | Failed to validate request | - |
|
|
1243
|
+
|**500** | Some internal server error | - |
|
|
1244
|
+
|
|
1245
|
+
[[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)
|
|
1246
|
+
|
|
1247
|
+
# **updatePack**
|
|
1248
|
+
> Pack updatePack(createPackRequest)
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
### Example
|
|
1252
|
+
|
|
1253
|
+
```typescript
|
|
1254
|
+
import {
|
|
1255
|
+
PackApi,
|
|
1256
|
+
Configuration,
|
|
1257
|
+
CreatePackRequest
|
|
1258
|
+
} from 'kleisterjs';
|
|
1259
|
+
|
|
1260
|
+
const configuration = new Configuration();
|
|
1261
|
+
const apiInstance = new PackApi(configuration);
|
|
1262
|
+
|
|
1263
|
+
let packId: string; //A pack identifier or slug (default to undefined)
|
|
1264
|
+
let createPackRequest: CreatePackRequest; //The pack data to update
|
|
1265
|
+
|
|
1266
|
+
const { status, data } = await apiInstance.updatePack(
|
|
1267
|
+
packId,
|
|
1268
|
+
createPackRequest
|
|
1269
|
+
);
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
### Parameters
|
|
1273
|
+
|
|
1274
|
+
|Name | Type | Description | Notes|
|
|
1275
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1276
|
+
| **createPackRequest** | **CreatePackRequest**| The pack data to update | |
|
|
1277
|
+
| **packId** | [**string**] | A pack identifier or slug | defaults to undefined|
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
### Return type
|
|
1281
|
+
|
|
1282
|
+
**Pack**
|
|
1283
|
+
|
|
1284
|
+
### Authorization
|
|
1285
|
+
|
|
1286
|
+
[Basic](../README.md#Basic), [Header](../README.md#Header), [Bearer](../README.md#Bearer)
|
|
1287
|
+
|
|
1288
|
+
### HTTP request headers
|
|
1289
|
+
|
|
1290
|
+
- **Content-Type**: application/json
|
|
1291
|
+
- **Accept**: application/json
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
### HTTP response details
|
|
1295
|
+
| Status code | Description | Response headers |
|
|
1296
|
+
|-------------|-------------|------------------|
|
|
1297
|
+
|**200** | The details for a pack | - |
|
|
1298
|
+
|**400** | Failed to parse request | - |
|
|
1299
|
+
|**403** | User is not authorized | - |
|
|
1300
|
+
|**404** | Resource not found | - |
|
|
1301
|
+
|**422** | Failed to validate request | - |
|
|
1302
|
+
|**500** | Some internal server error | - |
|
|
1303
|
+
|
|
1304
|
+
[[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)
|
|
1305
|
+
|