@orangefox-recovery/foxinternalclient 5.3.3 → 6.0.4

package/docs/PasskeyCredentialResponse.md

@@ -0,0 +1,47 @@
+
+# PasskeyCredentialResponse
+
+JSON response for a single passkey credential.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`backedUp` | boolean
+`createdAt` | string
+`deviceType` | string
+`id` | string
+`lastUsedAt` | string
+`nickname` | string
+`transports` | Array<string>
+
+## Example
+
+```typescript
+import type { PasskeyCredentialResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "backedUp": null,
+  "createdAt": null,
+  "deviceType": null,
+  "id": null,
+  "lastUsedAt": null,
+  "nickname": null,
+  "transports": null,
+} satisfies PasskeyCredentialResponse
+
+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 PasskeyCredentialResponse
+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/PasskeyRegisterOptionsRequest.md

@@ -0,0 +1,35 @@
+
+# PasskeyRegisterOptionsRequest
+
+Request body for passkey registration options (password confirmation).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`password` | string
+
+## Example
+
+```typescript
+import type { PasskeyRegisterOptionsRequest } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "password": null,
+} satisfies PasskeyRegisterOptionsRequest
+
+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 PasskeyRegisterOptionsRequest
+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/PasskeyVerifyRequest.md

@@ -0,0 +1,39 @@
+
+# PasskeyVerifyRequest
+
+Request body for passkey registration/login verification.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`credential` | object
+`nickname` | string
+`requestId` | string
+
+## Example
+
+```typescript
+import type { PasskeyVerifyRequest } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "credential": null,
+  "nickname": null,
+  "requestId": null,
+} satisfies PasskeyVerifyRequest
+
+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 PasskeyVerifyRequest
+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/PasteApi.md

@@ -4,18 +4,16 @@ All URIs are relative to *https://api.orangefox.download*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**createPastePastePost**](PasteApi.md#createpastepastepost) | **POST** /paste/ | Create Paste |
-| [**getPastePastePasteIdGet**](PasteApi.md#getpastepastepasteidget) | **GET** /paste/{paste_id} | Get Paste |
+| [**createPaste**](PasteApi.md#createpaste) | **POST** /paste | POST /paste/ - Create a new paste. |
+| [**getPaste**](PasteApi.md#getpaste) | **GET** /paste/{paste_id} | GET /paste/{paste_id} - Get a paste by ID. |
 
 
 
-## createPastePastePost
+## createPaste
 
-> PasteOutput createPastePastePost(pasteInput)
+> PasteResponse createPaste(pasteInput)
 
-Create Paste
-
-Create a new paste.
+POST /paste/ - Create a new paste.
 
 ### Example
 
@@ -24,7 +22,7 @@ import {
   Configuration,
   PasteApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { CreatePastePastePostRequest } from '@orangefox-recovery/foxinternalclient';
+import type { CreatePasteRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
@@ -33,10 +31,10 @@ async function example() {
   const body = {
     // PasteInput
     pasteInput: ...,
-  } satisfies CreatePastePastePostRequest;
+  } satisfies CreatePasteRequest;
 
   try {
-    const data = await api.createPastePastePost(body);
+    const data = await api.createPaste(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -56,7 +54,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**PasteOutput**](PasteOutput.md)
+[**PasteResponse**](PasteResponse.md)
 
 ### Authorization
 
@@ -71,20 +69,18 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **201** | Successful Response |  -  |
-| **429** | Too many requests |  -  |
-| **422** | Validation Error |  -  |
+| **201** | Paste created |  -  |
+| **400** | Bad request |  -  |
+| **500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getPastePastePasteIdGet
-
-> PasteOutput getPastePastePasteIdGet(pasteId)
+## getPaste
 
-Get Paste
+> PasteResponse getPaste(pasteId)
 
-Get a paste by ID.
+GET /paste/{paste_id} - Get a paste by ID.
 
 ### Example
 
@@ -93,19 +89,19 @@ import {
   Configuration,
   PasteApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { GetPastePastePasteIdGetRequest } from '@orangefox-recovery/foxinternalclient';
+import type { GetPasteRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
   const api = new PasteApi();
 
   const body = {
-    // string
+    // string | Paste ID
     pasteId: pasteId_example,
-  } satisfies GetPastePastePasteIdGetRequest;
+  } satisfies GetPasteRequest;
 
   try {
-    const data = await api.getPastePastePasteIdGet(body);
+    const data = await api.getPaste(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -121,11 +117,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **pasteId** | `string` |  | [Defaults to `undefined`] |
+| **pasteId** | `string` | Paste ID | [Defaults to `undefined`] |
 
 ### Return type
 
-[**PasteOutput**](PasteOutput.md)
+[**PasteResponse**](PasteResponse.md)
 
 ### Authorization
 
@@ -140,10 +136,10 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **404** | Item not found |  -  |
-| **429** | Too many requests |  -  |
-| **422** | Validation Error |  -  |
+| **200** | Paste details |  -  |
+| **400** | Invalid paste ID format |  -  |
+| **404** | Not found |  -  |
+| **500** | Internal server 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/{PasteOutput.md → PasteResponse.md}

@@ -1,28 +1,28 @@
 
-# PasteOutput
+# PasteResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
 `content` | string
-`createdAt` | Date
+`createdAt` | string
+`id` | string
 `isOwner` | boolean
 
 ## Example
 
 ```typescript
-import type { PasteOutput } from '@orangefox-recovery/foxinternalclient'
+import type { PasteResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
   "content": null,
   "createdAt": null,
+  "id": null,
   "isOwner": null,
-} satisfies PasteOutput
+} satisfies PasteResponse
 
 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 PasteOutput
+const exampleParsed = JSON.parse(exampleJSON) as PasteResponse
 console.log(exampleParsed)
 ```
 

package/docs/RecoveryImgResponse.md

@@ -6,8 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`size` | number
 `md5` | string
+`size` | number
 
 ## Example
 
@@ -16,8 +16,8 @@ import type { RecoveryImgResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "size": null,
   "md5": null,
+  "size": null,
 } satisfies RecoveryImgResponse
 
 console.log(example)