@orangefox-recovery/foxinternalclient 5.3.3 → 6.0.4

package/docs/GitlabApi.md

@@ -4,15 +4,17 @@ 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 |
+| [**addGitlabRepo**](GitlabApi.md#addgitlabrepo) | **POST** /gitlab/device/{device_id}/gitlab | POST /gitlab/device/{device_id}/gitlab?gl_project_url=<url> |
 
 
 
-## deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost
+## addGitlabRepo
 
-> boolean deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(deviceId, glProjectUrl)
+> boolean addGitlabRepo(deviceId, glProjectUrl)
 
-Device Add Gitlab Repo
+POST /gitlab/device/{device_id}/gitlab?gl_project_url=<url>
+
+Link a GitLab repo to a device.
 
 ### Example
 
@@ -21,21 +23,25 @@ import {
   Configuration,
   GitlabApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { DeviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPostRequest } from '@orangefox-recovery/foxinternalclient';
+import type { AddGitlabRepoRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
-  const api = new GitlabApi();
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new GitlabApi(config);
 
   const body = {
-    // string
+    // string | Device ID
     deviceId: deviceId_example,
     // string
     glProjectUrl: glProjectUrl_example,
-  } satisfies DeviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPostRequest;
+  } satisfies AddGitlabRepoRequest;
 
   try {
-    const data = await api.deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(body);
+    const data = await api.addGitlabRepo(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -51,7 +57,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **deviceId** | `string` |  | [Defaults to `undefined`] |
+| **deviceId** | `string` | Device ID | [Defaults to `undefined`] |
 | **glProjectUrl** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
@@ -60,19 +66,20 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[bearer_auth](../README.md#bearer_auth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `text/plain`, `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **422** | Validation Error |  -  |
+| **200** | GitLab repo linked |  -  |
+| **400** | Bad request |  -  |
+| **404** | Not found |  -  |
 
 [[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 → GlobalStatsResponse.md}

@@ -1,5 +1,5 @@
 
-# GlobalStatsAggregationModel
+# GlobalStatsResponse
 
 
 ## Properties
@@ -7,22 +7,22 @@
 Name | Type
 ------------ | -------------
 `count` | number
+`days` | { [key: string]: number; }
 `deviceCount` | number
 `releaseCount` | number
-`days` | { [key: string]: number; }
 
 ## Example
 
 ```typescript
-import type { GlobalStatsAggregationModel } from '@orangefox-recovery/foxinternalclient'
+import type { GlobalStatsResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
   "count": null,
+  "days": null,
   "deviceCount": null,
   "releaseCount": null,
-  "days": null,
-} satisfies GlobalStatsAggregationModel
+} satisfies GlobalStatsResponse
 
 console.log(example)
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GlobalStatsAggregationModel
+const exampleParsed = JSON.parse(exampleJSON) as GlobalStatsResponse
 console.log(exampleParsed)
 ```