@orangefox-recovery/[email protected]

A TypeScript SDK client for the api.orangefox.download API.

Usage

First, install the SDK from npm.

npm install @orangefox-recovery/foxinternalclient --save

Next, try it out.

import {
  Configuration,
  DeviceApi,
} from '@orangefox-recovery/foxinternalclient';
import type { GetDeviceRequest } from '@orangefox-recovery/foxinternalclient';

async function example() {
  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
  const api = new DeviceApi();

  const body = {
    // string (optional)
    deviceId: deviceId_example,
    // string | Filter by Device ID (deprecated) (optional)
    id: id_example,
    // string | Not recommended to use when you can (optional)
    codename: codename_example,
  } satisfies GetDeviceRequest;

  try {
    const data = await api.getDevice(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.orangefox.download

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- DeviceApi | getDevice | GET /devices/get | Get Device DeviceApi | getDeviceDeprecated | GET /devices/{device_id} | Get Device Short DeviceApi | getDevices | GET /devices/ | Get Devices DeviceApi | getOems | GET /oems/ | Get Oems FoxFactoryApi | cancelTaskFactoryTaskIdCancelPost | POST /factory/{task_id}/cancel | Cancel Task FoxFactoryApi | deleteTaskFactoryTaskIdDelete | DELETE /factory/{task_id} | Delete Task FoxFactoryApi | downloadArtifactFactoryTaskIdArtifactGet | GET /factory/{task_id}/artifact | Download Artifact FoxFactoryApi | factoryStatusFactoryStatusGet | GET /factory/status | Factory Status FoxFactoryApi | getTaskFactoryTaskIdGet | GET /factory/{task_id} | Get Task FoxFactoryApi | listTasksFactoryGet | GET /factory/ | List Tasks FoxFactoryApi | newTaskFactoryPost | POST /factory/ | New Task FoxFactoryApi | updateTaskFactoryTaskIdPatch | PATCH /factory/{task_id} | Update Task FoxFactoryApi | updateWorkerStatusFactoryUpdateStatusPost | POST /factory/update_status | Update Worker Status FoxFactoryApi | uploadArtifactFactoryTaskIdArtifactPost | POST /factory/{task_id}/artifact | Upload Artifact GitlabApi | deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost | POST /gitlab/device/{device_id}/gitlab | Device Add Gitlab Repo InternalApi | changePasswordProfileChangePasswordPost | POST /profile/change_password | Change Password InternalApi | delReleaseInternalReleasesReleaseIdDelete | DELETE /internal/releases/{release_id} | Del Release InternalApi | deleteDeviceInternalDevicesDeviceIdDelete | DELETE /internal/devices/{device_id} | Delete Device InternalApi | deletePasskeyProfilePasskeysCredentialIdDelete | DELETE /profile/passkeys/{credential_id} | Delete Passkey InternalApi | deletePasteInternalPastePasteIdDelete | DELETE /internal/paste/{paste_id} | Delete Paste InternalApi | deleteUserInternalUsersUserIdDelete | DELETE /internal/users/{user_id} | Delete User InternalApi | editReleaseInternalReleasesReleaseIdPut | PUT /internal/releases/{release_id} | Edit Release InternalApi | getDeviceInfoInternalDevicesDeviceIdGet | GET /internal/devices/{device_id} | Get Device Info InternalApi | getLogsInternalLogsGet | GET /internal/logs/ | Get Logs InternalApi | getReleaseInfoInternalReleasesReleaseIdGet | GET /internal/releases/{release_id} | Get Release Info InternalApi | getReleaseZipInternalReleasesReleaseIdDlGet | GET /internal/releases/{release_id}/dl | Get Release Zip InternalApi | getUserByIdInternalUsersUserIdGet | GET /internal/users/{user_id} | Get User By Id InternalApi | listPasskeysProfilePasskeysGet | GET /profile/passkeys | List Passkeys InternalApi | listPastesInternalPasteGet | GET /internal/paste/ | List Pastes InternalApi | listUsersInternalUsersGet | GET /internal/users/ | List Users InternalApi | loginOauthAuthLoginPost | POST /auth/login | Login Oauth InternalApi | logoutAuthLogoutPost | POST /auth/logout | Logout InternalApi | newDeviceInternalDevicesPost | POST /internal/devices/ | New Device InternalApi | newReleaseInternalReleasesPost | POST /internal/releases/ | New Release InternalApi | passkeyLoginOptionsAuthPasskeysLoginOptionsPost | POST /auth/passkeys/login/options | Passkey Login Options InternalApi | passkeyLoginVerifyAuthPasskeysLoginVerifyPost | POST /auth/passkeys/login/verify | Passkey Login Verify InternalApi | passkeyRegisterOptionsAuthPasskeysRegisterOptionsPost | POST /auth/passkeys/register/options | Passkey Register Options InternalApi | passkeyRegisterVerifyAuthPasskeysRegisterVerifyPost | POST /auth/passkeys/register/verify | Passkey Register Verify InternalApi | renamePasskeyProfilePasskeysCredentialIdRenamePost | POST /profile/passkeys/{credential_id}/rename | Rename Passkey InternalApi | renewAuthRenewPost | POST /auth/renew | Renew InternalApi | updateDeviceInternalDevicesDeviceIdPut | PUT /internal/devices/{device_id} | Update Device InternalApi | updatePasteInternalPastePasteIdPut | PUT /internal/paste/{paste_id} | Update Paste InternalApi | updateUserInternalUsersUserIdPut | PUT /internal/users/{user_id} | Update User PasteApi | createPastePastePost | POST /paste/ | Create Paste PasteApi | getPastePastePasteIdGet | GET /paste/{paste_id} | Get Paste ReleaseApi | getRelease | GET /releases/get | Get Release ReleaseApi | getReleaseDeprecated | GET /releases/{release_id} | Get Release Short ReleaseApi | getReleases | GET /releases/ | Get Releases ReleaseApi | getUpdatesDeprecated | GET /updates/{last_known_id} | Get Updates StatsApi | getPublicStats | GET /stats/ | Public Stats

Models

• BodyChangePasswordProfileChangePasswordPost
• BuildStatusEnum
• BuildTaskResponse
• BuildTaskShortResponse
• DeviceInternalResponse
• DeviceResponse
• DeviceStatsResponse
• DeviceUpdateBody
• FFStatusEnum
• FFStatusResponse
• GlobalStatsAggregationModel
• HTTPValidationError
• ListResponseBuildTaskShortResponse
• ListResponseReleaseResponse
• ListResponseShortDeviceResponse
• ListResponseShortReleaseResponse
• ListResponseStr
• ListResponseUserShortResponse
• LocationInner
• LogListResponse
• LogResponse
• MaintainerShortModel
• NewBuildTaskBody
• NewDeviceBody
• PasskeyCredentialResponse
• PasskeyOptionsResponse
• PasskeyRegisterOptionsRequest
• PasskeyVerifyRequest
• PasswordConfirmationBody
• PasteInput
• PasteOutput
• RecoveryImgResponse
• ReleaseGroupsResponse
• ReleaseInternalResponse
• ReleaseInternalResponsePropValue
• ReleaseResponse
• ReleaseStatsResponse
• ReleaseType
• ReleaseUpdateBody
• ReleasesSort
• RenamePasskeyBody
• ResponseGetReleases
• ShortDeviceResponse
• ShortReleaseResponse
• TaskUpdateBody
• TokenResponse
• UserGitlab
• UserInternalResponse
• UserMail
• UserShortResponse
• UserTelegram
• UserUpdateBody
• ValidationError

Authorization

Authentication schemes defined for the API:

bearer_auth

• Type: HTTP Bearer Token authentication (JWT)

oauth2_password password

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 5.4.0
• Package version: 5.4.0
• Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License