@orangefox-recovery/foxinternalclient 5.2.8 → 5.3.2

package/docs/GitlabApi.md

@@ -0,0 +1,78 @@
+# GitlabApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost**](GitlabApi.md#deviceaddgitlabrepogitlabdevicedeviceidgitlabpost) | **POST** /gitlab/device/{device_id}/gitlab | Device Add Gitlab Repo |
+
+
+
+## deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost
+
+> boolean deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(deviceId, glProjectUrl)
+
+Device Add Gitlab Repo
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GitlabApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { DeviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPostRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new GitlabApi();
+
+  const body = {
+    // string
+    deviceId: deviceId_example,
+    // string
+    glProjectUrl: glProjectUrl_example,
+  } satisfies DeviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPostRequest;
+
+  try {
+    const data = await api.deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+| **glProjectUrl** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/GlobalStatsAggregationModel.md

@@ -0,0 +1,40 @@
+
+# GlobalStatsAggregationModel
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`deviceCount` | number
+`releaseCount` | number
+`days` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { GlobalStatsAggregationModel } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": null,
+  "deviceCount": null,
+  "releaseCount": null,
+  "days": null,
+} satisfies GlobalStatsAggregationModel
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GlobalStatsAggregationModel
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/HTTPValidationError.md

@@ -0,0 +1,34 @@
+
+# HTTPValidationError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`detail` | [Array<ValidationError>](ValidationError.md)
+
+## Example
+
+```typescript
+import type { HTTPValidationError } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "detail": null,
+} satisfies HTTPValidationError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as HTTPValidationError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+