@orangefox-recovery/foxinternalclient 5.2.1

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.
Files changed (83) hide show
  1. package/.openapi-generator/FILES +63 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +155 -0
  5. package/api.ts +5275 -0
  6. package/base.ts +86 -0
  7. package/common.ts +150 -0
  8. package/configuration.ts +115 -0
  9. package/dist/api.d.ts +3508 -0
  10. package/dist/api.js +3078 -0
  11. package/dist/base.d.ts +66 -0
  12. package/dist/base.js +65 -0
  13. package/dist/common.d.ts +65 -0
  14. package/dist/common.js +161 -0
  15. package/dist/configuration.d.ts +91 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +3508 -0
  18. package/dist/esm/api.js +3051 -0
  19. package/dist/esm/base.d.ts +66 -0
  20. package/dist/esm/base.js +60 -0
  21. package/dist/esm/common.d.ts +65 -0
  22. package/dist/esm/common.js +149 -0
  23. package/dist/esm/configuration.d.ts +91 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/BodyChangePasswordProfileChangePasswordPost.md +22 -0
  30. package/docs/BuildStatusEnum.md +18 -0
  31. package/docs/BuildTaskResponse.md +36 -0
  32. package/docs/BuildTaskShortResponse.md +32 -0
  33. package/docs/DeviceApi.md +253 -0
  34. package/docs/DeviceInternalResponse.md +48 -0
  35. package/docs/DeviceResponse.md +44 -0
  36. package/docs/DeviceStatsResponse.md +24 -0
  37. package/docs/DeviceUpdateBody.md +30 -0
  38. package/docs/FFStatusEnum.md +12 -0
  39. package/docs/FFStatusResponse.md +20 -0
  40. package/docs/FoxFactoryApi.md +375 -0
  41. package/docs/GitlabApi.md +62 -0
  42. package/docs/GlobalStatsAggregationModel.md +26 -0
  43. package/docs/HTTPValidationError.md +20 -0
  44. package/docs/InternalApi.md +961 -0
  45. package/docs/ListResponseReleaseResponse.md +22 -0
  46. package/docs/ListResponseShortDeviceResponse.md +22 -0
  47. package/docs/ListResponseShortReleaseResponse.md +22 -0
  48. package/docs/ListResponseStr.md +22 -0
  49. package/docs/ListResponseUserShortResponse.md +22 -0
  50. package/docs/LogListResponse.md +26 -0
  51. package/docs/LogResponse.md +36 -0
  52. package/docs/MaintainerShortModel.md +26 -0
  53. package/docs/NewBuildTaskBody.md +28 -0
  54. package/docs/NewDeviceBody.md +26 -0
  55. package/docs/RecoveryImgResponse.md +22 -0
  56. package/docs/ReleaseApi.md +292 -0
  57. package/docs/ReleaseGroupsResponse.md +20 -0
  58. package/docs/ReleaseInternalResponse.md +62 -0
  59. package/docs/ReleaseInternalResponsePropValue.md +18 -0
  60. package/docs/ReleaseResponse.md +56 -0
  61. package/docs/ReleaseStatsResponse.md +24 -0
  62. package/docs/ReleaseType.md +12 -0
  63. package/docs/ReleaseUpdateBody.md +26 -0
  64. package/docs/ReleasesSort.md +10 -0
  65. package/docs/ResponseGetReleases.md +22 -0
  66. package/docs/ShortDeviceResponse.md +38 -0
  67. package/docs/ShortReleaseResponse.md +44 -0
  68. package/docs/StatsApi.md +53 -0
  69. package/docs/TaskUpdateBody.md +22 -0
  70. package/docs/TokenResponse.md +22 -0
  71. package/docs/UserGitlab.md +20 -0
  72. package/docs/UserInternalResponse.md +38 -0
  73. package/docs/UserMail.md +20 -0
  74. package/docs/UserShortResponse.md +26 -0
  75. package/docs/UserTelegram.md +20 -0
  76. package/docs/UserUpdateBody.md +28 -0
  77. package/docs/ValidationError.md +24 -0
  78. package/docs/ValidationErrorLocInner.md +18 -0
  79. package/git_push.sh +57 -0
  80. package/index.ts +18 -0
  81. package/package.json +41 -0
  82. package/tsconfig.esm.json +7 -0
  83. package/tsconfig.json +18 -0
@@ -0,0 +1,63 @@
1
+ .gitignore
2
+ .npmignore
3
+ .openapi-generator-ignore
4
+ README.md
5
+ api.ts
6
+ base.ts
7
+ common.ts
8
+ configuration.ts
9
+ docs/BodyChangePasswordProfileChangePasswordPost.md
10
+ docs/BuildStatusEnum.md
11
+ docs/BuildTaskResponse.md
12
+ docs/BuildTaskShortResponse.md
13
+ docs/DeviceApi.md
14
+ docs/DeviceInternalResponse.md
15
+ docs/DeviceResponse.md
16
+ docs/DeviceStatsResponse.md
17
+ docs/DeviceUpdateBody.md
18
+ docs/FFStatusEnum.md
19
+ docs/FFStatusResponse.md
20
+ docs/FoxFactoryApi.md
21
+ docs/GitlabApi.md
22
+ docs/GlobalStatsAggregationModel.md
23
+ docs/HTTPValidationError.md
24
+ docs/InternalApi.md
25
+ docs/ListResponseReleaseResponse.md
26
+ docs/ListResponseShortDeviceResponse.md
27
+ docs/ListResponseShortReleaseResponse.md
28
+ docs/ListResponseStr.md
29
+ docs/ListResponseUserShortResponse.md
30
+ docs/LogListResponse.md
31
+ docs/LogResponse.md
32
+ docs/MaintainerShortModel.md
33
+ docs/NewBuildTaskBody.md
34
+ docs/NewDeviceBody.md
35
+ docs/RecoveryImgResponse.md
36
+ docs/ReleaseApi.md
37
+ docs/ReleaseGroupsResponse.md
38
+ docs/ReleaseInternalResponse.md
39
+ docs/ReleaseInternalResponsePropValue.md
40
+ docs/ReleaseResponse.md
41
+ docs/ReleaseStatsResponse.md
42
+ docs/ReleaseType.md
43
+ docs/ReleaseUpdateBody.md
44
+ docs/ReleasesSort.md
45
+ docs/ResponseGetReleases.md
46
+ docs/ShortDeviceResponse.md
47
+ docs/ShortReleaseResponse.md
48
+ docs/StatsApi.md
49
+ docs/TaskUpdateBody.md
50
+ docs/TokenResponse.md
51
+ docs/UserGitlab.md
52
+ docs/UserInternalResponse.md
53
+ docs/UserMail.md
54
+ docs/UserShortResponse.md
55
+ docs/UserTelegram.md
56
+ docs/UserUpdateBody.md
57
+ docs/ValidationError.md
58
+ docs/ValidationErrorLocInner.md
59
+ git_push.sh
60
+ index.ts
61
+ package.json
62
+ tsconfig.esm.json
63
+ tsconfig.json
@@ -0,0 +1 @@
1
+ 7.13.0
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
package/README.md ADDED
@@ -0,0 +1,155 @@
1
+ ## @orangefox-recovery/foxinternalclient@5.2.1
2
+
3
+ This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
+
5
+ Environment
6
+ * Node.js
7
+ * Webpack
8
+ * Browserify
9
+
10
+ Language level
11
+ * ES5 - you must have a Promises/A+ library installed
12
+ * ES6
13
+
14
+ Module system
15
+ * CommonJS
16
+ * ES6 module system
17
+
18
+ It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
19
+
20
+ ### Building
21
+
22
+ To build and compile the typescript sources to javascript use:
23
+ ```
24
+ npm install
25
+ npm run build
26
+ ```
27
+
28
+ ### Publishing
29
+
30
+ First build the package then run `npm publish`
31
+
32
+ ### Consuming
33
+
34
+ navigate to the folder of your consuming project and run one of the following commands.
35
+
36
+ _published:_
37
+
38
+ ```
39
+ npm install @orangefox-recovery/foxinternalclient@5.2.1 --save
40
+ ```
41
+
42
+ _unPublished (not recommended):_
43
+
44
+ ```
45
+ npm install PATH_TO_GENERATED_PACKAGE --save
46
+ ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *https://api.orangefox.download*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *DeviceApi* | [**getDevice**](docs/DeviceApi.md#getdevice) | **GET** /devices/get | Get Device
55
+ *DeviceApi* | [**getDeviceDeprecated**](docs/DeviceApi.md#getdevicedeprecated) | **GET** /devices/{device_id} | Get Device Short
56
+ *DeviceApi* | [**getDevices**](docs/DeviceApi.md#getdevices) | **GET** /devices/ | Get Devices
57
+ *DeviceApi* | [**getOems**](docs/DeviceApi.md#getoems) | **GET** /oems/ | Get Oems
58
+ *FoxFactoryApi* | [**cancelTaskFactoryTaskIdCancelPost**](docs/FoxFactoryApi.md#canceltaskfactorytaskidcancelpost) | **POST** /factory/{task_id}/cancel | Cancel Task
59
+ *FoxFactoryApi* | [**deleteTaskFactoryTaskIdDelete**](docs/FoxFactoryApi.md#deletetaskfactorytaskiddelete) | **DELETE** /factory/{task_id} | Delete Task
60
+ *FoxFactoryApi* | [**factoryStatusFactoryStatusGet**](docs/FoxFactoryApi.md#factorystatusfactorystatusget) | **GET** /factory/status | Factory Status
61
+ *FoxFactoryApi* | [**getTaskFactoryTaskIdGet**](docs/FoxFactoryApi.md#gettaskfactorytaskidget) | **GET** /factory/{task_id} | Get Task
62
+ *FoxFactoryApi* | [**listTasksFactoryGet**](docs/FoxFactoryApi.md#listtasksfactoryget) | **GET** /factory/ | List Tasks
63
+ *FoxFactoryApi* | [**newTaskFactoryPost**](docs/FoxFactoryApi.md#newtaskfactorypost) | **POST** /factory/ | New Task
64
+ *FoxFactoryApi* | [**updateTaskFactoryTaskIdPatch**](docs/FoxFactoryApi.md#updatetaskfactorytaskidpatch) | **PATCH** /factory/{task_id} | Update Task
65
+ *GitlabApi* | [**deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost**](docs/GitlabApi.md#deviceaddgitlabrepogitlabdevicedeviceidgitlabpost) | **POST** /gitlab/device/{device_id}/gitlab | Device Add Gitlab Repo
66
+ *InternalApi* | [**changePasswordProfileChangePasswordPost**](docs/InternalApi.md#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password
67
+ *InternalApi* | [**delReleaseInternalReleasesReleaseIdDelete**](docs/InternalApi.md#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release
68
+ *InternalApi* | [**deleteUserInternalUsersUserIdDelete**](docs/InternalApi.md#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User
69
+ *InternalApi* | [**editReleaseInternalReleasesReleaseIdPut**](docs/InternalApi.md#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release
70
+ *InternalApi* | [**getDeviceInfoInternalDevicesDeviceIdGet**](docs/InternalApi.md#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info
71
+ *InternalApi* | [**getLogsInternalLogsGet**](docs/InternalApi.md#getlogsinternallogsget) | **GET** /internal/logs/ | Get Logs
72
+ *InternalApi* | [**getReleaseInfoInternalReleasesReleaseIdGet**](docs/InternalApi.md#getreleaseinfointernalreleasesreleaseidget) | **GET** /internal/releases/{release_id} | Get Release Info
73
+ *InternalApi* | [**getReleaseZipInternalReleasesReleaseIdDlGet**](docs/InternalApi.md#getreleasezipinternalreleasesreleaseiddlget) | **GET** /internal/releases/{release_id}/dl | Get Release Zip
74
+ *InternalApi* | [**getUserByIdInternalUsersUserIdGet**](docs/InternalApi.md#getuserbyidinternalusersuseridget) | **GET** /internal/users/{user_id} | Get User By Id
75
+ *InternalApi* | [**listUsersInternalUsersGet**](docs/InternalApi.md#listusersinternalusersget) | **GET** /internal/users/ | List Users
76
+ *InternalApi* | [**loginOauthAuthLoginPost**](docs/InternalApi.md#loginoauthauthloginpost) | **POST** /auth/login | Login Oauth
77
+ *InternalApi* | [**logoutAuthLogoutPost**](docs/InternalApi.md#logoutauthlogoutpost) | **POST** /auth/logout | Logout
78
+ *InternalApi* | [**newDeviceInternalDevicesPost**](docs/InternalApi.md#newdeviceinternaldevicespost) | **POST** /internal/devices/ | New Device
79
+ *InternalApi* | [**newReleaseInternalReleasesPost**](docs/InternalApi.md#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release
80
+ *InternalApi* | [**renewAuthRenewPost**](docs/InternalApi.md#renewauthrenewpost) | **POST** /auth/renew | Renew
81
+ *InternalApi* | [**updateDeviceInternalDevicesDeviceIdPut**](docs/InternalApi.md#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device
82
+ *InternalApi* | [**updateUserInternalUsersUserIdPut**](docs/InternalApi.md#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User
83
+ *ReleaseApi* | [**getRelease**](docs/ReleaseApi.md#getrelease) | **GET** /releases/get | Get Release
84
+ *ReleaseApi* | [**getReleaseDeprecated**](docs/ReleaseApi.md#getreleasedeprecated) | **GET** /releases/{release_id} | Get Release Short
85
+ *ReleaseApi* | [**getReleases**](docs/ReleaseApi.md#getreleases) | **GET** /releases/ | Get Releases
86
+ *ReleaseApi* | [**getUpdatesDeprecated**](docs/ReleaseApi.md#getupdatesdeprecated) | **GET** /updates/{last_known_id} | Get Updates
87
+ *StatsApi* | [**getPublicStats**](docs/StatsApi.md#getpublicstats) | **GET** /stats/ | Public Stats
88
+
89
+
90
+ ### Documentation For Models
91
+
92
+ - [BodyChangePasswordProfileChangePasswordPost](docs/BodyChangePasswordProfileChangePasswordPost.md)
93
+ - [BuildStatusEnum](docs/BuildStatusEnum.md)
94
+ - [BuildTaskResponse](docs/BuildTaskResponse.md)
95
+ - [BuildTaskShortResponse](docs/BuildTaskShortResponse.md)
96
+ - [DeviceInternalResponse](docs/DeviceInternalResponse.md)
97
+ - [DeviceResponse](docs/DeviceResponse.md)
98
+ - [DeviceStatsResponse](docs/DeviceStatsResponse.md)
99
+ - [DeviceUpdateBody](docs/DeviceUpdateBody.md)
100
+ - [FFStatusEnum](docs/FFStatusEnum.md)
101
+ - [FFStatusResponse](docs/FFStatusResponse.md)
102
+ - [GlobalStatsAggregationModel](docs/GlobalStatsAggregationModel.md)
103
+ - [HTTPValidationError](docs/HTTPValidationError.md)
104
+ - [ListResponseReleaseResponse](docs/ListResponseReleaseResponse.md)
105
+ - [ListResponseShortDeviceResponse](docs/ListResponseShortDeviceResponse.md)
106
+ - [ListResponseShortReleaseResponse](docs/ListResponseShortReleaseResponse.md)
107
+ - [ListResponseStr](docs/ListResponseStr.md)
108
+ - [ListResponseUserShortResponse](docs/ListResponseUserShortResponse.md)
109
+ - [LogListResponse](docs/LogListResponse.md)
110
+ - [LogResponse](docs/LogResponse.md)
111
+ - [MaintainerShortModel](docs/MaintainerShortModel.md)
112
+ - [NewBuildTaskBody](docs/NewBuildTaskBody.md)
113
+ - [NewDeviceBody](docs/NewDeviceBody.md)
114
+ - [RecoveryImgResponse](docs/RecoveryImgResponse.md)
115
+ - [ReleaseGroupsResponse](docs/ReleaseGroupsResponse.md)
116
+ - [ReleaseInternalResponse](docs/ReleaseInternalResponse.md)
117
+ - [ReleaseInternalResponsePropValue](docs/ReleaseInternalResponsePropValue.md)
118
+ - [ReleaseResponse](docs/ReleaseResponse.md)
119
+ - [ReleaseStatsResponse](docs/ReleaseStatsResponse.md)
120
+ - [ReleaseType](docs/ReleaseType.md)
121
+ - [ReleaseUpdateBody](docs/ReleaseUpdateBody.md)
122
+ - [ReleasesSort](docs/ReleasesSort.md)
123
+ - [ResponseGetReleases](docs/ResponseGetReleases.md)
124
+ - [ShortDeviceResponse](docs/ShortDeviceResponse.md)
125
+ - [ShortReleaseResponse](docs/ShortReleaseResponse.md)
126
+ - [TaskUpdateBody](docs/TaskUpdateBody.md)
127
+ - [TokenResponse](docs/TokenResponse.md)
128
+ - [UserGitlab](docs/UserGitlab.md)
129
+ - [UserInternalResponse](docs/UserInternalResponse.md)
130
+ - [UserMail](docs/UserMail.md)
131
+ - [UserShortResponse](docs/UserShortResponse.md)
132
+ - [UserTelegram](docs/UserTelegram.md)
133
+ - [UserUpdateBody](docs/UserUpdateBody.md)
134
+ - [ValidationError](docs/ValidationError.md)
135
+ - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
136
+
137
+
138
+ <a id="documentation-for-authorization"></a>
139
+ ## Documentation For Authorization
140
+
141
+
142
+ Authentication schemes defined for the API:
143
+ <a id="bearer_auth"></a>
144
+ ### bearer_auth
145
+
146
+ - **Type**: Bearer authentication (JWT)
147
+
148
+ <a id="oauth2_password"></a>
149
+ ### oauth2_password
150
+
151
+ - **Type**: OAuth
152
+ - **Flow**: password
153
+ - **Authorization URL**:
154
+ - **Scopes**: N/A
155
+