uapi-browser-sdk 0.1.0

package/internal/docs/GetNetworkPingmyip200Response.md

@@ -0,0 +1,46 @@
+
+# GetNetworkPingmyip200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`avg` | number
+`code` | number
+`host` | string
+`ip` | string
+`location` | string
+`max` | number
+`min` | number
+
+## Example
+
+```typescript
+import type { GetNetworkPingmyip200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "avg": 35.4,
+  "code": 200,
+  "host": 123.123.123.123,
+  "ip": 123.123.123.123,
+  "location": 中国 北京,
+  "max": 40.1,
+  "min": 32.8,
+} satisfies GetNetworkPingmyip200Response
+
+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 GetNetworkPingmyip200Response
+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/internal/docs/GetNetworkPingmyip404Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkPingmyip404Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetNetworkPingmyip404Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": PING_FAILED,
+  "details": null,
+  "message": Ping operation failed. The host may not be reachable or is blocking ICMP requests.,
+} satisfies GetNetworkPingmyip404Response
+
+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 GetNetworkPingmyip404Response
+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/internal/docs/GetNetworkPortscan200Response.md

@@ -0,0 +1,42 @@
+
+# GetNetworkPortscan200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`ip` | string
+`port` | number
+`portStatus` | string
+`protocol` | string
+
+## Example
+
+```typescript
+import type { GetNetworkPortscan200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "ip": 1.2.3.4,
+  "port": 80,
+  "portStatus": open,
+  "protocol": tcp,
+} satisfies GetNetworkPortscan200Response
+
+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 GetNetworkPortscan200Response
+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/internal/docs/GetNetworkPortscan400Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkPortscan400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetNetworkPortscan400Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INVALID_ARGUMENT,
+  "details": null,
+  "message": Invalid parameters provided (e.g., port out of range).,
+} satisfies GetNetworkPortscan400Response
+
+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 GetNetworkPortscan400Response
+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/internal/docs/GetNetworkPortscan500Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkPortscan500Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetNetworkPortscan500Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": SCAN_FAILED,
+  "details": null,
+  "message": The port scan operation failed.,
+} satisfies GetNetworkPortscan500Response
+
+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 GetNetworkPortscan500Response
+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/internal/docs/GetNetworkUrlstatus200Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkUrlstatus200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`status` | number
+`url` | string
+
+## Example
+
+```typescript
+import type { GetNetworkUrlstatus200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "status": 200,
+  "url": https://www.google.com,
+} satisfies GetNetworkUrlstatus200Response
+
+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 GetNetworkUrlstatus200Response
+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/internal/docs/GetNetworkUrlstatus502Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkUrlstatus502Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetNetworkUrlstatus502Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": REQUEST_FAILED,
+  "details": null,
+  "message": Failed to request the URL. It might be down or unreachable.,
+} satisfies GetNetworkUrlstatus502Response
+
+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 GetNetworkUrlstatus502Response
+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/internal/docs/GetNetworkWhois200Response.md

@@ -0,0 +1,36 @@
+
+# GetNetworkWhois200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`whois` | object
+
+## Example
+
+```typescript
+import type { GetNetworkWhois200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "whois": {domain={id=12345678901234, domain=exa***.com, punycode=exa***.com, name=exa***, extension=com, whois_server=whois.***.com, status=[ok], name_servers=[ns1.***.com, ns2.***.com], created_date=2022-01-01T00:00:00Z, updated_date=2024-01-01T00:00:00Z, expiration_date=2026-01-01T00:00:00Z}, registrar={id=9999, name=*** Registrar LLC, phone=+86.1*********, email=redacted@***.com}, registrant={id=Not Available From Registry, name=REDACTED FOR PRIVACY, organization=REDACTED FOR PRIVACY, country=CN}},
+} satisfies GetNetworkWhois200Response
+
+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 GetNetworkWhois200Response
+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/internal/docs/GetNetworkWhois200ResponseOneOf.md

@@ -0,0 +1,40 @@
+
+# GetNetworkWhois200ResponseOneOf
+
+### 文本格式响应 当 `format=text` 或未指定时，`whois` 字段包含原始的WHOIS查询文本。这保留了最完整的信息，适合需要自行解析或展示原始数据的场景。
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`whois` | string
+
+## Example
+
+```typescript
+import type { GetNetworkWhois200ResponseOneOf } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "whois": Domain Name: GOOGLE.COM
+Registry Domain ID: 2138514_DOMAIN_COM-VRSN
+Registrar WHOIS Server: whois.markmonitor.com
+...,
+} satisfies GetNetworkWhois200ResponseOneOf
+
+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 GetNetworkWhois200ResponseOneOf
+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/internal/docs/GetNetworkWhois200ResponseOneOf1.md

@@ -0,0 +1,37 @@
+
+# GetNetworkWhois200ResponseOneOf1
+
+### JSON格式响应 当 `format=json` 时，`whois` 字段返回结构化的JSON对象。  > [!NOTE] > **注意**：返回的具体字段可能因域名注册局和隐私保护设置而异。某些敏感信息可能会被部分隐藏或标记为 `REDACTED FOR PRIVACY`。
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`whois` | object
+
+## Example
+
+```typescript
+import type { GetNetworkWhois200ResponseOneOf1 } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "whois": {"domain":{"id":12345678901234,"domain":"exa***.com","punycode":"exa***.com","name":"exa***","extension":"com","whois_server":"whois.***.com","status":["ok"],"name_servers":["ns1.***.com","ns2.***.com"],"created_date":"2022-01-01T00:00:00Z","updated_date":"2024-01-01T00:00:00Z","expiration_date":"2026-01-01T00:00:00Z"},"registrar":{"id":9999,"name":"*** Registrar LLC","phone":"+86.1*********","email":"redacted@***.com"},"registrant":{"id":"Not Available From Registry","name":"REDACTED FOR PRIVACY","organization":"REDACTED FOR PRIVACY","country":"CN"}},
+} satisfies GetNetworkWhois200ResponseOneOf1
+
+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 GetNetworkWhois200ResponseOneOf1
+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/internal/docs/GetNetworkWhois404Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkWhois404Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetNetworkWhois404Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": NOT_FOUND,
+  "details": null,
+  "message": WHOIS information not found for the domain.,
+} satisfies GetNetworkWhois404Response
+
+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 GetNetworkWhois404Response
+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/internal/docs/GetNetworkWxdomain200Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkWxdomain200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domain` | string
+`title` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { GetNetworkWxdomain200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domain": qq.com,
+  "title": 该网站可以正常访问,
+  "type": 1,
+} satisfies GetNetworkWxdomain200Response
+
+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 GetNetworkWxdomain200Response
+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/internal/docs/GetNetworkWxdomain502Response.md

@@ -0,0 +1,38 @@
+
+# GetNetworkWxdomain502Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetNetworkWxdomain502Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": UPSTREAM_ERROR,
+  "details": null,
+  "message": Failed to query upstream service for WeChat domain status.,
+} satisfies GetNetworkWxdomain502Response
+
+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 GetNetworkWxdomain502Response
+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/internal/docs/GetRandomImage404Response.md

@@ -0,0 +1,36 @@
+
+# GetRandomImage404Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { GetRandomImage404Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": NOT_FOUND,
+  "message": 未找到指定类别的图片。,
+} satisfies GetRandomImage404Response
+
+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 GetRandomImage404Response
+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/internal/docs/GetRandomImage500Response.md

@@ -0,0 +1,36 @@
+
+# GetRandomImage500Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { GetRandomImage500Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INTERNAL_SERVER_ERROR,
+  "message": 选择随机图片时发生错误。,
+} satisfies GetRandomImage500Response
+
+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 GetRandomImage500Response
+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/internal/docs/GetRandomString200Response.md

@@ -0,0 +1,36 @@
+
+# GetRandomString200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`text` | string
+
+## Example
+
+```typescript
+import type { GetRandomString200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "text": aK3fP7bQ9zRjT1vN,
+} satisfies GetRandomString200Response
+
+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 GetRandomString200Response
+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/internal/docs/GetRandomString400Response.md

@@ -0,0 +1,38 @@
+
+# GetRandomString400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`details` | object
+`message` | string
+
+## Example
+
+```typescript
+import type { GetRandomString400Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INVALID_ARGUMENT,
+  "details": null,
+  "message": Invalid parameter, e.g., length out of range [1, 1024].,
+} satisfies GetRandomString400Response
+
+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 GetRandomString400Response
+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)
+
+