@orangefox-recovery/foxinternalclient 5.2.4 → 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.
@@ -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.4
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.4",
3
+ "version": "5.2.6",
4
4
  "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {