unifyport

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 29, 2026 License: MIT Imports: 12 Imported by: 0

README

UnifyPort Go SDK

English | 简体中文 | Website | Security | MIT License

CI

The contract-first Go SDK for the public UnifyPort Device API. It provides an idiomatic Client, generated operation/model coverage, a security-focused HTTP runtime, typed errors, safe response metadata, and bounded cursor pagination.

The current public baseline covers 64 operations, 69 component schemas, and 11 resource groups. Routes under /v1/accounts/... manage provider-account resources but remain part of the same Device API client.

Capabilities and boundaries

Asset Purpose Boundary
package unifyport Public client, models, results, errors, options, and pager The supported consumer API
contracts/device.openapi.yaml Approved public Device API wire contract The only protocol-generation input
internal/wire Generated OpenAPI HTTP client and models Cannot be imported by consumers
secure runtime Authentication, URL scope, redirect, timeout, retry, limits, and parsing Every public operation passes through it
parity manifest Operation/schema and Node behavior mapping Generated; never a second protocol definition

This repository intentionally does not provide a generic raw request method, arbitrary authentication headers, MCP server, provider-specific authorization orchestration, or a webhook signature algorithm that is absent from the public contract.

Requirements

  • the latest security patch in the supported Go 1.25 or 1.26 release line;
  • a Device API base URL;
  • a Device API key with the minimum required workspace permissions.

Installation

go get github.com/Unify-Port/UnifyPort-SDK-GO@latest

Applications should replace @latest with a reviewed tag and commit both go.mod and go.sum. The default branch is development state; only a published tag is a release.

Quick start

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	unifyport "github.com/Unify-Port/UnifyPort-SDK-GO"
)

func main() {
	client, err := unifyport.NewClient(unifyport.Config{
		BaseURL: requiredEnv("UNIFYPORT_DEVICE_API_BASE_URL"),
		APIKeyProvider: unifyport.StaticAPIKey(
			requiredEnv("UNIFYPORT_DEVICE_API_KEY"),
		),
	})
	if err != nil {
		log.Fatal(err)
	}

	result, err := client.GetWorkspace(context.Background())
	if err != nil {
		log.Fatal(err)
	}

	// Print filtered diagnostics only; business data may be sensitive.
	fmt.Printf("status=%d request_id=%s\n", result.StatusCode, result.RequestID)
}

func requiredEnv(name string) string {
	value, ok := os.LookupEnv(name)
	if !ok || value == "" {
		log.Fatalf("missing required environment variable: %s", name)
	}
	return value
}

See Getting started and the compile-checked examples/getting-started program for the full setup. Credentials come only from Config.APIKeyProvider; operation input cannot override X-Api-Key.

Safe defaults

Behavior Default
HTTPS Required; explicit loopback HTTP only for local tests
Redirects Never followed automatically
Logical-operation timeout 30 seconds
Response limit 8 MiB, with a 64 MiB hard configuration limit
Additional retry attempts 2, only for 19 explicitly safe operations
Retry statuses 408, 429, 502, 503, 504, plus transport failures
Pagination maximum 10,000 pages by default, with repeated/missing cursor detection

The API-key provider runs once per logical operation and its result is reused across attempts. Per-call options can cancel, disable, or tighten timeout/retry budgets; they cannot expand client limits or make an unsafe operation retry.

The timeout budget starts when executeOperation begins execution and covers synchronous request construction/marshaling, credential lookup, HTTP attempts, retry backoff, bounded response reading, and response parsing. Synchronous build and parse work cannot be safely preempted; after either returns, an expired deadline produces TimeoutError and any apparent success is discarded.

Results and errors

Every operation returns Result[T]. Data, RequestID, and ClientRequestID preserve all fields in the current public success envelope; StatusCode and the allowlisted HeaderSnapshot add safe transport metadata. No raw response/body or unrestricted header map is exposed. 204 operations use the explicit NoContent type.

Typed configuration, network, timeout, cancellation, API, response-parse, and pagination errors support idiomatic errors.As/errors.Is. Public API errors contain only filtered status, code, request ID, and operation ID; raw upstream messages, details, bodies, headers, provider errors, and causes are omitted.

See Error handling before adding application logging. A successful Data value can still contain business data or a one-time secret and must not be logged wholesale.

API and model discovery

  • API coverage maps all 64 operation IDs to Go methods, paths, retry, and data classifications.
  • parity/manifest.gen.json records generated request/response types, statuses, schema references, and all 69 component-to-Go mappings.
  • contracts/device.openapi.yaml is authoritative for protocol fields and descriptions.
  • go doc github.com/Unify-Port/UnifyPort-SDK-GO shows the public Go declarations.

Do not import internal/wire or construct paths manually.

Validation

go generate ./...
git diff --exit-code
go mod tidy -diff
go -C internal/generator mod tidy -diff
unformatted="$(gofmt -l $(git ls-files '*.go'))"
test -z "${unformatted}"
go test ./...
go -C internal/generator test ./...
go test -race ./...
go -C internal/generator test -race ./...
go vet ./...
go -C internal/generator vet ./...
go run honnef.co/go/tools/cmd/staticcheck@v0.7.0 ./...
go -C internal/generator run honnef.co/go/tools/cmd/staticcheck@v0.7.0 ./...
go run golang.org/x/vuln/cmd/govulncheck@v1.6.0 ./...
go -C internal/generator run golang.org/x/vuln/cmd/govulncheck@v1.6.0 ./...
bash scripts/check-public-test.sh
bash scripts/check-public-docs.sh
bash scripts/check-public.sh
git diff --check

Generation must also leave git status --short empty so new untracked artifacts cannot escape the diff gate. GitHub Actions runs the latest available patches in the Go 1.25 and 1.26 lines.

Repository structure

.
├── contracts/          # Approved public OpenAPI contract
├── codegen/            # Pinned Go generation config and Go-only overlay
├── internal/
│   ├── generator/      # Deterministic generator in an isolated nested Go module
│   ├── transport/      # Security-focused HTTP runtime
│   └── wire/           # Generated OpenAPI client; never public
├── policy/             # Language-neutral operation classifications
├── parity/             # Public Node baseline and generated manifest
├── docs/               # Canonical English and complete Simplified Chinese guides
├── examples/           # Compile-checked safe examples
└── *.go                # Public unifyport package and generated facade/models

internal/generator/go.mod pins the generation toolchain separately from the public runtime module. The root module contains only generated runtime code and its runtime dependencies: it does not embed the OpenAPI document or add generator libraries to a consumer's module graph.

Documentation

Real staging/provider end-to-end verification is a separate release gate. Offline tests, generated coverage, or a health response do not prove account authorization or provider success.

Documentation

Overview

Package unifyport 提供 UnifyPort Device API 的类型安全客户端、经筛选的返回元数据和有界分页。

所有公开 operation 都通过统一的鉴权、timeout、retry、响应大小和错误脱敏边界执行。 底层 OpenAPI wire client 位于 internal 包，不属于受支持的消费方 API。

Index

Constants

