uapi-browser-sdk 0.1.0

package/internal/docs/ClipzyApi.md

@@ -0,0 +1,222 @@
+# ClipzyApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getClipzyGet**](ClipzyApi.md#getclipzyget) | **GET** /api/get | 步骤2 (方法一): 获取加密数据 |
+| [**getClipzyRaw**](ClipzyApi.md#getclipzyraw) | **GET** /api/raw/{id} | 步骤2 (方法二): 获取原始文本 |
+| [**postClipzyStore**](ClipzyApi.md#postclipzystoreoperation) | **POST** /api/store | 步骤1：上传加密数据 |
+
+
+
+## getClipzyGet
+
+> GetClipzyGet200Response getClipzyGet(id)
+
+步骤2 (方法一): 获取加密数据
+
+**此接口用于“最高安全等级”方法。**  您提供第一步中获得的ID，它会返回存储在服务器上的**加密数据**。您需要在自己的客户端中，使用您自己保管的密钥来解密它。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClipzyApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetClipzyGetRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new ClipzyApi();
+
+  const body = {
+    // string | 片段的唯一 ID。
+    id: PREF0Zv8Yj,
+  } satisfies GetClipzyGetRequest;
+
+  try {
+    const data = await api.getClipzyGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | 片段的唯一 ID。 | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetClipzyGet200Response**](GetClipzyGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 获取成功！返回加密并压缩后的数据。 |  -  |
+| **400** | 请求参数错误，通常是缺少 `id` 参数。 |  -  |
+| **404** | 片段未找到。它可能已过期、被删除或ID不正确。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getClipzyRaw
+
+> string getClipzyRaw(id, key)
+
+步骤2 (方法二): 获取原始文本
+
+**此接口用于“方便自动化”方法。**  您提供第一步获得的ID，并附上您自己保管的**解密密钥**作为 `key` 参数。服务器会直接为您解密，并返回纯文本内容。  > [!IMPORTANT] > 查看文档首页的 **cURL 示例**，了解此接口最典型的用法。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClipzyApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetClipzyRawRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new ClipzyApi();
+
+  const body = {
+    // string | 片段的唯一 ID。
+    id: PREF0Zv8Yj,
+    // string | 用于解密的 Base64 编码的 AES 密钥。
+    key: ES9tGP0v3e7oqzmAk3vMboxVOOBlvw9RS3DszeW675k=,
+  } satisfies GetClipzyRawRequest;
+
+  try {
+    const data = await api.getClipzyRaw(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | 片段的唯一 ID。 | [Defaults to `undefined`] |
+| **key** | `string` | 用于解密的 Base64 编码的 AES 密钥。 | [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 解密并获取成功！响应体为纯文本内容。 |  -  |
+| **400** | 请求参数错误，缺少 ID 或密钥。 |  -  |
+| **403** | 禁止访问。提供的密钥无法解密对应的数据。 |  -  |
+| **404** | 片段未找到。它可能已过期、被删除或ID不正确。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postClipzyStore
+
+> PostClipzyStore200Response postClipzyStore(postClipzyStoreRequest)
+
+步骤1：上传加密数据
+
+这是所有流程的第一步。您的客户端应用需要先在本地准备好 **加密后的数据**，然后调用此接口进行上传。成功后，您会得到一个用于后续操作的唯一ID。  > [!NOTE] > 您发送给此接口的应该是**密文**，而不是原始文本。请参考文档首页的JavaScript示例来了解如何在客户端进行加密。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClipzyApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostClipzyStoreOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new ClipzyApi();
+
+  const body = {
+    // PostClipzyStoreRequest | 包含加密数据和可选的TTL。
+    postClipzyStoreRequest: ...,
+  } satisfies PostClipzyStoreOperationRequest;
+
+  try {
+    const data = await api.postClipzyStore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postClipzyStoreRequest** | [PostClipzyStoreRequest](PostClipzyStoreRequest.md) | 包含加密数据和可选的TTL。 | |
+
+### Return type
+
+[**PostClipzyStore200Response**](PostClipzyStore200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 片段创建成功！返回该片段的唯一ID。 |  -  |
+| **400** | 请求体缺失、格式错误或参数无效。 |  -  |
+| **413** | 请求体过大。上传的数据（压缩后）超过了服务器限制。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/internal/docs/ConvertApi.md

@@ -0,0 +1,146 @@
+# ConvertApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getConvertUnixtime**](ConvertApi.md#getconvertunixtime) | **GET** /convert/unixtime | Unix时间戳与日期字符串双向转换 |
+| [**postConvertJson**](ConvertApi.md#postconvertjsonoperation) | **POST** /convert/json | 美化并格式化JSON字符串 |
+
+
+
+## getConvertUnixtime
+
+> GetConvertUnixtime200Response getConvertUnixtime(time)
+
+Unix时间戳与日期字符串双向转换
+
+时间戳和日期字符串，哪个用着更顺手？别纠结了，这个接口让你轻松拥有两种格式！  ## 功能概述 这是一个非常智能的转换器。你给它一个 Unix 时间戳，它还你一个人类可读的日期时间；你给它一个日期时间字符串，它还你一个 Unix 时间戳。它会自动识别你输入的是哪种格式。  ## 使用须知 这个接口非常智能，能够自动识别输入格式：  - **输入时间戳**：支持10位秒级（如 `1672531200`）和13位毫秒级（如 `1672531200000`）。 - **输入日期字符串**：为了确保准确性，推荐使用 `YYYY-MM-DD HH:mm:ss` 标准格式（如 `2023-01-01 08:00:00`）。  > [!TIP] > 无论你输入哪种格式，响应中都会同时包含标准日期字符串和秒级Unix时间戳，方便你按需取用。  ## 错误处理指南 - **400 Bad Request**: 如果你提供的 `time` 参数既不是有效的时间戳，也不是我们支持的日期格式，就会收到这个错误。请检查你的输入值。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ConvertApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetConvertUnixtimeRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new ConvertApi();
+
+  const body = {
+    // string | 一个智能时间参数，可传入Unix时间戳（10位或13位）或标准日期字符串（如 \'2023-10-27 10:30:00\'），系统将自动识别并转换。
+    time: 1698380645,
+  } satisfies GetConvertUnixtimeRequest;
+
+  try {
+    const data = await api.getConvertUnixtime(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **time** | `string` | 一个智能时间参数，可传入Unix时间戳（10位或13位）或标准日期字符串（如 \'2023-10-27 10:30:00\'），系统将自动识别并转换。 | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetConvertUnixtime200Response**](GetConvertUnixtime200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 转换成功！响应中会同时包含标准日期字符串和秒级Unix时间戳，方便你使用。 |  -  |
+| **400** | 请求失败。请检查你提供的 `time` 参数是否是有效的时间戳或我们支持的日期格式（YYYY-MM-DD HH:mm:ss）。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postConvertJson
+
+> PostConvertJson200Response postConvertJson(postConvertJsonRequest)
+
+美化并格式化JSON字符串
+
+还在为一团乱麻的 JSON 字符串头疼吗？这个接口能瞬间让它变得井井有条，赏心悦目。  ## 功能概述 你只需要提供一个原始的、可能是压缩过的或者格式混乱的 JSON 字符串，这个 API 就会返回一个经过美化（带标准缩进和换行）的版本。这在调试 API 响应、或者需要在前端界面清晰展示 JSON 数据时非常有用。  ## 使用须知 > [!NOTE] > **请求格式** > 请注意，待格式化的 JSON 字符串需要被包裹在另一个 JSON 对象中，作为 `content` 字段的值提交。具体格式请参考请求体示例。  ## 错误处理指南 - **400 Bad Request**: 最常见的原因是你提供的 `content` 字符串本身不是一个有效的 JSON。请仔细检查括号、引号是否正确闭合，或者有没有多余的逗号等语法错误。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ConvertApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostConvertJsonOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new ConvertApi();
+
+  const body = {
+    // PostConvertJsonRequest | 这是一个JSON对象，里面必须包含一个名为 `content` 的字段。这个字段的值，就是你希望格式化的、原始的JSON字符串。
+    postConvertJsonRequest: ...,
+  } satisfies PostConvertJsonOperationRequest;
+
+  try {
+    const data = await api.postConvertJson(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postConvertJsonRequest** | [PostConvertJsonRequest](PostConvertJsonRequest.md) | 这是一个JSON对象，里面必须包含一个名为 `content` 的字段。这个字段的值，就是你希望格式化的、原始的JSON字符串。 | |
+
+### Return type
+
+[**PostConvertJson200Response**](PostConvertJson200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 格式化成功！返回一个包含美化后JSON字符串的对象。 |  -  |
+| **400** | 请求失败。这通常意味着你提供的 `content` 字符串不是一个合法的JSON格式。请检查括号、引号是否匹配，以及末尾是否有多余的逗号等常见错误。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/internal/docs/DailyApi.md

@@ -0,0 +1,70 @@
+# DailyApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDailyNewsImage**](DailyApi.md#getdailynewsimage) | **GET** /daily/news-image | 生成每日新闻摘要图片 |
+
+
+
+## getDailyNewsImage
+
+> Blob getDailyNewsImage()
+
+生成每日新闻摘要图片
+
+想用一张图快速了解天下大事？这个接口为你一键生成今日新闻摘要，非常适合用在早报、数字看板或应用首页等场景。  ## 功能概述 此接口会实时抓取各大平台的热点新闻，并动态地将它们渲染成一张清晰、美观的摘要图片。你调用接口，直接就能得到一张可以展示的图片。  ## 使用须知 调用此接口时，请务必注意以下两点：  1.  **响应格式是图片**：接口成功时直接返回 `image/jpeg` 格式的二进制数据，而非 JSON。请确保你的客户端能正确处理二进制流，例如直接在 `<img>` 标签中显示，或保存为 `.jpg` 文件。  2.  **设置合理超时**：由于涉及实时新闻抓取和图片渲染，处理过程可能耗时数秒。建议将客户端请求超时时间设置为至少10秒，以防止因等待过久而失败。  > [!IMPORTANT] > 未能正确处理图片响应或超时设置过短，是导致调用失败的最常见原因。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DailyApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetDailyNewsImageRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new DailyApi();
+
+  try {
+    const data = await api.getDailyNewsImage();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/jpeg`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 请求成功！响应体是JPEG格式的图片二进制数据。你可以直接将其显示或保存为图片文件。 |  -  |
+| **500** | 服务器内部错误。这可能是我们的图片渲染服务遇到了临时故障。我们已经被自动通知，请稍后重试。 |  -  |
+| **502** | 上游服务错误。我们在尝试从新闻源（如微博、知乎等）获取数据时失败了。这可能是因为上游服务暂时不可用或更改了接口。这个问题通常很快会解决，请稍后重试。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+