@orangefox-recovery/foxclient 5.2.1 → 5.2.3
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/README.md +2 -2
- package/api.ts +110 -120
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +105 -105
- package/dist/api.js +62 -72
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +105 -105
- package/dist/esm/api.js +62 -72
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DeviceApi.md +9 -11
- package/docs/ReleaseApi.md +22 -25
- package/docs/ReleaseResponse.md +1 -1
- package/docs/ShortReleaseResponse.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/ReleaseApi.md
CHANGED
|
@@ -19,16 +19,14 @@ Extended get device method, including the ability to get a device using device c
|
|
|
19
19
|
```typescript
|
|
20
20
|
import {
|
|
21
21
|
ReleaseApi,
|
|
22
|
-
Configuration
|
|
23
|
-
,
|
|
24
|
-
|
|
22
|
+
Configuration
|
|
25
23
|
} from '@orangefox-recovery/foxclient';
|
|
26
24
|
|
|
27
25
|
const configuration = new Configuration();
|
|
28
26
|
const apiInstance = new ReleaseApi(configuration);
|
|
29
27
|
|
|
30
|
-
let releaseId: ; //Release ID (optional) (default to undefined)
|
|
31
|
-
let id: ; //Release ID (deprecated) (optional) (default to undefined)
|
|
28
|
+
let releaseId: string; //Release ID (optional) (default to undefined)
|
|
29
|
+
let id: string; //Release ID (deprecated) (optional) (default to undefined)
|
|
32
30
|
let buildId: string; //Build ID, `ro.build.fox_id` prop (optional) (default to undefined)
|
|
33
31
|
let filename: string; // (optional) (default to undefined)
|
|
34
32
|
|
|
@@ -44,8 +42,8 @@ const { status, data } = await apiInstance.getRelease(
|
|
|
44
42
|
|
|
45
43
|
|Name | Type | Description | Notes|
|
|
46
44
|
|------------- | ------------- | ------------- | -------------|
|
|
47
|
-
| **releaseId** |
|
|
48
|
-
| **id** |
|
|
45
|
+
| **releaseId** | [**string**] | Release ID | (optional) defaults to undefined|
|
|
46
|
+
| **id** | [**string**] | Release ID (deprecated) | (optional) defaults to undefined|
|
|
49
47
|
| **buildId** | [**string**] | Build ID, `ro.build.fox_id` prop | (optional) defaults to undefined|
|
|
50
48
|
| **filename** | [**string**] | | (optional) defaults to undefined|
|
|
51
49
|
|
|
@@ -88,7 +86,7 @@ import {
|
|
|
88
86
|
const configuration = new Configuration();
|
|
89
87
|
const apiInstance = new ReleaseApi(configuration);
|
|
90
88
|
|
|
91
|
-
let releaseId:
|
|
89
|
+
let releaseId: string; // (default to undefined)
|
|
92
90
|
|
|
93
91
|
const { status, data } = await apiInstance.getReleaseDeprecated(
|
|
94
92
|
releaseId
|
|
@@ -99,7 +97,7 @@ const { status, data } = await apiInstance.getReleaseDeprecated(
|
|
|
99
97
|
|
|
100
98
|
|Name | Type | Description | Notes|
|
|
101
99
|
|------------- | ------------- | ------------- | -------------|
|
|
102
|
-
| **releaseId** | **
|
|
100
|
+
| **releaseId** | [**string**] | | defaults to undefined|
|
|
103
101
|
|
|
104
102
|
|
|
105
103
|
### Return type
|
|
@@ -134,24 +132,23 @@ Lists releases. This method contains a bunch of different parameters to filter
|
|
|
134
132
|
```typescript
|
|
135
133
|
import {
|
|
136
134
|
ReleaseApi,
|
|
137
|
-
Configuration
|
|
138
|
-
|
|
135
|
+
Configuration
|
|
139
136
|
} from '@orangefox-recovery/foxclient';
|
|
140
137
|
|
|
141
138
|
const configuration = new Configuration();
|
|
142
139
|
const apiInstance = new ReleaseApi(configuration);
|
|
143
140
|
|
|
144
|
-
let id: Array<
|
|
145
|
-
let id2: Array<
|
|
141
|
+
let id: Array<string>; //Filter by Release IDs (optional) (default to undefined)
|
|
142
|
+
let id2: Array<string>; //Filter by Release IDs (deprecated) (optional) (default to undefined)
|
|
146
143
|
let buildId: Array<string>; //Filter by Build IDs (optional) (default to undefined)
|
|
147
|
-
let deviceId: Array<
|
|
148
|
-
let maintainerId: Array<
|
|
144
|
+
let deviceId: Array<string>; //Filter by Device IDs (optional) (default to undefined)
|
|
145
|
+
let maintainerId: Array<string>; //Filter by Maintainer IDs (optional) (default to undefined)
|
|
149
146
|
let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
|
|
150
147
|
let version: Array<string>; //Filter by release version (optional) (default to undefined)
|
|
151
148
|
let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
|
|
152
149
|
let archived: boolean; //Filter by the archived status (optional) (default to undefined)
|
|
153
150
|
let freezed: boolean; //Filter by the freezed status (optional) (default to undefined)
|
|
154
|
-
let afterReleaseId: ; //Show releases after the provided one (optional) (default to undefined)
|
|
151
|
+
let afterReleaseId: string; //Show releases after the provided one (optional) (default to undefined)
|
|
155
152
|
let afterDate: number; //Show releases after the provided timestamp (optional) (default to undefined)
|
|
156
153
|
let sort: ReleasesSort; //Sort mode (optional) (default to undefined)
|
|
157
154
|
let group: boolean; //Group releases by version + variant. This will change the response! (optional) (default to undefined)
|
|
@@ -182,17 +179,17 @@ const { status, data } = await apiInstance.getReleases(
|
|
|
182
179
|
|
|
183
180
|
|Name | Type | Description | Notes|
|
|
184
181
|
|------------- | ------------- | ------------- | -------------|
|
|
185
|
-
| **id** | **Array<
|
|
186
|
-
| **id2** | **Array<
|
|
182
|
+
| **id** | **Array<string>** | Filter by Release IDs | (optional) defaults to undefined|
|
|
183
|
+
| **id2** | **Array<string>** | Filter by Release IDs (deprecated) | (optional) defaults to undefined|
|
|
187
184
|
| **buildId** | **Array<string>** | Filter by Build IDs | (optional) defaults to undefined|
|
|
188
|
-
| **deviceId** | **Array<
|
|
189
|
-
| **maintainerId** | **Array<
|
|
185
|
+
| **deviceId** | **Array<string>** | Filter by Device IDs | (optional) defaults to undefined|
|
|
186
|
+
| **maintainerId** | **Array<string>** | Filter by Maintainer IDs | (optional) defaults to undefined|
|
|
190
187
|
| **codename** | **Array<string>** | Filter by device codenames | (optional) defaults to undefined|
|
|
191
188
|
| **version** | **Array<string>** | Filter by release version | (optional) defaults to undefined|
|
|
192
189
|
| **type** | **Array<ReleaseType>** | Filter by release type | (optional) defaults to undefined|
|
|
193
190
|
| **archived** | [**boolean**] | Filter by the archived status | (optional) defaults to undefined|
|
|
194
191
|
| **freezed** | [**boolean**] | Filter by the freezed status | (optional) defaults to undefined|
|
|
195
|
-
| **afterReleaseId** |
|
|
192
|
+
| **afterReleaseId** | [**string**] | Show releases after the provided one | (optional) defaults to undefined|
|
|
196
193
|
| **afterDate** | [**number**] | Show releases after the provided timestamp | (optional) defaults to undefined|
|
|
197
194
|
| **sort** | **ReleasesSort** | Sort mode | (optional) defaults to undefined|
|
|
198
195
|
| **group** | [**boolean**] | Group releases by version + variant. This will change the response! | (optional) defaults to undefined|
|
|
@@ -239,8 +236,8 @@ import {
|
|
|
239
236
|
const configuration = new Configuration();
|
|
240
237
|
const apiInstance = new ReleaseApi(configuration);
|
|
241
238
|
|
|
242
|
-
let lastKnownId:
|
|
243
|
-
let deviceId: Array<
|
|
239
|
+
let lastKnownId: string; // (default to undefined)
|
|
240
|
+
let deviceId: Array<string>; //Filter by device ID (optional) (default to undefined)
|
|
244
241
|
let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
|
|
245
242
|
let releaseType: Array<ReleaseType>; //Filter by release type (legacy) (optional) (default to undefined)
|
|
246
243
|
let skip: number; //Skip query results (optional) (default to undefined)
|
|
@@ -260,8 +257,8 @@ const { status, data } = await apiInstance.getUpdatesDeprecated(
|
|
|
260
257
|
|
|
261
258
|
|Name | Type | Description | Notes|
|
|
262
259
|
|------------- | ------------- | ------------- | -------------|
|
|
263
|
-
| **lastKnownId** | **
|
|
264
|
-
| **deviceId** | **Array<
|
|
260
|
+
| **lastKnownId** | [**string**] | | defaults to undefined|
|
|
261
|
+
| **deviceId** | **Array<string>** | Filter by device ID | (optional) defaults to undefined|
|
|
265
262
|
| **type** | **Array<ReleaseType>** | Filter by release type | (optional) defaults to undefined|
|
|
266
263
|
| **releaseType** | **Array<ReleaseType>** | Filter by release type (legacy) | (optional) defaults to undefined|
|
|
267
264
|
| **skip** | [**number**] | Skip query results | (optional) defaults to undefined|
|
package/docs/ReleaseResponse.md
CHANGED
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**filename** | **string** | | [default to undefined]
|
|
13
13
|
**variant** | **string** | | [default to undefined]
|
|
14
14
|
**device_id** | **string** | | [default to undefined]
|
|
15
|
-
**date** | **
|
|
15
|
+
**date** | **number** | | [default to undefined]
|
|
16
16
|
**md5** | **string** | | [default to undefined]
|
|
17
17
|
**version** | **string** | | [default to undefined]
|
|
18
18
|
**type** | [**ReleaseType**](ReleaseType.md) | | [default to undefined]
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**filename** | **string** | | [default to undefined]
|
|
13
13
|
**variant** | **string** | | [default to undefined]
|
|
14
14
|
**device_id** | **string** | | [default to undefined]
|
|
15
|
-
**date** | **
|
|
15
|
+
**date** | **number** | | [default to undefined]
|
|
16
16
|
**md5** | **string** | | [default to undefined]
|
|
17
17
|
**version** | **string** | | [default to undefined]
|
|
18
18
|
**type** | [**ReleaseType**](ReleaseType.md) | | [default to undefined]
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.3
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|