@gleanwork/api-client 0.18.1 → 0.19.0

package/src/sdk/triggers.ts

@@ -0,0 +1,210 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2b0bc3f627a3
+ */
+
+import { triggersCreate } from "../funcs/triggersCreate.js";
+import { triggersDelete } from "../funcs/triggersDelete.js";
+import { triggersGet } from "../funcs/triggersGet.js";
+import { triggersGetPreset } from "../funcs/triggersGetPreset.js";
+import { triggersList } from "../funcs/triggersList.js";
+import { triggersListPresetInputValues } from "../funcs/triggersListPresetInputValues.js";
+import { triggersListPresets } from "../funcs/triggersListPresets.js";
+import { triggersSearchEvents } from "../funcs/triggersSearchEvents.js";
+import { triggersSearchPresetEvents } from "../funcs/triggersSearchPresetEvents.js";
+import { triggersUpdate } from "../funcs/triggersUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Triggers extends ClientSDK {
+  /**
+   * Create trigger
+   *
+   * @remarks
+   * Create a trigger from a preset and return it with its signing secret.
+   */
+  async create(
+    request: components.PlatformTriggerCreateRequest,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerCreateResponse> {
+    return unwrapAsync(triggersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List triggers
+   *
+   * @remarks
+   * List triggers owned by the authenticated caller.
+   */
+  async list(
+    pageSize?: number | undefined,
+    cursor?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerListResponse> {
+    return unwrapAsync(triggersList(
+      this,
+      pageSize,
+      cursor,
+      options,
+    ));
+  }
+
+  /**
+   * Get trigger
+   *
+   * @remarks
+   * Retrieve a trigger owned by the authenticated caller.
+   */
+  async get(
+    triggerId: string,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerGetResponse> {
+    return unwrapAsync(triggersGet(
+      this,
+      triggerId,
+      options,
+    ));
+  }
+
+  /**
+   * Update trigger
+   *
+   * @remarks
+   * Update a trigger.
+   */
+  async update(
+    platformTriggerUpdateRequest: components.PlatformTriggerUpdateRequest,
+    triggerId: string,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerGetResponse> {
+    return unwrapAsync(triggersUpdate(
+      this,
+      platformTriggerUpdateRequest,
+      triggerId,
+      options,
+    ));
+  }
+
+  /**
+   * Delete trigger
+   *
+   * @remarks
+   * Delete a trigger.
+   */
+  async delete(
+    triggerId: string,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(triggersDelete(
+      this,
+      triggerId,
+      options,
+    ));
+  }
+
+  /**
+   * Search events for a trigger
+   *
+   * @remarks
+   * Search recent content events an existing trigger matches. Read-only — no webhook delivery is made. Covers the last seven days.
+   */
+  async searchEvents(
+    triggerId: string,
+    platformTriggerEventSearchRequest?:
+      | components.PlatformTriggerEventSearchRequest
+      | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerEventSearchResponse> {
+    return unwrapAsync(triggersSearchEvents(
+      this,
+      triggerId,
+      platformTriggerEventSearchRequest,
+      options,
+    ));
+  }
+
+  /**
+   * List trigger presets
+   *
+   * @remarks
+   * List the trigger presets available to the caller. A preset is a curated content-trigger template (e.g. a new Jira ticket) which is passed when creating a trigger.
+   */
+  async listPresets(
+    datasource?: string | undefined,
+    pageSize?: number | undefined,
+    cursor?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerPresetListResponse> {
+    return unwrapAsync(triggersListPresets(
+      this,
+      datasource,
+      pageSize,
+      cursor,
+      options,
+    ));
+  }
+
+  /**
+   * Get trigger preset
+   *
+   * @remarks
+   * Retrieve a single trigger preset by id.
+   */
+  async getPreset(
+    presetId: string,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerPresetGetResponse> {
+    return unwrapAsync(triggersGetPreset(
+      this,
+      presetId,
+      options,
+    ));
+  }
+
+  /**
+   * Search trigger preset input values
+   *
+   * @remarks
+   * Return up to 300 selectable values for a single picklist input on a preset. Results are intended for typeahead selection and are not cursor-paginated. When `is_truncated` is true, refine `query` to narrow the result set.
+   */
+  async listPresetInputValues(
+    presetId: string,
+    field: string,
+    query?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerPresetInputValueListResponse> {
+    return unwrapAsync(triggersListPresetInputValues(
+      this,
+      presetId,
+      field,
+      query,
+      options,
+    ));
+  }
+
+  /**
+   * Search events for a trigger preset
+   *
+   * @remarks
+   * Search recent content events an unsaved trigger built from this preset would match, to preview it before creating the trigger. Read-only — no trigger is created and no webhook delivery is made. Covers the last seven days.
+   */
+  async searchPresetEvents(
+    presetId: string,
+    platformTriggerPresetEventSearchRequest?:
+      | components.PlatformTriggerPresetEventSearchRequest
+      | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PlatformTriggerEventSearchResponse> {
+    return unwrapAsync(triggersSearchPresetEvents(
+      this,
+      presetId,
+      platformTriggerPresetEventSearchRequest,
+      options,
+    ));
+  }
+}