View Source 
const (
	// DefaultTimeout 是一个完整逻辑调用（包含 credential、retry 和响应读取）的默认上限。
	DefaultTimeout = transport.DefaultTimeout
	// DefaultMaxResponseBytes 在 JSON 解析前限制异常上游占用的内存。
	DefaultMaxResponseBytes = transport.DefaultMaxResponseBytes
	// MaximumResponseBytes 是公开配置不可突破的硬上限。
	MaximumResponseBytes = transport.MaximumResponseBytes
	// DefaultMaxRetries 表示首次请求之后最多再尝试的次数。
	DefaultMaxRetries = transport.DefaultMaxRetries
)
View Source 
const (
	// APIKeyStatusActive 是 APIKeyStatus 的受支持枚举值。
	APIKeyStatusActive APIKeyStatus = wire.APIKeyStatusActive
	// APIKeyStatusInactive 是 APIKeyStatus 的受支持枚举值。
	APIKeyStatusInactive APIKeyStatus = wire.APIKeyStatusInactive
	// APIKeyStatusUpdateRequestStatusActive 是 APIKeyStatusUpdateRequestStatus 的受支持枚举值。
	APIKeyStatusUpdateRequestStatusActive APIKeyStatusUpdateRequestStatus = wire.APIKeyStatusUpdateRequestStatusActive
	// APIKeyStatusUpdateRequestStatusInactive 是 APIKeyStatusUpdateRequestStatus 的受支持枚举值。
	APIKeyStatusUpdateRequestStatusInactive APIKeyStatusUpdateRequestStatus = wire.APIKeyStatusUpdateRequestStatusInactive
	// ConversationLabelDeleteResultDeletedTrue 是 ConversationLabelDeleteResultDeleted 的受支持枚举值。
	ConversationLabelDeleteResultDeletedTrue ConversationLabelDeleteResultDeleted = wire.ConversationLabelDeleteResultDeletedTrue
	// ConversationLabelMembersRequestActionAdd 是 ConversationLabelMembersRequestAction 的受支持枚举值。
	ConversationLabelMembersRequestActionAdd ConversationLabelMembersRequestAction = wire.ConversationLabelMembersRequestActionAdd
	// ConversationLabelMembersRequestActionRemove 是 ConversationLabelMembersRequestAction 的受支持枚举值。
	ConversationLabelMembersRequestActionRemove ConversationLabelMembersRequestAction = wire.ConversationLabelMembersRequestActionRemove
	// ConversationLabelMembersResultActionAdd 是 ConversationLabelMembersResultAction 的受支持枚举值。
	ConversationLabelMembersResultActionAdd ConversationLabelMembersResultAction = wire.ConversationLabelMembersResultActionAdd
	// ConversationLabelMembersResultActionRemove 是 ConversationLabelMembersResultAction 的受支持枚举值。
	ConversationLabelMembersResultActionRemove ConversationLabelMembersResultAction = wire.ConversationLabelMembersResultActionRemove
	// ConversationTypeChannel 是 ConversationType 的受支持枚举值。
	ConversationTypeChannel ConversationType = wire.ConversationTypeChannel
	// ConversationTypeGroup 是 ConversationType 的受支持枚举值。
	ConversationTypeGroup ConversationType = wire.ConversationTypeGroup
	// ConversationTypeUser 是 ConversationType 的受支持枚举值。
	ConversationTypeUser ConversationType = wire.ConversationTypeUser
	// GroupJoinRequestsUpdateRequestActionApprove 是 GroupJoinRequestsUpdateRequestAction 的受支持枚举值。
	GroupJoinRequestsUpdateRequestActionApprove GroupJoinRequestsUpdateRequestAction = wire.Approve
	// GroupJoinRequestsUpdateRequestActionReject 是 GroupJoinRequestsUpdateRequestAction 的受支持枚举值。
	GroupJoinRequestsUpdateRequestActionReject GroupJoinRequestsUpdateRequestAction = wire.Reject
	// GroupMemberUpdateRequestActionAdd 是 GroupMemberUpdateRequestAction 的受支持枚举值。
	GroupMemberUpdateRequestActionAdd GroupMemberUpdateRequestAction = wire.GroupMemberUpdateRequestActionAdd
	// GroupMemberUpdateRequestActionDemote 是 GroupMemberUpdateRequestAction 的受支持枚举值。
	GroupMemberUpdateRequestActionDemote GroupMemberUpdateRequestAction = wire.GroupMemberUpdateRequestActionDemote
	// GroupMemberUpdateRequestActionPromote 是 GroupMemberUpdateRequestAction 的受支持枚举值。
	GroupMemberUpdateRequestActionPromote GroupMemberUpdateRequestAction = wire.GroupMemberUpdateRequestActionPromote
	// GroupMemberUpdateRequestActionRemove 是 GroupMemberUpdateRequestAction 的受支持枚举值。
	GroupMemberUpdateRequestActionRemove GroupMemberUpdateRequestAction = wire.GroupMemberUpdateRequestActionRemove
	// MessagePayloadTypeAudio 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeAudio MessagePayloadType = wire.MessagePayloadTypeAudio
	// MessagePayloadTypeContact 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeContact MessagePayloadType = wire.MessagePayloadTypeContact
	// MessagePayloadTypeDocument 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeDocument MessagePayloadType = wire.MessagePayloadTypeDocument
	// MessagePayloadTypeFile 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeFile MessagePayloadType = wire.MessagePayloadTypeFile
	// MessagePayloadTypeImage 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeImage MessagePayloadType = wire.MessagePayloadTypeImage
	// MessagePayloadTypeText 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeText MessagePayloadType = wire.MessagePayloadTypeText
	// MessagePayloadTypeVideo 是 MessagePayloadType 的受支持枚举值。
	MessagePayloadTypeVideo MessagePayloadType = wire.MessagePayloadTypeVideo
	// OkDataOkTrue 是 OkDataOk 的受支持枚举值。
	OkDataOkTrue OkDataOk = wire.OkDataOkTrue
	// ProviderNameLine 是 ProviderName 的受支持枚举值。
	ProviderNameLine ProviderName = wire.Line
	// ProviderNameTelegram 是 ProviderName 的受支持枚举值。
	ProviderNameTelegram ProviderName = wire.Telegram
	// ProviderNameTiktok 是 ProviderName 的受支持枚举值。
	ProviderNameTiktok ProviderName = wire.Tiktok
	// ProviderNameTwitter 是 ProviderName 的受支持枚举值。
	ProviderNameTwitter ProviderName = wire.Twitter
	// ProviderNameWhatsapp 是 ProviderName 的受支持枚举值。
	ProviderNameWhatsapp ProviderName = wire.Whatsapp
	// ProviderNameX 是 ProviderName 的受支持枚举值。
	ProviderNameX ProviderName = wire.X
	// ProviderNameZalo 是 ProviderName 的受支持枚举值。
	ProviderNameZalo ProviderName = wire.Zalo
	// RuntimeActionResultActionReconnect 是 RuntimeActionResultAction 的受支持枚举值。
	RuntimeActionResultActionReconnect RuntimeActionResultAction = wire.Reconnect
	// RuntimeActionResultActionRefreshStatus 是 RuntimeActionResultAction 的受支持枚举值。
	RuntimeActionResultActionRefreshStatus RuntimeActionResultAction = wire.RefreshStatus
	// RuntimeActionResultActionStart 是 RuntimeActionResultAction 的受支持枚举值。
	RuntimeActionResultActionStart RuntimeActionResultAction = wire.Start
	// RuntimeActionResultActionStop 是 RuntimeActionResultAction 的受支持枚举值。
	RuntimeActionResultActionStop RuntimeActionResultAction = wire.Stop
	// RuntimeStatusDisconnected 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusDisconnected RuntimeStatus = wire.RuntimeStatusDisconnected
	// RuntimeStatusError 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusError RuntimeStatus = wire.RuntimeStatusError
	// RuntimeStatusReconnecting 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusReconnecting RuntimeStatus = wire.RuntimeStatusReconnecting
	// RuntimeStatusRunning 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusRunning RuntimeStatus = wire.RuntimeStatusRunning
	// RuntimeStatusStarting 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusStarting RuntimeStatus = wire.RuntimeStatusStarting
	// RuntimeStatusStopped 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusStopped RuntimeStatus = wire.RuntimeStatusStopped
	// RuntimeStatusStopping 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusStopping RuntimeStatus = wire.RuntimeStatusStopping
	// RuntimeStatusUnknown 是 RuntimeStatus 的受支持枚举值。
	RuntimeStatusUnknown RuntimeStatus = wire.RuntimeStatusUnknown
	// StandardEventTypeAccountAuthFailed 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAccountAuthFailed StandardEventType = wire.StandardEventTypeAccountAuthFailed
	// StandardEventTypeAccountAuthRequired 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAccountAuthRequired StandardEventType = wire.StandardEventTypeAccountAuthRequired
	// StandardEventTypeAccountAuthSucceeded 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAccountAuthSucceeded StandardEventType = wire.StandardEventTypeAccountAuthSucceeded
	// StandardEventTypeAccountHistorySynced 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAccountHistorySynced StandardEventType = wire.StandardEventTypeAccountHistorySynced
	// StandardEventTypeAccountStarted 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAccountStarted StandardEventType = wire.StandardEventTypeAccountStarted
	// StandardEventTypeAccountStatusUpdated 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAccountStatusUpdated StandardEventType = wire.StandardEventTypeAccountStatusUpdated
	// StandardEventTypeAsterisk 是 StandardEventType 的受支持枚举值。
	StandardEventTypeAsterisk StandardEventType = wire.StandardEventTypeAsterisk
	// StandardEventTypeConversationCleared 是 StandardEventType 的受支持枚举值。
	StandardEventTypeConversationCleared StandardEventType = wire.StandardEventTypeConversationCleared
	// StandardEventTypeConversationDeleted 是 StandardEventType 的受支持枚举值。
	StandardEventTypeConversationDeleted StandardEventType = wire.StandardEventTypeConversationDeleted
	// StandardEventTypeConversationHistory 是 StandardEventType 的受支持枚举值。
	StandardEventTypeConversationHistory StandardEventType = wire.StandardEventTypeConversationHistory
	// StandardEventTypeConversationUpdated 是 StandardEventType 的受支持枚举值。
	StandardEventTypeConversationUpdated StandardEventType = wire.StandardEventTypeConversationUpdated
	// StandardEventTypeGroupJoinRequest 是 StandardEventType 的受支持枚举值。
	StandardEventTypeGroupJoinRequest StandardEventType = wire.StandardEventTypeGroupJoinRequest
	// StandardEventTypeGroupUpdated 是 StandardEventType 的受支持枚举值。
	StandardEventTypeGroupUpdated StandardEventType = wire.StandardEventTypeGroupUpdated
	// StandardEventTypeMessageDeleted 是 StandardEventType 的受支持枚举值。
	StandardEventTypeMessageDeleted StandardEventType = wire.StandardEventTypeMessageDeleted
	// StandardEventTypeMessageDelivered 是 StandardEventType 的受支持枚举值。
	StandardEventTypeMessageDelivered StandardEventType = wire.StandardEventTypeMessageDelivered
	// StandardEventTypeMessageReaction 是 StandardEventType 的受支持枚举值。
	StandardEventTypeMessageReaction StandardEventType = wire.StandardEventTypeMessageReaction
	// StandardEventTypeMessageRead 是 StandardEventType 的受支持枚举值。
	StandardEventTypeMessageRead StandardEventType = wire.StandardEventTypeMessageRead
	// StandardEventTypeMessageReceived 是 StandardEventType 的受支持枚举值。
	StandardEventTypeMessageReceived StandardEventType = wire.StandardEventTypeMessageReceived
	// StandardEventTypeMessageUpdated 是 StandardEventType 的受支持枚举值。
	StandardEventTypeMessageUpdated StandardEventType = wire.StandardEventTypeMessageUpdated
)
View Source 
const DefaultMaxPages = 10_000

Variables

This section is empty.

Functions

This section is empty.

Types

type APIError 

type APIError struct {
	StatusCode  int
	Code        string
	RequestID   string
	OperationID string
}

APIError 只保留稳定 HTTP 元数据；服务端 message、details、body 和 headers 不会公开。

func (*APIError) Error 

func (e *APIError) Error() string

type APIKey 

type APIKey = wire.APIKey

APIKey 是由公开 OpenAPI 契约生成的类型别名。

type APIKeyCreateRequest 

type APIKeyCreateRequest = wire.APIKeyCreateRequest

APIKeyCreateRequest 是由公开 OpenAPI 契约生成的类型别名。

type APIKeyCreateResult 

type APIKeyCreateResult = wire.APIKeyCreateResult

APIKeyCreateResult 是由公开 OpenAPI 契约生成的类型别名。

type APIKeyProvider 

type APIKeyProvider func(context.Context) (string, error)

APIKeyProvider 在每个逻辑 operation 开始时解析一次 API key。

func StaticAPIKey 

func StaticAPIKey(apiKey string) APIKeyProvider

StaticAPIKey 把静态 API key 封装在 provider 闭包中，避免 Client 暴露明文 credential 字段。

type APIKeyStatus 

type APIKeyStatus = wire.APIKeyStatus

APIKeyStatus 是由公开 OpenAPI 契约生成的类型别名。

type APIKeyStatusUpdateRequest 

type APIKeyStatusUpdateRequest = wire.APIKeyStatusUpdateRequest

APIKeyStatusUpdateRequest 是由公开 OpenAPI 契约生成的类型别名。

type APIKeyStatusUpdateRequestStatus 

type APIKeyStatusUpdateRequestStatus = wire.APIKeyStatusUpdateRequestStatus

APIKeyStatusUpdateRequestStatus 是由公开 OpenAPI 契约生成的类型别名。

type Account 

type Account = wire.Account

Account 是由公开 OpenAPI 契约生成的类型别名。

type AccountID 

type AccountID = wire.AccountID

AccountID 是由公开 OpenAPI 契约生成的类型别名。

type AccountRequest 

type AccountRequest = wire.AccountRequest

AccountRequest 是由公开 OpenAPI 契约生成的类型别名。

type AccountSession 

type AccountSession = wire.AccountSession

AccountSession 是由公开 OpenAPI 契约生成的类型别名。

type AuthField 

type AuthField = wire.AuthField

AuthField 是由公开 OpenAPI 契约生成的类型别名。

type BlockContactInput 

type BlockContactInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body BlockContactRequestBody
}

BlockContactInput 汇集 BlockContact 所需的 path、query/header 与 body 输入。

type BlockContactRequestBody 

type BlockContactRequestBody = wire.BlockContactJSONRequestBody

BlockContactRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type CallOption 

type CallOption interface {
	// contains filtered or unexported methods
}

CallOption 只能由本包提供，以防调用方绕过 timeout 或 retry 上限。

func WithMaxRetries 

func WithMaxRetries(maxRetries int) CallOption

WithMaxRetries 收紧单次调用的 retry 次数，不能扩大 client 或 operation policy 的预算。

func WithTimeout 

func WithTimeout(timeout time.Duration) CallOption

WithTimeout 收紧单次调用的 timeout；大于全局值时仍以全局值为准。

func WithoutRetry 

func WithoutRetry() CallOption

WithoutRetry 关闭单次调用的自动 retry。

type CancelAccountAuthInput 

type CancelAccountAuthInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *CancelAccountAuthRequestBody
}

CancelAccountAuthInput 汇集 CancelAccountAuth 所需的 path、query/header 与 body 输入。

type CancelAccountAuthRequestBody 

type CancelAccountAuthRequestBody = wire.CancelAccountAuthJSONRequestBody

CancelAccountAuthRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type CanceledError 

type CanceledError = transport.CanceledError

CanceledError 是已脱敏 context 取消错误的公开别名。

type CheckAccountQRAuthInput 

type CheckAccountQRAuthInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *CheckAccountQRAuthRequestBody
}

CheckAccountQRAuthInput 汇集 CheckAccountQRAuth 所需的 path、query/header 与 body 输入。

type CheckAccountQRAuthRequestBody 

type CheckAccountQRAuthRequestBody = wire.CheckAccountQRAuthJSONRequestBody

CheckAccountQRAuthRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client 是 Device API 的公开入口；底层 wire client 保持在 internal，避免绕过统一安全策略。

func NewClient 

func NewClient(config Config) (*Client, error)

NewClient 校验配置并创建可并发使用的 Device API client。

func (*Client) BlockContact 

func (c *Client) BlockContact(ctx context.Context, input BlockContactInput, options ...CallOption) (Result[OkData], error)

BlockContact 封锁联系人。

func (*Client) CancelAccountAuth 

func (c *Client) CancelAccountAuth(ctx context.Context, input CancelAccountAuthInput, options ...CallOption) (Result[FreeFormObject], error)

CancelAccountAuth 取消授权流程。

func (*Client) CheckAccountQRAuth 

func (c *Client) CheckAccountQRAuth(ctx context.Context, input CheckAccountQRAuthInput, options ...CallOption) (Result[FreeFormObject], error)

CheckAccountQRAuth 检查二维码授权结果。

func (*Client) CreateAPIKey 

func (c *Client) CreateAPIKey(ctx context.Context, input CreateAPIKeyInput, options ...CallOption) (Result[APIKeyCreateResult], error)

CreateAPIKey 创建 API Key。

func (*Client) CreateAccount 

func (c *Client) CreateAccount(ctx context.Context, input CreateAccountInput, options ...CallOption) (Result[Account], error)

CreateAccount 创建账号。

func (*Client) CreateGroup 

func (c *Client) CreateGroup(ctx context.Context, input CreateGroupInput, options ...CallOption) (Result[GroupCreateResult], error)

CreateGroup 创建群组。

func (*Client) CreateWebhookEndpoint 

func (c *Client) CreateWebhookEndpoint(ctx context.Context, input CreateWebhookEndpointInput, options ...CallOption) (Result[WebhookEndpoint], error)

CreateWebhookEndpoint 创建 webhook endpoint。

func (*Client) DeactivateWebhookEndpoint 

func (c *Client) DeactivateWebhookEndpoint(ctx context.Context, input DeactivateWebhookEndpointInput, options ...CallOption) (Result[WebhookEndpoint], error)

DeactivateWebhookEndpoint 停用 webhook endpoint。

func (*Client) DeleteAccount 

func (c *Client) DeleteAccount(ctx context.Context, input DeleteAccountInput, options ...CallOption) (Result[NoContent], error)

DeleteAccount 删除账号。

func (*Client) DeleteConversationLabel 

func (c *Client) DeleteConversationLabel(ctx context.Context, input DeleteConversationLabelInput, options ...CallOption) (Result[ConversationLabelDeleteResult], error)

DeleteConversationLabel 删除会话标签。

func (*Client) DeleteWebhookEndpoint 

func (c *Client) DeleteWebhookEndpoint(ctx context.Context, input DeleteWebhookEndpointInput, options ...CallOption) (Result[NoContent], error)

DeleteWebhookEndpoint 删除 webhook endpoint。

func (*Client) EditMessage 

func (c *Client) EditMessage(ctx context.Context, input EditMessageInput, options ...CallOption) (Result[OkData], error)

EditMessage 编辑消息文本。

func (*Client) GetAccount 

func (c *Client) GetAccount(ctx context.Context, input GetAccountInput, options ...CallOption) (Result[Account], error)

GetAccount 获取账号详情。

func (*Client) GetAccountAuthState 

func (c *Client) GetAccountAuthState(ctx context.Context, input GetAccountAuthStateInput, options ...CallOption) (Result[AccountSession], error)

GetAccountAuthState 获取账号授权状态。

func (*Client) GetContact 

func (c *Client) GetContact(ctx context.Context, input GetContactInput, options ...CallOption) (Result[Contact], error)

GetContact 获取联系人详情。

func (*Client) GetConversation 

func (c *Client) GetConversation(ctx context.Context, input GetConversationInput, options ...CallOption) (Result[Conversation], error)

GetConversation 获取会话详情。

func (*Client) GetGroup 

func (c *Client) GetGroup(ctx context.Context, input GetGroupInput, options ...CallOption) (Result[Group], error)

GetGroup 获取群组详情。

func (*Client) GetGroupInviteCode 

func (c *Client) GetGroupInviteCode(ctx context.Context, input GetGroupInviteCodeInput, options ...CallOption) (Result[GroupInviteCode], error)

GetGroupInviteCode 获取群邀请链接或邀请码。

func (*Client) GetWebhookEndpoint 

func (c *Client) GetWebhookEndpoint(ctx context.Context, input GetWebhookEndpointInput, options ...CallOption) (Result[WebhookEndpoint], error)

GetWebhookEndpoint 获取 webhook endpoint。

func (*Client) GetWorkspace 

func (c *Client) GetWorkspace(ctx context.Context, options ...CallOption) (Result[Workspace], error)

GetWorkspace 获取当前 workspace。

func (*Client) ImportAccountAuthSession 

func (c *Client) ImportAccountAuthSession(ctx context.Context, input ImportAccountAuthSessionInput, options ...CallOption) (Result[FreeFormObject], error)

ImportAccountAuthSession 导入会话授权。

func (*Client) LeaveGroup 

func (c *Client) LeaveGroup(ctx context.Context, input LeaveGroupInput, options ...CallOption) (Result[OkData], error)

LeaveGroup 退出群组。

func (*Client) ListAPIKeys 

func (c *Client) ListAPIKeys(ctx context.Context, options ...CallOption) (Result[[]APIKey], error)

ListAPIKeys 列出 API Key。

func (*Client) ListAccounts 

func (c *Client) ListAccounts(ctx context.Context, options ...CallOption) (Result[[]Account], error)

ListAccounts 列出账号。

func (*Client) ListContactBlocklist 

func (c *Client) ListContactBlocklist(ctx context.Context, input ListContactBlocklistInput, options ...CallOption) (Result[ContactBlocklistResult], error)

ListContactBlocklist 查询联系人黑名单。

func (*Client) ListContacts 

func (c *Client) ListContacts(ctx context.Context, input ListContactsInput, options ...CallOption) (Result[ContactListResult], error)

ListContacts 列出联系人。

func (*Client) ListConversationLabels 

func (c *Client) ListConversationLabels(ctx context.Context, input ListConversationLabelsInput, options ...CallOption) (Result[ConversationLabelListResult], error)

ListConversationLabels 列出会话标签。

func (*Client) ListConversationMembers 

func (c *Client) ListConversationMembers(ctx context.Context, input ListConversationMembersInput, options ...CallOption) (Result[ConversationMemberListResult], error)

ListConversationMembers 列出会话成员。

func (*Client) ListConversations 

func (c *Client) ListConversations(ctx context.Context, input ListConversationsInput, options ...CallOption) (Result[ConversationListResult], error)

ListConversations 列出会话。

func (*Client) ListGroupJoinRequests 

func (c *Client) ListGroupJoinRequests(ctx context.Context, input ListGroupJoinRequestsInput, options ...CallOption) (Result[GroupJoinRequestsResult], error)

ListGroupJoinRequests 列出待审批入群申请。

func (*Client) ListGroups 

func (c *Client) ListGroups(ctx context.Context, input ListGroupsInput, options ...CallOption) (Result[GroupListResult], error)

ListGroups 列出群组。

func (*Client) ListProviderRegions 

func (c *Client) ListProviderRegions(ctx context.Context, input ListProviderRegionsInput, options ...CallOption) (Result[ProviderRegionsResponse], error)

ListProviderRegions 查询 provider 地区可用性。

func (*Client) ListWebhookEndpoints 

func (c *Client) ListWebhookEndpoints(ctx context.Context, options ...CallOption) (Result[[]WebhookEndpoint], error)

ListWebhookEndpoints 列出 webhook endpoint。

func (*Client) MarkConversationRead 

func (c *Client) MarkConversationRead(ctx context.Context, input MarkConversationReadInput, options ...CallOption) (Result[OkData], error)

MarkConversationRead 标记会话已读。

func (*Client) MarkConversationUnread 

func (c *Client) MarkConversationUnread(ctx context.Context, input MarkConversationUnreadInput, options ...CallOption) (Result[OkData], error)

MarkConversationUnread 标记会话未读。

func (*Client) MuteConversation 

func (c *Client) MuteConversation(ctx context.Context, input MuteConversationInput, options ...CallOption) (Result[OkData], error)

MuteConversation 静音会话。

func (*Client) PinConversation 

func (c *Client) PinConversation(ctx context.Context, input PinConversationInput, options ...CallOption) (Result[OkData], error)

PinConversation 置顶会话。

func (*Client) PinMessage 

func (c *Client) PinMessage(ctx context.Context, input PinMessageInput, options ...CallOption) (Result[OkData], error)

PinMessage 置顶或取消置顶消息。

func (*Client) ReactMessage 

func (c *Client) ReactMessage(ctx context.Context, input ReactMessageInput, options ...CallOption) (Result[OkData], error)

ReactMessage 给消息加表情回应或取消回应。

func (*Client) ReconnectAccountRuntime 

func (c *Client) ReconnectAccountRuntime(ctx context.Context, input ReconnectAccountRuntimeInput, options ...CallOption) (Result[RuntimeActionResult], error)

ReconnectAccountRuntime 重连账号运行态。

func (*Client) RefreshAccountRuntime 

func (c *Client) RefreshAccountRuntime(ctx context.Context, input RefreshAccountRuntimeInput, options ...CallOption) (Result[RuntimeActionResult], error)

RefreshAccountRuntime 刷新账号运行态。

func (*Client) RevokeMessage 

func (c *Client) RevokeMessage(ctx context.Context, input RevokeMessageInput, options ...CallOption) (Result[OkData], error)

RevokeMessage 撤回消息。

func (*Client) RotateAPIKey 

func (c *Client) RotateAPIKey(ctx context.Context, input RotateAPIKeyInput, options ...CallOption) (Result[APIKeyCreateResult], error)

RotateAPIKey 轮换 API Key。

func (*Client) SendMessage 

func (c *Client) SendMessage(ctx context.Context, input SendMessageInput, options ...CallOption) (Result[SendMessageResult], error)

SendMessage 发送消息。

func (*Client) SetContactNote 

func (c *Client) SetContactNote(ctx context.Context, input SetContactNoteInput, options ...CallOption) (Result[OkData], error)

SetContactNote 设置或清空联系人备注。

func (*Client) SetConversationLabelMembers 

func (c *Client) SetConversationLabelMembers(ctx context.Context, input SetConversationLabelMembersInput, options ...CallOption) (Result[ConversationLabelMembersResult], error)

SetConversationLabelMembers 给会话打标或移除标签。

func (*Client) SetGroupJoinApprovalMode 

func (c *Client) SetGroupJoinApprovalMode(ctx context.Context, input SetGroupJoinApprovalModeInput, options ...CallOption) (Result[OkData], error)

SetGroupJoinApprovalMode 设置入群审批模式。

func (*Client) StartAccountAuth 

func (c *Client) StartAccountAuth(ctx context.Context, input StartAccountAuthInput, options ...CallOption) (Result[FreeFormObject], error)

StartAccountAuth 启动验证码类授权。

func (*Client) StartAccountQRAuth 

func (c *Client) StartAccountQRAuth(ctx context.Context, input StartAccountQRAuthInput, options ...CallOption) (Result[FreeFormObject], error)

StartAccountQRAuth 启动二维码授权。

func (*Client) StartAccountRuntime 

func (c *Client) StartAccountRuntime(ctx context.Context, input StartAccountRuntimeInput, options ...CallOption) (Result[RuntimeActionResult], error)

StartAccountRuntime 启动账号运行态。

func (*Client) StopAccountRuntime 

func (c *Client) StopAccountRuntime(ctx context.Context, input StopAccountRuntimeInput, options ...CallOption) (Result[RuntimeActionResult], error)

StopAccountRuntime 停止账号运行态。

func (*Client) SubmitAccountAuthCode 

func (c *Client) SubmitAccountAuthCode(ctx context.Context, input SubmitAccountAuthCodeInput, options ...CallOption) (Result[FreeFormObject], error)

SubmitAccountAuthCode 提交验证码。

func (*Client) SubmitAccountAuthPassword 

func (c *Client) SubmitAccountAuthPassword(ctx context.Context, input SubmitAccountAuthPasswordInput, options ...CallOption) (Result[FreeFormObject], error)

SubmitAccountAuthPassword 提交二次密码。

func (*Client) UnblockContact 

func (c *Client) UnblockContact(ctx context.Context, input UnblockContactInput, options ...CallOption) (Result[OkData], error)

UnblockContact 解封联系人。

func (*Client) UnmuteConversation 

func (c *Client) UnmuteConversation(ctx context.Context, input UnmuteConversationInput, options ...CallOption) (Result[OkData], error)

UnmuteConversation 取消静音会话。

func (*Client) UnpinConversation 

func (c *Client) UnpinConversation(ctx context.Context, input UnpinConversationInput, options ...CallOption) (Result[OkData], error)

UnpinConversation 取消置顶会话。

func (*Client) UpdateAPIKeyStatus 

func (c *Client) UpdateAPIKeyStatus(ctx context.Context, input UpdateAPIKeyStatusInput, options ...CallOption) (Result[APIKey], error)

UpdateAPIKeyStatus 更新 API Key 状态。

func (*Client) UpdateAccount 

func (c *Client) UpdateAccount(ctx context.Context, input UpdateAccountInput, options ...CallOption) (Result[Account], error)

UpdateAccount 更新账号。

func (*Client) UpdateGroupInfo 

func (c *Client) UpdateGroupInfo(ctx context.Context, input UpdateGroupInfoInput, options ...CallOption) (Result[OkData], error)

UpdateGroupInfo 修改群信息。

func (*Client) UpdateGroupJoinRequests 

func (c *Client) UpdateGroupJoinRequests(ctx context.Context, input UpdateGroupJoinRequestsInput, options ...CallOption) (Result[OkData], error)

UpdateGroupJoinRequests 处理入群申请。

func (*Client) UpdateGroupMembers 

func (c *Client) UpdateGroupMembers(ctx context.Context, input UpdateGroupMembersInput, options ...CallOption) (Result[OkData], error)

UpdateGroupMembers 管理群成员。

func (*Client) UpdateWebhookEndpoint 

func (c *Client) UpdateWebhookEndpoint(ctx context.Context, input UpdateWebhookEndpointInput, options ...CallOption) (Result[WebhookEndpoint], error)

UpdateWebhookEndpoint 更新 webhook endpoint。

func (*Client) UpdateWorkspace 

func (c *Client) UpdateWorkspace(ctx context.Context, input UpdateWorkspaceInput, options ...CallOption) (Result[Workspace], error)

UpdateWorkspace 更新当前 workspace。

func (*Client) UpsertConversationLabel 

func (c *Client) UpsertConversationLabel(ctx context.Context, input UpsertConversationLabelInput, options ...CallOption) (Result[ConversationLabel], error)

UpsertConversationLabel 新建或更新会话标签。

type Config 

type Config struct {
	BaseURL           string
	APIKeyProvider    APIKeyProvider
	HTTPClient        *http.Client
	Timeout           time.Duration
	MaxResponseBytes  int64
	Retry             *RetryConfig
	AllowInsecureHTTP bool
}

Config 描述 Device API Client 的安全运行参数。

type ConfigurationError 

type ConfigurationError = transport.ConfigurationError

ConfigurationError 是 transport 配置错误的公开别名。

type Contact 

type Contact = wire.Contact

Contact 是由公开 OpenAPI 契约生成的类型别名。

type ContactBlocklistResult 

type ContactBlocklistResult = wire.ContactBlocklistResult

ContactBlocklistResult 是由公开 OpenAPI 契约生成的类型别名。

type ContactCard 

type ContactCard = wire.ContactCard

ContactCard 是由公开 OpenAPI 契约生成的类型别名。

type ContactEmail 

type ContactEmail = wire.ContactEmail

ContactEmail 是由公开 OpenAPI 契约生成的类型别名。

type ContactID 

type ContactID = wire.ContactID

ContactID 是由公开 OpenAPI 契约生成的类型别名。

type ContactIDRequest 

type ContactIDRequest = wire.ContactIDRequest

ContactIDRequest 是由公开 OpenAPI 契约生成的类型别名。

type ContactListResult 

type ContactListResult = wire.ContactListResult

ContactListResult 是由公开 OpenAPI 契约生成的类型别名。

type ContactNoteRequest 

type ContactNoteRequest = wire.ContactNoteRequest

ContactNoteRequest 是由公开 OpenAPI 契约生成的类型别名。

type ContactPhone 

type ContactPhone = wire.ContactPhone

ContactPhone 是由公开 OpenAPI 契约生成的类型别名。

type Conversation 

type Conversation = wire.Conversation

Conversation 是由公开 OpenAPI 契约生成的类型别名。

type ConversationID 

type ConversationID = wire.ConversationID

ConversationID 是由公开 OpenAPI 契约生成的类型别名。

type ConversationIDQuery 

type ConversationIDQuery = wire.ConversationIDQuery

ConversationIDQuery 是由公开 OpenAPI 契约生成的类型别名。

type ConversationIDRequest 

type ConversationIDRequest = wire.ConversationIDRequest

ConversationIDRequest 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabel 

type ConversationLabel = wire.ConversationLabel

ConversationLabel 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelDeleteRequest 

type ConversationLabelDeleteRequest = wire.ConversationLabelDeleteRequest

ConversationLabelDeleteRequest 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelDeleteResult 

type ConversationLabelDeleteResult = wire.ConversationLabelDeleteResult

ConversationLabelDeleteResult 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelDeleteResultDeleted 

type ConversationLabelDeleteResultDeleted = wire.ConversationLabelDeleteResultDeleted

ConversationLabelDeleteResultDeleted 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelListResult 

type ConversationLabelListResult = wire.ConversationLabelListResult

ConversationLabelListResult 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelMembersRequest 

type ConversationLabelMembersRequest = wire.ConversationLabelMembersRequest

ConversationLabelMembersRequest 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelMembersRequestAction 

type ConversationLabelMembersRequestAction = wire.ConversationLabelMembersRequestAction

ConversationLabelMembersRequestAction 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelMembersResult 

type ConversationLabelMembersResult = wire.ConversationLabelMembersResult

ConversationLabelMembersResult 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelMembersResultAction 

type ConversationLabelMembersResultAction = wire.ConversationLabelMembersResultAction

ConversationLabelMembersResultAction 是由公开 OpenAPI 契约生成的类型别名。

type ConversationLabelUpsertRequest 

type ConversationLabelUpsertRequest = wire.ConversationLabelUpsertRequest

ConversationLabelUpsertRequest 是由公开 OpenAPI 契约生成的类型别名。

type ConversationListResult 

type ConversationListResult = wire.ConversationListResult

ConversationListResult 是由公开 OpenAPI 契约生成的类型别名。

type ConversationMember 

type ConversationMember = wire.ConversationMember

ConversationMember 是由公开 OpenAPI 契约生成的类型别名。

type ConversationMemberListResult 

type ConversationMemberListResult = wire.ConversationMemberListResult

ConversationMemberListResult 是由公开 OpenAPI 契约生成的类型别名。

type ConversationMuteRequest 

type ConversationMuteRequest = wire.ConversationMuteRequest

ConversationMuteRequest 是由公开 OpenAPI 契约生成的类型别名。

type ConversationReadRequest 

type ConversationReadRequest = wire.ConversationReadRequest

ConversationReadRequest 是由公开 OpenAPI 契约生成的类型别名。

type ConversationType 

type ConversationType = wire.ConversationType

ConversationType 是由公开 OpenAPI 契约生成的类型别名。

type ConversationTypeFilter 

type ConversationTypeFilter = wire.ConversationTypeFilter

ConversationTypeFilter 是由公开 OpenAPI 契约生成的类型别名。

type CreateAPIKeyInput 

type CreateAPIKeyInput struct {
	// Body 对应 application/json request body。
	Body CreateAPIKeyRequestBody
}

CreateAPIKeyInput 汇集 CreateAPIKey 所需的 path、query/header 与 body 输入。

type CreateAPIKeyRequestBody 

type CreateAPIKeyRequestBody = wire.CreateAPIKeyJSONRequestBody

CreateAPIKeyRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type CreateAccountInput 

type CreateAccountInput struct {
	// Body 对应 application/json request body。
	Body CreateAccountRequestBody
}

CreateAccountInput 汇集 CreateAccount 所需的 path、query/header 与 body 输入。

type CreateAccountRequestBody 

type CreateAccountRequestBody = wire.CreateAccountJSONRequestBody

CreateAccountRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type CreateGroupInput 

type CreateGroupInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body CreateGroupRequestBody
}

CreateGroupInput 汇集 CreateGroup 所需的 path、query/header 与 body 输入。

type CreateGroupRequestBody 

type CreateGroupRequestBody = wire.CreateGroupJSONRequestBody

CreateGroupRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type CreateWebhookEndpointInput 

type CreateWebhookEndpointInput struct {
	// Body 对应 application/json request body。
	Body CreateWebhookEndpointRequestBody
}

CreateWebhookEndpointInput 汇集 CreateWebhookEndpoint 所需的 path、query/header 与 body 输入。

type CreateWebhookEndpointRequestBody 

type CreateWebhookEndpointRequestBody = wire.CreateWebhookEndpointJSONRequestBody

CreateWebhookEndpointRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type Cursor 

type Cursor = wire.Cursor

Cursor 是由公开 OpenAPI 契约生成的类型别名。

type CursorPage 

type CursorPage[T any] struct {
	Items      []T
	HasMore    bool
	NextCursor string
}

CursorPage 是 Device API cursor response 的语言中立分页视图。

type DeactivateWebhookEndpointInput 

type DeactivateWebhookEndpointInput struct {
	// EndpointID 对应必填 path parameter。
	EndpointID EndpointID
}

DeactivateWebhookEndpointInput 汇集 DeactivateWebhookEndpoint 所需的 path、query/header 与 body 输入。

type DeleteAccountInput 

type DeleteAccountInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
}

DeleteAccountInput 汇集 DeleteAccount 所需的 path、query/header 与 body 输入。

type DeleteConversationLabelInput 

type DeleteConversationLabelInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body DeleteConversationLabelRequestBody
}

DeleteConversationLabelInput 汇集 DeleteConversationLabel 所需的 path、query/header 与 body 输入。

type DeleteConversationLabelRequestBody 

type DeleteConversationLabelRequestBody = wire.DeleteConversationLabelJSONRequestBody

DeleteConversationLabelRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type DeleteWebhookEndpointInput 

type DeleteWebhookEndpointInput struct {
	// EndpointID 对应必填 path parameter。
	EndpointID EndpointID
}

DeleteWebhookEndpointInput 汇集 DeleteWebhookEndpoint 所需的 path、query/header 与 body 输入。

type EditMessageInput 

type EditMessageInput struct {
	// Body 对应 application/json request body。
	Body EditMessageRequestBody
}

EditMessageInput 汇集 EditMessage 所需的 path、query/header 与 body 输入。

type EditMessageRequestBody 

type EditMessageRequestBody = wire.EditMessageJSONRequestBody

EditMessageRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type EndpointID 

type EndpointID = wire.EndpointID

EndpointID 是由公开 OpenAPI 契约生成的类型别名。

type Error 

type Error = wire.Error

Error 是由公开 OpenAPI 契约生成的类型别名。

type ErrorEnvelope 

type ErrorEnvelope = wire.ErrorEnvelope

ErrorEnvelope 是由公开 OpenAPI 契约生成的类型别名。

type FreeFormObject 

type FreeFormObject = wire.FreeFormObject

FreeFormObject 是由公开 OpenAPI 契约生成的类型别名。

type GetAccountAuthStateInput 

type GetAccountAuthStateInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
}

GetAccountAuthStateInput 汇集 GetAccountAuthState 所需的 path、query/header 与 body 输入。

type GetAccountInput 

type GetAccountInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
}

GetAccountInput 汇集 GetAccount 所需的 path、query/header 与 body 输入。

type GetContactInput 

type GetContactInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params GetContactParams
}

GetContactInput 汇集 GetContact 所需的 path、query/header 与 body 输入。

type GetContactParams 

type GetContactParams = wire.GetContactParams

GetContactParams 是由公开 OpenAPI 契约生成的类型别名。

type GetConversationInput 

type GetConversationInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params GetConversationParams
}

GetConversationInput 汇集 GetConversation 所需的 path、query/header 与 body 输入。

type GetConversationParams 

type GetConversationParams = wire.GetConversationParams

GetConversationParams 是由公开 OpenAPI 契约生成的类型别名。

type GetGroupInput 

type GetGroupInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params GetGroupParams
}

GetGroupInput 汇集 GetGroup 所需的 path、query/header 与 body 输入。

type GetGroupInviteCodeInput 

type GetGroupInviteCodeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params GetGroupInviteCodeParams
}

GetGroupInviteCodeInput 汇集 GetGroupInviteCode 所需的 path、query/header 与 body 输入。

type GetGroupInviteCodeParams 

type GetGroupInviteCodeParams = wire.GetGroupInviteCodeParams

GetGroupInviteCodeParams 是由公开 OpenAPI 契约生成的类型别名。

type GetGroupParams 

type GetGroupParams = wire.GetGroupParams

GetGroupParams 是由公开 OpenAPI 契约生成的类型别名。

type GetWebhookEndpointInput 

type GetWebhookEndpointInput struct {
	// EndpointID 对应必填 path parameter。
	EndpointID EndpointID
}

GetWebhookEndpointInput 汇集 GetWebhookEndpoint 所需的 path、query/header 与 body 输入。

type Group 

type Group = wire.Group

Group 是由公开 OpenAPI 契约生成的类型别名。

type GroupCreateRequest 

type GroupCreateRequest = wire.GroupCreateRequest

GroupCreateRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupCreateResult 

type GroupCreateResult = wire.GroupCreateResult

GroupCreateResult 是由公开 OpenAPI 契约生成的类型别名。

type GroupID 

type GroupID = wire.GroupID

GroupID 是由公开 OpenAPI 契约生成的类型别名。

type GroupIDRequest 

type GroupIDRequest = wire.GroupIDRequest

GroupIDRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupInfoUpdateRequest 

type GroupInfoUpdateRequest = wire.GroupInfoUpdateRequest

GroupInfoUpdateRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupInviteCode 

type GroupInviteCode = wire.GroupInviteCode

GroupInviteCode 是由公开 OpenAPI 契约生成的类型别名。

type GroupJoinApprovalModeRequest 

type GroupJoinApprovalModeRequest = wire.GroupJoinApprovalModeRequest

GroupJoinApprovalModeRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupJoinRequest 

type GroupJoinRequest = wire.GroupJoinRequest

GroupJoinRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupJoinRequestsResult 

type GroupJoinRequestsResult = wire.GroupJoinRequestsResult

GroupJoinRequestsResult 是由公开 OpenAPI 契约生成的类型别名。

type GroupJoinRequestsUpdateRequest 

type GroupJoinRequestsUpdateRequest = wire.GroupJoinRequestsUpdateRequest

GroupJoinRequestsUpdateRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupJoinRequestsUpdateRequestAction 

type GroupJoinRequestsUpdateRequestAction = wire.GroupJoinRequestsUpdateRequestAction

GroupJoinRequestsUpdateRequestAction 是由公开 OpenAPI 契约生成的类型别名。

type GroupListResult 

type GroupListResult = wire.GroupListResult

GroupListResult 是由公开 OpenAPI 契约生成的类型别名。

type GroupMemberUpdateRequest 

type GroupMemberUpdateRequest = wire.GroupMemberUpdateRequest

GroupMemberUpdateRequest 是由公开 OpenAPI 契约生成的类型别名。

type GroupMemberUpdateRequestAction 

type GroupMemberUpdateRequestAction = wire.GroupMemberUpdateRequestAction

GroupMemberUpdateRequestAction 是由公开 OpenAPI 契约生成的类型别名。

type HeaderSnapshot 

type HeaderSnapshot struct {
	// contains filtered or unexported fields
}

HeaderSnapshot 只保存明确 allowlist 中的诊断与限流 headers。

func (HeaderSnapshot) Clone 

func (snapshot HeaderSnapshot) Clone() http.Header

Clone 返回只含 allowlist headers 的可修改副本。

func (HeaderSnapshot) Get 

func (snapshot HeaderSnapshot) Get(name string) string

Get 返回 allowlist header 的首个值。

func (HeaderSnapshot) Values 

func (snapshot HeaderSnapshot) Values(name string) []string

Values 返回独立副本，避免调用方修改 Result 内的 header snapshot。

type ImportAccountAuthSessionInput 

type ImportAccountAuthSessionInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *ImportAccountAuthSessionRequestBody
}

ImportAccountAuthSessionInput 汇集 ImportAccountAuthSession 所需的 path、query/header 与 body 输入。

type ImportAccountAuthSessionRequestBody 

type ImportAccountAuthSessionRequestBody = wire.ImportAccountAuthSessionJSONRequestBody

ImportAccountAuthSessionRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type KeyID 

type KeyID = wire.KeyID

KeyID 是由公开 OpenAPI 契约生成的类型别名。

type LeaveGroupInput 

type LeaveGroupInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body LeaveGroupRequestBody
}

LeaveGroupInput 汇集 LeaveGroup 所需的 path、query/header 与 body 输入。

type LeaveGroupRequestBody 

type LeaveGroupRequestBody = wire.LeaveGroupJSONRequestBody

LeaveGroupRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type Limit 

type Limit = wire.Limit

Limit 是由公开 OpenAPI 契约生成的类型别名。

type ListContactBlocklistInput 

type ListContactBlocklistInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
}

ListContactBlocklistInput 汇集 ListContactBlocklist 所需的 path、query/header 与 body 输入。

type ListContactsInput 

type ListContactsInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params *ListContactsParams
}

ListContactsInput 汇集 ListContacts 所需的 path、query/header 与 body 输入。

type ListContactsParams 

type ListContactsParams = wire.ListContactsParams

ListContactsParams 是由公开 OpenAPI 契约生成的类型别名。

type ListConversationLabelsInput 

type ListConversationLabelsInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params *ListConversationLabelsParams
}

ListConversationLabelsInput 汇集 ListConversationLabels 所需的 path、query/header 与 body 输入。

type ListConversationLabelsParams 

type ListConversationLabelsParams = wire.ListConversationLabelsParams

ListConversationLabelsParams 是由公开 OpenAPI 契约生成的类型别名。

type ListConversationMembersInput 

type ListConversationMembersInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params ListConversationMembersParams
}

ListConversationMembersInput 汇集 ListConversationMembers 所需的 path、query/header 与 body 输入。

type ListConversationMembersParams 

type ListConversationMembersParams = wire.ListConversationMembersParams

ListConversationMembersParams 是由公开 OpenAPI 契约生成的类型别名。

type ListConversationsInput 

type ListConversationsInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params *ListConversationsParams
}

ListConversationsInput 汇集 ListConversations 所需的 path、query/header 与 body 输入。

type ListConversationsParams 

type ListConversationsParams = wire.ListConversationsParams

ListConversationsParams 是由公开 OpenAPI 契约生成的类型别名。

type ListGroupJoinRequestsInput 

type ListGroupJoinRequestsInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params ListGroupJoinRequestsParams
}

ListGroupJoinRequestsInput 汇集 ListGroupJoinRequests 所需的 path、query/header 与 body 输入。

type ListGroupJoinRequestsParams 

type ListGroupJoinRequestsParams = wire.ListGroupJoinRequestsParams

ListGroupJoinRequestsParams 是由公开 OpenAPI 契约生成的类型别名。

type ListGroupsInput 

type ListGroupsInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Params 保留生成器对 query/header 参数的 required 约束。
	Params *ListGroupsParams
}

ListGroupsInput 汇集 ListGroups 所需的 path、query/header 与 body 输入。

type ListGroupsParams 

type ListGroupsParams = wire.ListGroupsParams

ListGroupsParams 是由公开 OpenAPI 契约生成的类型别名。

type ListProviderRegionsInput 

type ListProviderRegionsInput struct {
	// Provider 对应必填 path parameter。
	Provider Provider
}

ListProviderRegionsInput 汇集 ListProviderRegions 所需的 path、query/header 与 body 输入。

type MCPExposure 

type MCPExposure string

MCPExposure 记录 Node 基线对模型工具面的显式审核结论，不包含任何 MCP schema。 

const (
	// MCPExposureNever 表示 operation 不进入模型工具面。
	MCPExposureNever MCPExposure = "never"
	// MCPExposureRead 表示只读模型工具暴露。
	MCPExposureRead MCPExposure = "read"
	// MCPExposureWrite 表示写入模型工具暴露。
	MCPExposureWrite MCPExposure = "write"
	// MCPExposureDestructive 表示破坏性模型工具暴露。
	MCPExposureDestructive MCPExposure = "destructive"
)

type MarkConversationReadInput 

type MarkConversationReadInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body MarkConversationReadRequestBody
}

MarkConversationReadInput 汇集 MarkConversationRead 所需的 path、query/header 与 body 输入。

type MarkConversationReadRequestBody 

type MarkConversationReadRequestBody = wire.MarkConversationReadJSONRequestBody

MarkConversationReadRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type MarkConversationUnreadInput 

type MarkConversationUnreadInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body MarkConversationUnreadRequestBody
}

MarkConversationUnreadInput 汇集 MarkConversationUnread 所需的 path、query/header 与 body 输入。

type MarkConversationUnreadRequestBody 

type MarkConversationUnreadRequestBody = wire.MarkConversationUnreadJSONRequestBody

MarkConversationUnreadRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type Mention 

type Mention = wire.Mention

Mention 是由公开 OpenAPI 契约生成的类型别名。

type MessageEditRequest 

type MessageEditRequest = wire.MessageEditRequest

MessageEditRequest 是由公开 OpenAPI 契约生成的类型别名。

type MessagePayload 

type MessagePayload = wire.MessagePayload

MessagePayload 是由公开 OpenAPI 契约生成的类型别名。

type MessagePayloadType 

type MessagePayloadType = wire.MessagePayloadType

MessagePayloadType 是由公开 OpenAPI 契约生成的类型别名。

type MessagePinRequest 

type MessagePinRequest = wire.MessagePinRequest

MessagePinRequest 是由公开 OpenAPI 契约生成的类型别名。

type MessageReactionRequest 

type MessageReactionRequest = wire.MessageReactionRequest

MessageReactionRequest 是由公开 OpenAPI 契约生成的类型别名。

type MessageRevokeRequest 

type MessageRevokeRequest = wire.MessageRevokeRequest

MessageRevokeRequest 是由公开 OpenAPI 契约生成的类型别名。

type MessageTargetRequest 

type MessageTargetRequest = wire.MessageTargetRequest

MessageTargetRequest 是由公开 OpenAPI 契约生成的类型别名。

type Mutability 

type Mutability string

Mutability 描述 operation 对远端资源的影响。 

const (
	// MutabilityRead 表示只读 operation。
	MutabilityRead Mutability = "read"
	// MutabilityWrite 表示会改变远端状态的 operation。
	MutabilityWrite Mutability = "write"
	// MutabilityDestructive 表示删除、撤回或移除类 operation。
	MutabilityDestructive Mutability = "destructive"
)

type MuteConversationInput 

type MuteConversationInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body MuteConversationRequestBody
}

MuteConversationInput 汇集 MuteConversation 所需的 path、query/header 与 body 输入。

type MuteConversationRequestBody 

type MuteConversationRequestBody = wire.MuteConversationJSONRequestBody

MuteConversationRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type NetworkError 

type NetworkError = transport.NetworkError

NetworkError 是已脱敏网络错误的公开别名。

type NoContent 

type NoContent struct{}

NoContent 明确表示成功的 204 response 没有业务 payload。

type OkData 

type OkData = wire.OkData

OkData 是由公开 OpenAPI 契约生成的类型别名。

type OkDataOk 

type OkDataOk = wire.OkDataOk

OkDataOk 是由公开 OpenAPI 契约生成的类型别名。

type Operation 

type Operation struct {
	ID           string
	Method       string
	Path         string
	Tag          string
	Summary      string
	Mutability   Mutability
	Retryable    bool
	SecretInput  bool
	SecretOutput bool
	MCPExposure  MCPExposure
}

Operation 是公开、只读语义的 operation metadata 值。

func LookupOperation 

func LookupOperation(id string) (Operation, bool)

LookupOperation 按原始 operationId 返回 metadata 值。

func Operations 

func Operations() []Operation

Operations 返回 operation metadata 的独立切片副本。

type PageFetcher 

type PageFetcher[T any] func(ctx context.Context, cursor string) (CursorPage[T], error)

PageFetcher 必须遵守 ctx；Pager 不启动后台 goroutine，因此不会为忽略 ctx 的实现制造 goroutine 泄漏。

type Pager 

type Pager[T any] struct {
	// contains filtered or unexported fields
}

Pager 按需获取页面，不会自动预取下一页。

func NewPager 

func NewPager[T any](fetcher PageFetcher[T], options PagerOptions) (*Pager[T], error)

NewPager 创建一个单消费者 Pager；同一个 Pager 不应并发调用 Next。

func (*Pager[T]) Next 

func (pager *Pager[T]) Next(ctx context.Context) (item T, ok bool, err error)

Next 返回下一个 item；ok=false 且 err=nil 表示分页正常结束。

type PagerOptions 

type PagerOptions struct {
	InitialCursor string
	MaxPages      int
}

PagerOptions 控制初始 cursor 和有限页数上限。

type PaginationError 

type PaginationError struct {
	Reason   PaginationErrorReason
	MaxPages int
}

PaginationError 表示 cursor 协议或调用 context 使分页无法安全继续。

func (*PaginationError) Error 

func (e *PaginationError) Error() string

func (*PaginationError) Is 

func (e *PaginationError) Is(target error) bool

Is 支持 errors.Is 检查 context 状态，同时不保存调用方自定义的 cancel cause。

type PaginationErrorReason 

type PaginationErrorReason string

PaginationErrorReason 是不包含 cursor 值的稳定分页失败分类。 

const (
	PaginationInvalidOptions PaginationErrorReason = "invalid_options"
	PaginationMissingCursor  PaginationErrorReason = "missing_next_cursor"
	PaginationRepeatedCursor PaginationErrorReason = "repeated_next_cursor"
	PaginationPageLimit      PaginationErrorReason = "page_limit_exceeded"
	PaginationCanceled       PaginationErrorReason = "canceled"
	PaginationTimedOut       PaginationErrorReason = "timed_out"
)

type PinConversationInput 

type PinConversationInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body PinConversationRequestBody
}

PinConversationInput 汇集 PinConversation 所需的 path、query/header 与 body 输入。

type PinConversationRequestBody 

type PinConversationRequestBody = wire.PinConversationJSONRequestBody

PinConversationRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type PinMessageInput 

type PinMessageInput struct {
	// Body 对应 application/json request body。
	Body PinMessageRequestBody
}

PinMessageInput 汇集 PinMessage 所需的 path、query/header 与 body 输入。

type PinMessageRequestBody 

type PinMessageRequestBody = wire.PinMessageJSONRequestBody

PinMessageRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type Provider 

type Provider = wire.Provider

Provider 是由公开 OpenAPI 契约生成的类型别名。

type ProviderName 

type ProviderName = wire.ProviderName

ProviderName 是由公开 OpenAPI 契约生成的类型别名。

type ProviderRegionsResponse 

type ProviderRegionsResponse = wire.ProviderRegionsResponse

ProviderRegionsResponse 是由公开 OpenAPI 契约生成的类型别名。

type ReactMessageInput 

type ReactMessageInput struct {
	// Body 对应 application/json request body。
	Body ReactMessageRequestBody
}

ReactMessageInput 汇集 ReactMessage 所需的 path、query/header 与 body 输入。

type ReactMessageRequestBody 

type ReactMessageRequestBody = wire.ReactMessageJSONRequestBody

ReactMessageRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type Recipient 

type Recipient = wire.Recipient

Recipient 是由公开 OpenAPI 契约生成的类型别名。

type ReconnectAccountRuntimeInput 

type ReconnectAccountRuntimeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *ReconnectAccountRuntimeRequestBody
}

ReconnectAccountRuntimeInput 汇集 ReconnectAccountRuntime 所需的 path、query/header 与 body 输入。

type ReconnectAccountRuntimeRequestBody 

type ReconnectAccountRuntimeRequestBody = wire.ReconnectAccountRuntimeJSONRequestBody

ReconnectAccountRuntimeRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type RefreshAccountRuntimeInput 

type RefreshAccountRuntimeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *RefreshAccountRuntimeRequestBody
}

RefreshAccountRuntimeInput 汇集 RefreshAccountRuntime 所需的 path、query/header 与 body 输入。

type RefreshAccountRuntimeRequestBody 

type RefreshAccountRuntimeRequestBody = wire.RefreshAccountRuntimeJSONRequestBody

RefreshAccountRuntimeRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type RegionAvailability 

type RegionAvailability = wire.RegionAvailability

RegionAvailability 是由公开 OpenAPI 契约生成的类型别名。

type ReplyTo 

type ReplyTo = wire.ReplyTo

ReplyTo 是由公开 OpenAPI 契约生成的类型别名。

type ResponseMeta 

type ResponseMeta = wire.ResponseMeta

ResponseMeta 是由公开 OpenAPI 契约生成的类型别名。

type ResponseParseError 

type ResponseParseError = transport.ResponseParseError

ResponseParseError 是响应读取或解析错误的公开别名。

type Result 

type Result[T any] struct {
	Data            T
	StatusCode      int
	RequestID       string
	ClientRequestID string
	Headers         HeaderSnapshot
}

Result 包含业务 data 与经过筛选的 HTTP 元数据，不公开 raw response 或 raw body。

type RetryConfig 

type RetryConfig struct {
	MaxRetries int
	BaseDelay  time.Duration
	MaxDelay   time.Duration
}

RetryConfig 定义全局 retry 预算；只有生成 policy 明确允许的 operation 才会使用它。

type RevokeMessageInput 

type RevokeMessageInput struct {
	// Body 对应 application/json request body。
	Body RevokeMessageRequestBody
}

RevokeMessageInput 汇集 RevokeMessage 所需的 path、query/header 与 body 输入。

type RevokeMessageRequestBody 

type RevokeMessageRequestBody = wire.RevokeMessageJSONRequestBody

RevokeMessageRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type RotateAPIKeyInput 

type RotateAPIKeyInput struct {
	// KeyID 对应必填 path parameter。
	KeyID KeyID
	// Body 对应 application/json request body。
	Body RotateAPIKeyRequestBody
}

RotateAPIKeyInput 汇集 RotateAPIKey 所需的 path、query/header 与 body 输入。

type RotateAPIKeyRequestBody 

type RotateAPIKeyRequestBody = wire.RotateAPIKeyJSONRequestBody

RotateAPIKeyRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type RuntimeActionResult 

type RuntimeActionResult = wire.RuntimeActionResult

RuntimeActionResult 是由公开 OpenAPI 契约生成的类型别名。

type RuntimeActionResultAction 

type RuntimeActionResultAction = wire.RuntimeActionResultAction

RuntimeActionResultAction 是由公开 OpenAPI 契约生成的类型别名。

type RuntimeStatus 

type RuntimeStatus = wire.RuntimeStatus

RuntimeStatus 是由公开 OpenAPI 契约生成的类型别名。

type SendMessageInput 

type SendMessageInput struct {
	// Body 对应 application/json request body。
	Body SendMessageRequestBody
}

SendMessageInput 汇集 SendMessage 所需的 path、query/header 与 body 输入。

type SendMessageRequest 

type SendMessageRequest = wire.SendMessageRequest

SendMessageRequest 是由公开 OpenAPI 契约生成的类型别名。

type SendMessageRequestBody 

type SendMessageRequestBody = wire.SendMessageJSONRequestBody

SendMessageRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type SendMessageResult 

type SendMessageResult = wire.SendMessageResult

SendMessageResult 是由公开 OpenAPI 契约生成的类型别名。

type SetContactNoteInput 

type SetContactNoteInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body SetContactNoteRequestBody
}

SetContactNoteInput 汇集 SetContactNote 所需的 path、query/header 与 body 输入。

type SetContactNoteRequestBody 

type SetContactNoteRequestBody = wire.SetContactNoteJSONRequestBody

SetContactNoteRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type SetConversationLabelMembersInput 

type SetConversationLabelMembersInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body SetConversationLabelMembersRequestBody
}

SetConversationLabelMembersInput 汇集 SetConversationLabelMembers 所需的 path、query/header 与 body 输入。

type SetConversationLabelMembersRequestBody 

type SetConversationLabelMembersRequestBody = wire.SetConversationLabelMembersJSONRequestBody

SetConversationLabelMembersRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type SetGroupJoinApprovalModeInput 

type SetGroupJoinApprovalModeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body SetGroupJoinApprovalModeRequestBody
}

SetGroupJoinApprovalModeInput 汇集 SetGroupJoinApprovalMode 所需的 path、query/header 与 body 输入。

type SetGroupJoinApprovalModeRequestBody 

type SetGroupJoinApprovalModeRequestBody = wire.SetGroupJoinApprovalModeJSONRequestBody

SetGroupJoinApprovalModeRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type StandardEventType 

type StandardEventType = wire.StandardEventType

StandardEventType 是由公开 OpenAPI 契约生成的类型别名。

type StartAccountAuthInput 

type StartAccountAuthInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *StartAccountAuthRequestBody
}

StartAccountAuthInput 汇集 StartAccountAuth 所需的 path、query/header 与 body 输入。

type StartAccountAuthRequestBody 

type StartAccountAuthRequestBody = wire.StartAccountAuthJSONRequestBody

StartAccountAuthRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type StartAccountQRAuthInput 

type StartAccountQRAuthInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *StartAccountQRAuthRequestBody
}

StartAccountQRAuthInput 汇集 StartAccountQRAuth 所需的 path、query/header 与 body 输入。

type StartAccountQRAuthRequestBody 

type StartAccountQRAuthRequestBody = wire.StartAccountQRAuthJSONRequestBody

StartAccountQRAuthRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type StartAccountRuntimeInput 

type StartAccountRuntimeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *StartAccountRuntimeRequestBody
}

StartAccountRuntimeInput 汇集 StartAccountRuntime 所需的 path、query/header 与 body 输入。

type StartAccountRuntimeRequestBody 

type StartAccountRuntimeRequestBody = wire.StartAccountRuntimeJSONRequestBody

StartAccountRuntimeRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type StopAccountRuntimeInput 

type StopAccountRuntimeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *StopAccountRuntimeRequestBody
}

StopAccountRuntimeInput 汇集 StopAccountRuntime 所需的 path、query/header 与 body 输入。

type StopAccountRuntimeRequestBody 

type StopAccountRuntimeRequestBody = wire.StopAccountRuntimeJSONRequestBody

StopAccountRuntimeRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type SubmitAccountAuthCodeInput 

type SubmitAccountAuthCodeInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *SubmitAccountAuthCodeRequestBody
}

SubmitAccountAuthCodeInput 汇集 SubmitAccountAuthCode 所需的 path、query/header 与 body 输入。

type SubmitAccountAuthCodeRequestBody 

type SubmitAccountAuthCodeRequestBody = wire.SubmitAccountAuthCodeJSONRequestBody

SubmitAccountAuthCodeRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type SubmitAccountAuthPasswordInput 

type SubmitAccountAuthPasswordInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body *SubmitAccountAuthPasswordRequestBody
}

SubmitAccountAuthPasswordInput 汇集 SubmitAccountAuthPassword 所需的 path、query/header 与 body 输入。

type SubmitAccountAuthPasswordRequestBody 

type SubmitAccountAuthPasswordRequestBody = wire.SubmitAccountAuthPasswordJSONRequestBody

SubmitAccountAuthPasswordRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type TimeoutError 

type TimeoutError = transport.TimeoutError

TimeoutError 是已脱敏 timeout 错误的公开别名。

type UnblockContactInput 

type UnblockContactInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UnblockContactRequestBody
}

UnblockContactInput 汇集 UnblockContact 所需的 path、query/header 与 body 输入。

type UnblockContactRequestBody 

type UnblockContactRequestBody = wire.UnblockContactJSONRequestBody

UnblockContactRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UnmuteConversationInput 

type UnmuteConversationInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UnmuteConversationRequestBody
}

UnmuteConversationInput 汇集 UnmuteConversation 所需的 path、query/header 与 body 输入。

type UnmuteConversationRequestBody 

type UnmuteConversationRequestBody = wire.UnmuteConversationJSONRequestBody

UnmuteConversationRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UnpinConversationInput 

type UnpinConversationInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UnpinConversationRequestBody
}

UnpinConversationInput 汇集 UnpinConversation 所需的 path、query/header 与 body 输入。

type UnpinConversationRequestBody 

type UnpinConversationRequestBody = wire.UnpinConversationJSONRequestBody

UnpinConversationRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateAPIKeyStatusInput 

type UpdateAPIKeyStatusInput struct {
	// KeyID 对应必填 path parameter。
	KeyID KeyID
	// Body 对应 application/json request body。
	Body UpdateAPIKeyStatusRequestBody
}

UpdateAPIKeyStatusInput 汇集 UpdateAPIKeyStatus 所需的 path、query/header 与 body 输入。

type UpdateAPIKeyStatusRequestBody 

type UpdateAPIKeyStatusRequestBody = wire.UpdateAPIKeyStatusJSONRequestBody

UpdateAPIKeyStatusRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateAccountInput 

type UpdateAccountInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UpdateAccountRequestBody
}

UpdateAccountInput 汇集 UpdateAccount 所需的 path、query/header 与 body 输入。

type UpdateAccountRequestBody 

type UpdateAccountRequestBody = wire.UpdateAccountJSONRequestBody

UpdateAccountRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateGroupInfoInput 

type UpdateGroupInfoInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UpdateGroupInfoRequestBody
}

UpdateGroupInfoInput 汇集 UpdateGroupInfo 所需的 path、query/header 与 body 输入。

type UpdateGroupInfoRequestBody 

type UpdateGroupInfoRequestBody = wire.UpdateGroupInfoJSONRequestBody

UpdateGroupInfoRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateGroupJoinRequestsInput 

type UpdateGroupJoinRequestsInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UpdateGroupJoinRequestsRequestBody
}

UpdateGroupJoinRequestsInput 汇集 UpdateGroupJoinRequests 所需的 path、query/header 与 body 输入。

type UpdateGroupJoinRequestsRequestBody 

type UpdateGroupJoinRequestsRequestBody = wire.UpdateGroupJoinRequestsJSONRequestBody

UpdateGroupJoinRequestsRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateGroupMembersInput 

type UpdateGroupMembersInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UpdateGroupMembersRequestBody
}

UpdateGroupMembersInput 汇集 UpdateGroupMembers 所需的 path、query/header 与 body 输入。

type UpdateGroupMembersRequestBody 

type UpdateGroupMembersRequestBody = wire.UpdateGroupMembersJSONRequestBody

UpdateGroupMembersRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateWebhookEndpointInput 

type UpdateWebhookEndpointInput struct {
	// EndpointID 对应必填 path parameter。
	EndpointID EndpointID
	// Body 对应 application/json request body。
	Body UpdateWebhookEndpointRequestBody
}

UpdateWebhookEndpointInput 汇集 UpdateWebhookEndpoint 所需的 path、query/header 与 body 输入。

type UpdateWebhookEndpointRequestBody 

type UpdateWebhookEndpointRequestBody = wire.UpdateWebhookEndpointJSONRequestBody

UpdateWebhookEndpointRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpdateWorkspaceInput 

type UpdateWorkspaceInput struct {
	// Body 对应 application/json request body。
	Body UpdateWorkspaceRequestBody
}

UpdateWorkspaceInput 汇集 UpdateWorkspace 所需的 path、query/header 与 body 输入。

type UpdateWorkspaceRequestBody 

type UpdateWorkspaceRequestBody = wire.UpdateWorkspaceJSONRequestBody

UpdateWorkspaceRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type UpsertConversationLabelInput 

type UpsertConversationLabelInput struct {
	// AccountID 对应必填 path parameter。
	AccountID AccountID
	// Body 对应 application/json request body。
	Body UpsertConversationLabelRequestBody
}

UpsertConversationLabelInput 汇集 UpsertConversationLabel 所需的 path、query/header 与 body 输入。

type UpsertConversationLabelRequestBody 

type UpsertConversationLabelRequestBody = wire.UpsertConversationLabelJSONRequestBody

UpsertConversationLabelRequestBody 是由公开 OpenAPI 契约生成的类型别名。

type WebhookEndpoint 

type WebhookEndpoint = wire.WebhookEndpoint

WebhookEndpoint 是由公开 OpenAPI 契约生成的类型别名。

type WebhookEndpointRequest 

type WebhookEndpointRequest = wire.WebhookEndpointRequest

WebhookEndpointRequest 是由公开 OpenAPI 契约生成的类型别名。

type Workspace 

type Workspace = wire.Workspace

Workspace 是由公开 OpenAPI 契约生成的类型别名。

type WorkspaceUpdateRequest 

type WorkspaceUpdateRequest = wire.WorkspaceUpdateRequest

WorkspaceUpdateRequest 是由公开 OpenAPI 契约生成的类型别名。

Source Files

View all Source files

Directories

Path Synopsis
Package codegen 固化生成入口，避免开发者手工编辑 wire 与 parity 产物。
 Package codegen 固化生成入口，避免开发者手工编辑 wire 与 parity 产物。
examples
getting-started command
list-contacts-pager command
pagination command
internal
transport
wire
Package wire provides primitives to interact with the openapi HTTP API.
 Package wire provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.