@orangefox-recovery/foxinternalclient 5.2.5 → 5.2.6

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.
@@ -51,7 +51,7 @@ const { status, data } = await apiInstance.cancelTaskFactoryTaskIdCancelPost(
51
51
 
52
52
  ### Authorization
53
53
 
54
- No authorization required
54
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
55
55
 
56
56
  ### HTTP request headers
57
57
 
@@ -103,7 +103,7 @@ const { status, data } = await apiInstance.deleteTaskFactoryTaskIdDelete(
103
103
 
104
104
  ### Authorization
105
105
 
106
- No authorization required
106
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
107
107
 
108
108
  ### HTTP request headers
109
109
 
@@ -155,7 +155,7 @@ const { status, data } = await apiInstance.downloadArtifactFactoryTaskIdArtifact
155
155
 
156
156
  ### Authorization
157
157
 
158
- No authorization required
158
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
159
159
 
160
160
  ### HTTP request headers
161
161
 
@@ -200,7 +200,7 @@ This endpoint does not have any parameters.
200
200
 
201
201
  ### Authorization
202
202
 
203
- No authorization required
203
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
204
204
 
205
205
  ### HTTP request headers
206
206
 
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.getTaskFactoryTaskIdGet(
251
251
 
252
252
  ### Authorization
253
253
 
254
- No authorization required
254
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
255
255
 
256
256
  ### HTTP request headers
257
257
 
@@ -303,7 +303,7 @@ const { status, data } = await apiInstance.listTasksFactoryGet(
303
303
 
304
304
  ### Authorization
305
305
 
306
- No authorization required
306
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
307
307
 
308
308
  ### HTTP request headers
309
309
 
@@ -356,7 +356,7 @@ const { status, data } = await apiInstance.newTaskFactoryPost(
356
356
 
357
357
  ### Authorization
358
358
 
359
- No authorization required
359
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
360
360
 
361
361
  ### HTTP request headers
362
362
 
@@ -412,7 +412,7 @@ const { status, data } = await apiInstance.updateTaskFactoryTaskIdPatch(
412
412
 
413
413
  ### Authorization
414
414
 
415
- No authorization required
415
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
416
416
 
417
417
  ### HTTP request headers
418
418
 
@@ -464,7 +464,7 @@ const { status, data } = await apiInstance.updateWorkerStatusFactoryUpdateStatus
464
464
 
465
465
  ### Authorization
466
466
 
467
- No authorization required
467
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
468
468
 
469
469
  ### HTTP request headers
470
470
 
@@ -522,7 +522,7 @@ const { status, data } = await apiInstance.uploadArtifactFactoryTaskIdArtifactPo
522
522
 
523
523
  ### Authorization
524
524
 
525
- No authorization required
525
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
526
526
 
527
527
  ### HTTP request headers
528
528
 
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.orangefox.download*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**changePasswordProfileChangePasswordPost**](#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password|
8
8
  |[**delReleaseInternalReleasesReleaseIdDelete**](#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release|
9
+ |[**deletePasteInternalPastePasteIdDelete**](#deletepasteinternalpastepasteiddelete) | **DELETE** /internal/paste/{paste_id} | Delete Paste|
9
10
  |[**deleteUserInternalUsersUserIdDelete**](#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User|
10
11
  |[**editReleaseInternalReleasesReleaseIdPut**](#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release|
11
12
  |[**getDeviceInfoInternalDevicesDeviceIdGet**](#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info|
@@ -20,6 +21,7 @@ All URIs are relative to *https://api.orangefox.download*
20
21
  |[**newReleaseInternalReleasesPost**](#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release|
21
22
  |[**renewAuthRenewPost**](#renewauthrenewpost) | **POST** /auth/renew | Renew|
22
23
  |[**updateDeviceInternalDevicesDeviceIdPut**](#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device|
24
+ |[**updatePasteInternalPastePasteIdPut**](#updatepasteinternalpastepasteidput) | **PUT** /internal/paste/{paste_id} | Update Paste|
23
25
  |[**updateUserInternalUsersUserIdPut**](#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User|
24
26
 
25
27
  # **changePasswordProfileChangePasswordPost**
@@ -127,6 +129,60 @@ const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDe
127
129
 
128
130
  [[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
131
 
132
+ # **deletePasteInternalPastePasteIdDelete**
133
+ > deletePasteInternalPastePasteIdDelete()
134
+
135
+ Delete a paste by ID. Requires admin permissions.
136
+
137
+ ### Example
138
+
139
+ ```typescript
140
+ import {
141
+ InternalApi,
142
+ Configuration
143
+ } from '@orangefox-recovery/foxinternalclient';
144
+
145
+ const configuration = new Configuration();
146
+ const apiInstance = new InternalApi(configuration);
147
+
148
+ let pasteId: string; // (default to undefined)
149
+
150
+ const { status, data } = await apiInstance.deletePasteInternalPastePasteIdDelete(
151
+ pasteId
152
+ );
153
+ ```
154
+
155
+ ### Parameters
156
+
157
+ |Name | Type | Description | Notes|
158
+ |------------- | ------------- | ------------- | -------------|
159
+ | **pasteId** | [**string**] | | defaults to undefined|
160
+
161
+
162
+ ### Return type
163
+
164
+ void (empty response body)
165
+
166
+ ### Authorization
167
+
168
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: Not defined
173
+ - **Accept**: application/json
174
+
175
+
176
+ ### HTTP response details
177
+ | Status code | Description | Response headers |
178
+ |-------------|-------------|------------------|
179
+ |**204** | Successful Response | - |
180
+ |**404** | Item not found | - |
181
+ |**429** | Too many requests | - |
182
+ |**422** | Validation Error | - |
183
+
184
+ [[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)
185
+
130
186
  # **deleteUserInternalUsersUserIdDelete**
131
187
  > boolean deleteUserInternalUsersUserIdDelete()
132
188
 
@@ -901,6 +957,64 @@ const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPu
901
957
 
902
958
  [[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)
903
959
 
960
+ # **updatePasteInternalPastePasteIdPut**
961
+ > PasteOutput updatePasteInternalPastePasteIdPut(pasteInput)
962
+
963
+ Update a paste by ID. Requires admin permissions.
964
+
965
+ ### Example
966
+
967
+ ```typescript
968
+ import {
969
+ InternalApi,
970
+ Configuration,
971
+ PasteInput
972
+ } from '@orangefox-recovery/foxinternalclient';
973
+
974
+ const configuration = new Configuration();
975
+ const apiInstance = new InternalApi(configuration);
976
+
977
+ let pasteId: string; // (default to undefined)
978
+ let pasteInput: PasteInput; //
979
+
980
+ const { status, data } = await apiInstance.updatePasteInternalPastePasteIdPut(
981
+ pasteId,
982
+ pasteInput
983
+ );
984
+ ```
985
+
986
+ ### Parameters
987
+
988
+ |Name | Type | Description | Notes|
989
+ |------------- | ------------- | ------------- | -------------|
990
+ | **pasteInput** | **PasteInput**| | |
991
+ | **pasteId** | [**string**] | | defaults to undefined|
992
+
993
+
994
+ ### Return type
995
+
996
+ **PasteOutput**
997
+
998
+ ### Authorization
999
+
1000
+ [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
1001
+
1002
+ ### HTTP request headers
1003
+
1004
+ - **Content-Type**: application/json
1005
+ - **Accept**: application/json
1006
+
1007
+
1008
+ ### HTTP response details
1009
+ | Status code | Description | Response headers |
1010
+ |-------------|-------------|------------------|
1011
+ |**200** | Successful Response | - |
1012
+ |**404** | Item not found | - |
1013
+ |**429** | Too many requests | - |
1014
+ |**422** | Validation Error | - |
1015
+
1016
+ [[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)
1017
+
904
1018
  # **updateUserInternalUsersUserIdPut**
905
1019
  > boolean updateUserInternalUsersUserIdPut(userUpdateBody)
906
1020
 
@@ -0,0 +1,117 @@
1
+ # PasteApi
2
+
3
+ All URIs are relative to *https://api.orangefox.download*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createPastePastePost**](#createpastepastepost) | **POST** /paste/ | Create Paste|
8
+ |[**getPastePastePasteIdGet**](#getpastepastepasteidget) | **GET** /paste/{paste_id} | Get Paste|
9
+
10
+ # **createPastePastePost**
11
+ > PasteOutput createPastePastePost(pasteInput)
12
+
13
+ Create a new paste.
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ PasteApi,
20
+ Configuration,
21
+ PasteInput
22
+ } from '@orangefox-recovery/foxinternalclient';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new PasteApi(configuration);
26
+
27
+ let pasteInput: PasteInput; //
28
+
29
+ const { status, data } = await apiInstance.createPastePastePost(
30
+ pasteInput
31
+ );
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes|
37
+ |------------- | ------------- | ------------- | -------------|
38
+ | **pasteInput** | **PasteInput**| | |
39
+
40
+
41
+ ### Return type
42
+
43
+ **PasteOutput**
44
+
45
+ ### Authorization
46
+
47
+ No authorization required
48
+
49
+ ### HTTP request headers
50
+
51
+ - **Content-Type**: application/json
52
+ - **Accept**: application/json
53
+
54
+
55
+ ### HTTP response details
56
+ | Status code | Description | Response headers |
57
+ |-------------|-------------|------------------|
58
+ |**201** | Successful Response | - |
59
+ |**429** | Too many requests | - |
60
+ |**422** | Validation Error | - |
61
+
62
+ [[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
+
64
+ # **getPastePastePasteIdGet**
65
+ > PasteOutput getPastePastePasteIdGet()
66
+
67
+ Get a paste by ID.
68
+
69
+ ### Example
70
+
71
+ ```typescript
72
+ import {
73
+ PasteApi,
74
+ Configuration
75
+ } from '@orangefox-recovery/foxinternalclient';
76
+
77
+ const configuration = new Configuration();
78
+ const apiInstance = new PasteApi(configuration);
79
+
80
+ let pasteId: string; // (default to undefined)
81
+
82
+ const { status, data } = await apiInstance.getPastePastePasteIdGet(
83
+ pasteId
84
+ );
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ |Name | Type | Description | Notes|
90
+ |------------- | ------------- | ------------- | -------------|
91
+ | **pasteId** | [**string**] | | defaults to undefined|
92
+
93
+
94
+ ### Return type
95
+
96
+ **PasteOutput**
97
+
98
+ ### Authorization
99
+
100
+ No authorization required
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: application/json
106
+
107
+
108
+ ### HTTP response details
109
+ | Status code | Description | Response headers |
110
+ |-------------|-------------|------------------|
111
+ |**200** | Successful Response | - |
112
+ |**404** | Item not found | - |
113
+ |**429** | Too many requests | - |
114
+ |**422** | Validation Error | - |
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
+
@@ -0,0 +1,26 @@
1
+ # PasteInput
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **_id** | **string** | | [optional] [default to undefined]
9
+ **content** | **string** | | [default to undefined]
10
+ **ip_address** | **string** | | [default to undefined]
11
+ **created_at** | **string** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PasteInput } from '@orangefox-recovery/foxinternalclient';
17
+
18
+ const instance: PasteInput = {
19
+ _id,
20
+ content,
21
+ ip_address,
22
+ created_at,
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
+ # PasteOutput
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **_id** | **string** | | [optional] [default to undefined]
9
+ **content** | **string** | | [default to undefined]
10
+ **ip_address** | **string** | | [default to undefined]
11
+ **created_at** | **string** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PasteOutput } from '@orangefox-recovery/foxinternalclient';
17
+
18
+ const instance: PasteOutput = {
19
+ _id,
20
+ content,
21
+ ip_address,
22
+ created_at,
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)
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 5.2.5
7
+ * The version of the OpenAPI document: 5.2.6
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orangefox-recovery/foxinternalclient",
3
- "version": "5.2.5",
3
+ "version": "5.2.6",
4
4
  "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {