@ caraer/ 客户

生成类型脚本客户端( xios) 卡拉尔API。 。 。 .

在每次Caraer后端生产部署后,此寄存器会自动从生产OpenAPI spec中再生成. 手写无服务器有效载荷助手 apps.ts 被保存在整个再生过程中.

安装

npm install @caraer/client

文档

• API 参考 : https://developer.caraer.com (中文(简体) )
• 打开API : https://v2.api.caraer.com/api-docs.yaml 页面存档备份,存于互联网档案馆
• 资料来源: https://github.com/Caraer-HQ/Caraer-js-客户端 互联网档案馆的存檔,存档日期2013-12-22

认证

以 Bearer 令牌配置生成的轴客户端( 见生成) configuration 在第一个代码发布后帮助者).

无服务器应用程序有效载荷类型

为生命周期/ webhook / 调度/ 输入/ 工作机构导入打入的帮助器 (而不是运行) caraer apps typegen:

import type {
  LifecyclePayload,
  WebhookPayload,
  SchedulePayload,
  InboundPayload,
  JobPayload,
  SettingFieldValue,
} from "@caraer/client";

export const handler = async (req: { body: LifecyclePayload }, res: any) => {
  const body = req.body;
  // ...
};

普通联署材料:

/**
 * @param {import('@caraer/client').LifecyclePayload} body
 */
function onInstall(body) {
  // ...
}

许可证

见 自由主义。 。 。 .