@agentrun/sdk 0.0.3 → 0.0.4

package/dist/credential/index.d.ts

@@ -0,0 +1,246 @@
+import { C as Config } from '../config-07gMelJP.js';
+import { P as PageableInput } from '../model--I90nCqy.js';
+import { R as ResourceBase } from '../resource-DnE_DEka.js';
+export { CredentialControlAPI } from './api/index.js';
+import '@alicloud/agentrun20250910';
+import '../control-api-d-82Sgpr.js';
+
+/** 凭证认证类型 / Credential Authentication Types */
+type CredentialAuthType = 'jwt' | 'api_key' | 'basic' | 'aksk' | 'custom_header';
+/** 凭证来源类型 / Credential Source Types */
+type CredentialSourceType = 'external_llm' | 'external_tool' | 'internal';
+/**
+ * Credential basic authentication configuration
+ */
+interface CredentialBasicAuth {
+    /** Username */
+    username?: string;
+    /** Password */
+    password?: string;
+}
+/**
+ * Related resource for credential
+ */
+interface RelatedResource {
+    /** 资源 IDj*/
+    resourceId?: string;
+    /** 资源名称j*/
+    resourceName?: string;
+    /** 资源类型j*/
+    resourceType?: string;
+}
+interface CredentialConfigInterface {
+    /** 凭证认证类型 */
+    credentialAuthType?: CredentialAuthType;
+    /** 凭证来源类型 */
+    credentialSourceType?: CredentialSourceType;
+    /** 凭证公共配置 */
+    credentialPublicConfig?: Record<string, any>;
+    /** 凭证密钥 */
+    credentialSecret?: string;
+}
+/**
+ * 凭证配置 / Credential configuration
+ */
+declare class CredentialConfig implements CredentialConfigInterface {
+    constructor(data?: CredentialConfigInterface);
+    /** 配置访问 AgentRun 的 api key 凭证 */
+    static inboundApiKey(params: {
+        apiKey: string;
+        headerKey?: string;
+    }): CredentialConfig;
+    /** 配置访问 AgentRun 的静态 JWKS 凭证 */
+    static inboundStaticJwt(params: {
+        jwks: string;
+    }): CredentialConfig;
+    /** 配置访问 AgentRun 的远程 JWT 凭证 */
+    static inboundRemoteJwt(uri: string, timeout?: number, ttl?: number, publicConfig?: Record<string, any>): CredentialConfig;
+    /** 配置访问 AgentRun 的 Basic 凭证 */
+    static inboundBasic(params: {
+        users: CredentialBasicAuth[];
+    }): CredentialConfig;
+    /** 配置访问第三方工具的 api key 凭证 */
+    static outboundLLMApiKey(params: {
+        apiKey: string;
+        provider: string;
+    }): CredentialConfig;
+    /** 配置访问第三方工具的 ak/sk 凭证 */
+    static outboundLLMAKSK(provider: string, accessKeyId: string, accessKeySecret: string, accountId: string): CredentialConfig;
+    /** 配置访问第三方工具的自定义凭证 */
+    static outboundToolAKSKCustom(params: {
+        authConfig: Record<string, string>;
+    }): CredentialConfig;
+    /** 配置访问第三方工具的自定义 Header 凭证 */
+    static outboundToolCustomHeader(params: {
+        headers: Record<string, string>;
+    }): CredentialConfig;
+}
+/** 凭证公共配置 */
+interface CredentialMutableProps {
+    /** 描述 */
+    description?: string;
+    /** 是否启用 */
+    enabled?: boolean;
+}
+interface CredentialImmutableProps {
+    credentialName?: string;
+}
+interface CredentialSystemProps {
+    credentialId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    relatedResources?: RelatedResource[];
+}
+interface CredentialCreateInput extends CredentialMutableProps, CredentialImmutableProps {
+    credentialConfig?: CredentialConfig;
+}
+/**
+ * Credential update input
+ */
+interface CredentialUpdateInput extends CredentialMutableProps {
+    credentialConfig?: CredentialConfig;
+}
+/**
+ * Credential list input
+ */
+interface CredentialListInput extends PageableInput {
+    credentialAuthType?: CredentialAuthType;
+    credentialName?: string;
+    credentialSourceType?: CredentialSourceType;
+    provider?: string;
+}
+declare class CredentialListOutput {
+    createdAt?: string;
+    credentialAuthType?: CredentialAuthType;
+    credentialId?: string;
+    credentialName?: string;
+    credentialSourceType?: CredentialSourceType;
+    enabled?: boolean;
+    relatedResourceCount?: number;
+    updatedAt?: string;
+    constructor(data?: any);
+    uniqIdCallback: () => string | undefined;
+    toCredential: (params?: {
+        config?: Config;
+    }) => Promise<Credential>;
+}
+/**
+ * Credential resource class
+ */
+interface CredentialInterface extends CredentialMutableProps, CredentialImmutableProps, CredentialSystemProps, CredentialConfigInterface {
+}
+
+declare class Credential extends ResourceBase implements CredentialInterface {
+    credentialName?: string;
+    /** 描述 */
+    description?: string;
+    /** 是否启用 */
+    enabled?: boolean;
+    credentialId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    relatedResources?: RelatedResource[];
+    /** 凭证认证类型 */
+    credentialAuthType?: CredentialAuthType;
+    /** 凭证来源类型 */
+    credentialSourceType?: CredentialSourceType;
+    /** 凭证公共配置 */
+    credentialPublicConfig?: Record<string, any>;
+    /** 凭证密钥 */
+    credentialSecret?: string;
+    protected _config?: Config;
+    constructor(data?: any, config?: Config);
+    private static getClient;
+    /**
+     * Create a new Credential
+     */
+    static create: (paramsOrInput: any) => Promise<Credential>;
+    /**
+     * Delete a Credential by name
+     */
+    static delete: (paramsOrName: any) => Promise<Credential>;
+    /**
+     * Update a Credential by name
+     */
+    static update: (paramsOrName: any) => Promise<Credential>;
+    /**
+     * Get a Credential by name
+     */
+    static get: (paramsOrName: any) => Promise<Credential>;
+    /**
+     * List all Credentials (with pagination)
+     */
+    static list: (paramsOrUndefined?: any) => Promise<CredentialListOutput[]>;
+    static listAll: (params?: (Omit<any, "pageNumber" | "pageSize"> & {
+        config?: Config;
+    }) | undefined) => Promise<any[]>;
+    /**
+     * Delete this credential
+     */
+    delete: (params?: any) => Promise<this>;
+    /**
+     * Update this credential
+     */
+    update: (params: any) => Promise<this>;
+    /**
+     * Refresh this credential's data
+     */
+    get: (params?: any) => Promise<Credential>;
+}
+
+/**
+ * Credential Client
+ *
+ * 此模块提供 Credential 的客户端 API。
+ * This module provides the client API for Credential.
+ */
+
+/**
+ * Credential Client
+ *
+ * 提供 Credential 的创建、删除、更新、查询功能。
+ * Provides create, delete, update, query functions for Credential.
+ */
+declare class CredentialClient {
+    private config?;
+    private controlApi;
+    constructor(config?: Config);
+    /**
+     * Create a Credential
+     */
+    create: (params: {
+        input: CredentialCreateInput;
+        config?: Config;
+    }) => Promise<Credential>;
+    /**
+     * Delete a Credential
+     */
+    delete: (params: {
+        name: string;
+        config?: Config;
+    }) => Promise<Credential>;
+    /**
+     * Update a Credential
+     */
+    update: (params: {
+        name: string;
+        input: CredentialUpdateInput;
+        config?: Config;
+    }) => Promise<Credential>;
+    /**
+     * Get a Credential
+     */
+    get: (params: {
+        name: string;
+        config?: Config;
+    }) => Promise<Credential>;
+    /**
+     * List Credentials
+     */
+    list: (params?: {
+        input?: CredentialListInput;
+        config?: Config;
+    }) => Promise<CredentialListOutput[]>;
+}
+
+export { Credential, type CredentialBasicAuth, CredentialClient, CredentialConfig, type CredentialCreateInput, type CredentialListInput, CredentialListOutput, type CredentialUpdateInput, type RelatedResource };