Typescript SDK Version 1.x.x

• 语言: 英语
• 格式: .pdf
• 来源: www.zoho.com

摘要

The document provides an overview of the TypeScript SDK, including its installation, configuration, and usage. It details how to set up the environment, configure the SDK, and handle OAuth tokens for authentication. The document also covers multi-user support functionality and explains how to manage user configurations. Additionally, it includes information on handling exceptions and provides sample code for various operations.

AI总结

### 《Typescript SDK Version 1.x.x》总结

#### 1. 概述
- Zoho CRM 的 TypeScript SDK 提供了一种创建客户端 TypeScript 应用程序并集成到 Zoho CRM 的方式。
- SDK 通过 npm 安装，支持 Node.js（版本 12 及以上）。

#### 2. 安装与环境配置
- 安装命令：`npm install @zohocrm/typescript-sdk`
- 支持通过 `package.json` 依赖管理或直接安装。

#### 3. 配置
- **Token 持久化**：支持以下几种方式：
- **OAuth 持久化**：用于 OAuth 令牌存储。
- **数据库持久化**：将令牌存储在数据库中。
- **文件持久化**：将令牌存储在文件中。
- **自定义持久化**：允许用户自定义存储逻辑。
- **SDK 配置**：
- 可通过 `SDKConfigBuilder` 设置配置，例如 `autoRefreshFields` 和 `pickListValidation`。
- 示例配置：

    let sdkConfig: SDKConfig = new SDKConfigBuilder()
      .setPickListValidation(false)
      .setAutoRefreshFields(true)
      .build();

#### 4. 多用户支持
- SDK 支持单用户和多用户应用。
- 切换用户通过 `Initializer.switchUser` 方法实现：

  await Initializer.switchUser(user, environment, token, sdkConfig, requestProxy);

- 移除用户配置：

  await Initializer.removeUserConfiguration(user, environment);

#### 5. 异常与响应
- **SDKException**：用于包装 SDK 异常和其他意外行为。
- **APIResponse**：所有 SDK 方法调用的通用响应实例。
- **StreamWrapper**：用于文件操作的包装类。

#### 6. 发布说明
- **当前版本**：1.1.1
- 修复了 Windows 系统中因文件处理不当导致的 `Cannot read property 'hasOwnProperty'` 错误。
- **历史版本**：
- 1.1.0：支持外部 ID。
- 1.0.2：处理日期对象。
- 1.0.1：初始版本。

#### 7. 核心功能
- **模块化结构**：每个 CRM 实体对应一个包，包内包含操作类，支持所有可能的操作。
- **日志记录**：通过 `Logger` 类实现，支持不同日志级别和文件路径配置。

#### 8. 样例代码
- 示例代码展示了如何使用 SDK 进行基本操作，包括初始化、配置、请求处理等。

总结：Zoho CRM 的 TypeScript SDK 提供了强大而灵活的工具集，支持多种配置和持久化方式，适用于单用户和多用户场景，并通过模块化设计确保代码的可维护性和扩展性。