@zavudev/sdk 0.55.0 → 0.56.0

package/src/resources/functions/git-link.ts

@@ -0,0 +1,398 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class GitLink extends APIResource {
+  /**
+   * The link and its last deploy. Never returns the webhook secret.
+   *
+   * @example
+   * ```ts
+   * const gitLink = await client.functions.gitLink.retrieve(
+   *   'functionId',
+   * );
+   * ```
+   */
+  retrieve(functionID: string, options?: RequestOptions): APIPromise<GitLinkRetrieveResponse> {
+    return this._client.get(path`/v1/functions/${functionID}/git-link`, options);
+  }
+
+  /**
+   * Change the branch, the root directory, or whether pushes deploy. Pass at least
+   * one field. `rootDir: null` clears the subdirectory.
+   *
+   * @example
+   * ```ts
+   * const gitLink = await client.functions.gitLink.update(
+   *   'functionId',
+   * );
+   * ```
+   */
+  update(
+    functionID: string,
+    body: GitLinkUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<GitLinkUpdateResponse> {
+    return this._client.patch(path`/v1/functions/${functionID}/git-link`, { body, ...options });
+  }
+
+  /**
+   * Fetch the linked branch and deploy it without waiting for a push. Returns
+   * immediately; follow the outcome with `GET /v1/functions/{functionId}/git-link`,
+   * whose `lastStatus` and `lastError` describe the run.
+   *
+   * @example
+   * ```ts
+   * const response = await client.functions.gitLink.deployNow(
+   *   'functionId',
+   * );
+   * ```
+   */
+  deployNow(functionID: string, options?: RequestOptions): APIPromise<GitLinkDeployNowResponse> {
+    return this._client.post(path`/v1/functions/${functionID}/git-link/deploy`, options);
+  }
+
+  /**
+   * Bind a repository to this function so every push to `branch` deploys it. A
+   * function holds at most one link; linking again returns 400.
+   *
+   * **The server decides how the link authenticates.** If the project has the Zavu
+   * GitHub App installed, the link uses that installation: private repositories work
+   * and there is nothing to configure in the repository. Otherwise it falls back to
+   * a manual link and the response carries a `webhookSecret` you add to the
+   * repository yourself. `connection` says which one you got.
+   *
+   * The repository is not checked against GitHub here, because it cannot be: an
+   * owner/repo that does not exist, or that the installation cannot see, is accepted
+   * and fails on the first deploy with a fetch error.
+   *
+   * @example
+   * ```ts
+   * const response = await client.functions.gitLink.link(
+   *   'functionId',
+   *   {
+   *     owner: 'acme',
+   *     repo: 'order-bot',
+   *     branch: 'main',
+   *   },
+   * );
+   * ```
+   */
+  link(
+    functionID: string,
+    body: GitLinkLinkParams,
+    options?: RequestOptions,
+  ): APIPromise<GitLinkLinkResponse> {
+    return this._client.post(path`/v1/functions/${functionID}/git-link`, { body, ...options });
+  }
+
+  /**
+   * Remove the link. The function and its deployments stay. A manual webhook left in
+   * the repository stops being accepted, so remove it there too.
+   *
+   * @example
+   * ```ts
+   * await client.functions.gitLink.unlink('functionId');
+   * ```
+   */
+  unlink(functionID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/functions/${functionID}/git-link`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface GitLinkRetrieveResponse {
+  /**
+   * A GitHub repository bound to a function. A push to `branch` deploys the
+   * function. A function holds at most one link.
+   */
+  link: GitLinkRetrieveResponse.Link;
+
+  /**
+   * Endpoint that receives GitHub's push deliveries. Only needed on a `manual` link,
+   * where you add it to the repository yourself.
+   */
+  webhookUrl: string;
+
+  /**
+   * Shared secret for the repository's webhook. **Returned only when creating a
+   * `manual` link, and only there** — every later read strips it, and re-linking
+   * mints a new one. Absent entirely on an `app` link, which needs no secret of its
+   * own.
+   */
+  webhookSecret?: string;
+}
+
+export namespace GitLinkRetrieveResponse {
+  /**
+   * A GitHub repository bound to a function. A push to `branch` deploys the
+   * function. A function holds at most one link.
+   */
+  export interface Link {
+    id: string;
+
+    /**
+     * When false the link is kept and pushes are ignored.
+     */
+    autoDeploy: boolean;
+
+    /**
+     * Only pushes to this branch deploy.
+     */
+    branch: string;
+
+    /**
+     * How this link authenticates, decided by the server rather than by the caller.
+     *
+     * - `app`: the Zavu GitHub App is installed on the account. Pushes arrive on the
+     *   app's webhook and private repositories work. Nothing to configure in the
+     *   repository.
+     * - `manual`: no installation. The link carries its own secret and you add the
+     *   webhook to the repository yourself.
+     */
+    connection: 'app' | 'manual';
+
+    createdAt: string;
+
+    functionId: string;
+
+    owner: string;
+
+    provider: 'github';
+
+    repo: string;
+
+    updatedAt: string;
+
+    lastCommitMessage?: string | null;
+
+    lastCommitSha?: string | null;
+
+    lastDeployAt?: string | null;
+
+    /**
+     * Why the last deploy failed. Null otherwise.
+     */
+    lastError?: string | null;
+
+    lastStatus?: 'deploying' | 'deployed' | 'failed' | null;
+
+    /**
+     * Subdirectory holding the project, for monorepos. Null when the project is at the
+     * repository root.
+     */
+    rootDir?: string | null;
+  }
+}
+
+export interface GitLinkUpdateResponse {
+  /**
+   * A GitHub repository bound to a function. A push to `branch` deploys the
+   * function. A function holds at most one link.
+   */
+  link: GitLinkUpdateResponse.Link;
+
+  /**
+   * Endpoint that receives GitHub's push deliveries. Only needed on a `manual` link,
+   * where you add it to the repository yourself.
+   */
+  webhookUrl: string;
+
+  /**
+   * Shared secret for the repository's webhook. **Returned only when creating a
+   * `manual` link, and only there** — every later read strips it, and re-linking
+   * mints a new one. Absent entirely on an `app` link, which needs no secret of its
+   * own.
+   */
+  webhookSecret?: string;
+}
+
+export namespace GitLinkUpdateResponse {
+  /**
+   * A GitHub repository bound to a function. A push to `branch` deploys the
+   * function. A function holds at most one link.
+   */
+  export interface Link {
+    id: string;
+
+    /**
+     * When false the link is kept and pushes are ignored.
+     */
+    autoDeploy: boolean;
+
+    /**
+     * Only pushes to this branch deploy.
+     */
+    branch: string;
+
+    /**
+     * How this link authenticates, decided by the server rather than by the caller.
+     *
+     * - `app`: the Zavu GitHub App is installed on the account. Pushes arrive on the
+     *   app's webhook and private repositories work. Nothing to configure in the
+     *   repository.
+     * - `manual`: no installation. The link carries its own secret and you add the
+     *   webhook to the repository yourself.
+     */
+    connection: 'app' | 'manual';
+
+    createdAt: string;
+
+    functionId: string;
+
+    owner: string;
+
+    provider: 'github';
+
+    repo: string;
+
+    updatedAt: string;
+
+    lastCommitMessage?: string | null;
+
+    lastCommitSha?: string | null;
+
+    lastDeployAt?: string | null;
+
+    /**
+     * Why the last deploy failed. Null otherwise.
+     */
+    lastError?: string | null;
+
+    lastStatus?: 'deploying' | 'deployed' | 'failed' | null;
+
+    /**
+     * Subdirectory holding the project, for monorepos. Null when the project is at the
+     * repository root.
+     */
+    rootDir?: string | null;
+  }
+}
+
+export interface GitLinkDeployNowResponse {
+  scheduled: boolean;
+}
+
+export interface GitLinkLinkResponse {
+  /**
+   * A GitHub repository bound to a function. A push to `branch` deploys the
+   * function. A function holds at most one link.
+   */
+  link: GitLinkLinkResponse.Link;
+
+  /**
+   * Endpoint that receives GitHub's push deliveries. Only needed on a `manual` link,
+   * where you add it to the repository yourself.
+   */
+  webhookUrl: string;
+
+  /**
+   * Shared secret for the repository's webhook. **Returned only when creating a
+   * `manual` link, and only there** — every later read strips it, and re-linking
+   * mints a new one. Absent entirely on an `app` link, which needs no secret of its
+   * own.
+   */
+  webhookSecret?: string;
+}
+
+export namespace GitLinkLinkResponse {
+  /**
+   * A GitHub repository bound to a function. A push to `branch` deploys the
+   * function. A function holds at most one link.
+   */
+  export interface Link {
+    id: string;
+
+    /**
+     * When false the link is kept and pushes are ignored.
+     */
+    autoDeploy: boolean;
+
+    /**
+     * Only pushes to this branch deploy.
+     */
+    branch: string;
+
+    /**
+     * How this link authenticates, decided by the server rather than by the caller.
+     *
+     * - `app`: the Zavu GitHub App is installed on the account. Pushes arrive on the
+     *   app's webhook and private repositories work. Nothing to configure in the
+     *   repository.
+     * - `manual`: no installation. The link carries its own secret and you add the
+     *   webhook to the repository yourself.
+     */
+    connection: 'app' | 'manual';
+
+    createdAt: string;
+
+    functionId: string;
+
+    owner: string;
+
+    provider: 'github';
+
+    repo: string;
+
+    updatedAt: string;
+
+    lastCommitMessage?: string | null;
+
+    lastCommitSha?: string | null;
+
+    lastDeployAt?: string | null;
+
+    /**
+     * Why the last deploy failed. Null otherwise.
+     */
+    lastError?: string | null;
+
+    lastStatus?: 'deploying' | 'deployed' | 'failed' | null;
+
+    /**
+     * Subdirectory holding the project, for monorepos. Null when the project is at the
+     * repository root.
+     */
+    rootDir?: string | null;
+  }
+}
+
+export interface GitLinkUpdateParams {
+  autoDeploy?: boolean;
+
+  branch?: string;
+
+  rootDir?: string | null;
+}
+
+export interface GitLinkLinkParams {
+  owner: string;
+
+  repo: string;
+
+  autoDeploy?: boolean;
+
+  branch?: string;
+
+  /**
+   * Subdirectory holding the project, for monorepos.
+   */
+  rootDir?: string;
+}
+
+export declare namespace GitLink {
+  export {
+    type GitLinkRetrieveResponse as GitLinkRetrieveResponse,
+    type GitLinkUpdateResponse as GitLinkUpdateResponse,
+    type GitLinkDeployNowResponse as GitLinkDeployNowResponse,
+    type GitLinkLinkResponse as GitLinkLinkResponse,
+    type GitLinkUpdateParams as GitLinkUpdateParams,
+    type GitLinkLinkParams as GitLinkLinkParams,
+  };
+}

package/src/resources/functions/index.ts

@@ -8,12 +8,26 @@ export {
   type FunctionDeleteResponse,
   type FunctionDeployResponse,
   type FunctionGetDeploymentResponse,
+  type FunctionListDeploymentsResponse,
+  type FunctionListEventTypesResponse,
+  type FunctionRollbackDeploymentResponse,
   type FunctionTailLogsResponse,
   type FunctionCreateParams,
   type FunctionUpdateParams,
   type FunctionDeployParams,
+  type FunctionListDeploymentsParams,
+  type FunctionRollbackDeploymentParams,
   type FunctionTailLogsParams,
 } from './functions';
+export {
+  GitLink,
+  type GitLinkRetrieveResponse,
+  type GitLinkUpdateResponse,
+  type GitLinkDeployNowResponse,
+  type GitLinkLinkResponse,
+  type GitLinkUpdateParams,
+  type GitLinkLinkParams,
+} from './git-link';
 export {
   Secrets,
   type SecretListResponse,
@@ -21,3 +35,11 @@ export {
   type SecretSetParams,
   type SecretUnsetParams,
 } from './secrets';
+export {
+  Triggers,
+  type TriggerCreateResponse,
+  type TriggerUpdateResponse,
+  type TriggerListResponse,
+  type TriggerCreateParams,
+  type TriggerUpdateParams,
+} from './triggers';

package/src/resources/functions/triggers.ts

@@ -0,0 +1,227 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Triggers extends APIResource {
+  /**
+   * Subscribe a function to one or more event types, optionally scoped to specific
+   * senders. Provide eventTypes and senderIds (use null in senderIds for all
+   * senders); a trigger is created for each event type and sender combination.
+   *
+   * The special event type `cron` runs the function on a schedule instead of a
+   * messaging event: include a `cron` field with a 5-field UTC cron expression
+   * (minimum granularity one minute). A cron trigger ignores the sender axis, and a
+   * function may hold several cron triggers with different expressions. The function
+   * receives an event with `type: "cron"` and `data.cron`.
+   *
+   * @example
+   * ```ts
+   * const trigger = await client.functions.triggers.create(
+   *   'functionId',
+   *   { eventTypes: ['message.inbound'], senderIds: [null] },
+   * );
+   * ```
+   */
+  create(
+    functionID: string,
+    body: TriggerCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<TriggerCreateResponse> {
+    return this._client.post(path`/v1/functions/${functionID}/triggers`, { body, ...options });
+  }
+
+  /**
+   * Enable or disable a trigger
+   *
+   * @example
+   * ```ts
+   * const trigger = await client.functions.triggers.update(
+   *   'triggerId',
+   *   { active: true },
+   * );
+   * ```
+   */
+  update(
+    triggerID: string,
+    body: TriggerUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<TriggerUpdateResponse> {
+    return this._client.patch(path`/v1/functions/triggers/${triggerID}`, { body, ...options });
+  }
+
+  /**
+   * List function triggers
+   *
+   * @example
+   * ```ts
+   * const triggers = await client.functions.triggers.list(
+   *   'functionId',
+   * );
+   * ```
+   */
+  list(functionID: string, options?: RequestOptions): APIPromise<TriggerListResponse> {
+    return this._client.get(path`/v1/functions/${functionID}/triggers`, options);
+  }
+
+  /**
+   * Delete a trigger
+   *
+   * @example
+   * ```ts
+   * await client.functions.triggers.delete('triggerId');
+   * ```
+   */
+  delete(triggerID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/functions/triggers/${triggerID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface TriggerCreateResponse {
+  added: number;
+
+  /**
+   * Number of triggers that already existed.
+   */
+  skipped: number;
+
+  triggers: Array<TriggerCreateResponse.Trigger>;
+}
+
+export namespace TriggerCreateResponse {
+  /**
+   * A subscription that runs a Zavu Function when a messaging event fires.
+   */
+  export interface Trigger {
+    id: string;
+
+    active: boolean;
+
+    createdAt: string;
+
+    /**
+     * Event type that fires the function. See GET /v1/functions/event-types for the
+     * supported list. The special type `cron` fires on a schedule instead of a
+     * messaging event and carries a `cron` expression.
+     */
+    eventType: string;
+
+    functionId: string;
+
+    updatedAt: string;
+
+    /**
+     * 5-field cron expression (minute hour day-of-month month day-of-week), evaluated
+     * in UTC. Present only on `cron` triggers.
+     */
+    cron?: string | null;
+
+    /**
+     * Last time the schedule fired. Null until the first fire.
+     */
+    lastRunAt?: string | null;
+
+    /**
+     * Next scheduled fire time. Present only on `cron` triggers.
+     */
+    nextRunAt?: string | null;
+
+    /**
+     * Restrict the trigger to a single sender. Null means all senders in the project.
+     */
+    senderId?: string | null;
+  }
+}
+
+export interface TriggerUpdateResponse {
+  active: boolean;
+
+  ok: boolean;
+}
+
+export interface TriggerListResponse {
+  triggers: Array<TriggerListResponse.Trigger>;
+}
+
+export namespace TriggerListResponse {
+  /**
+   * A subscription that runs a Zavu Function when a messaging event fires.
+   */
+  export interface Trigger {
+    id: string;
+
+    active: boolean;
+
+    createdAt: string;
+
+    /**
+     * Event type that fires the function. See GET /v1/functions/event-types for the
+     * supported list. The special type `cron` fires on a schedule instead of a
+     * messaging event and carries a `cron` expression.
+     */
+    eventType: string;
+
+    functionId: string;
+
+    updatedAt: string;
+
+    /**
+     * 5-field cron expression (minute hour day-of-month month day-of-week), evaluated
+     * in UTC. Present only on `cron` triggers.
+     */
+    cron?: string | null;
+
+    /**
+     * Last time the schedule fired. Null until the first fire.
+     */
+    lastRunAt?: string | null;
+
+    /**
+     * Next scheduled fire time. Present only on `cron` triggers.
+     */
+    nextRunAt?: string | null;
+
+    /**
+     * Restrict the trigger to a single sender. Null means all senders in the project.
+     */
+    senderId?: string | null;
+  }
+}
+
+export interface TriggerCreateParams {
+  /**
+   * Event types to subscribe to.
+   */
+  eventTypes: Array<string>;
+
+  /**
+   * Senders to scope the triggers to. Use null for all senders.
+   */
+  senderIds: Array<string | null>;
+
+  /**
+   * Required when eventTypes includes `cron`: a 5-field cron expression (minute hour
+   * day-of-month month day-of-week), evaluated in UTC.
+   */
+  cron?: string;
+}
+
+export interface TriggerUpdateParams {
+  active: boolean;
+}
+
+export declare namespace Triggers {
+  export {
+    type TriggerCreateResponse as TriggerCreateResponse,
+    type TriggerUpdateResponse as TriggerUpdateResponse,
+    type TriggerListResponse as TriggerListResponse,
+    type TriggerCreateParams as TriggerCreateParams,
+    type TriggerUpdateParams as TriggerUpdateParams,
+  };
+}