@gleanwork/api-client 0.18.1 → 0.19.1

package/src/models/components/platformtriggerevent.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 65504019ad77
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTriggerEventReason,
+  PlatformTriggerEventReason$inboundSchema,
+} from "./platformtriggereventreason.js";
+import {
+  PlatformTriggerEventType,
+  PlatformTriggerEventType$inboundSchema,
+} from "./platformtriggereventtype.js";
+
+/**
+ * A content event a trigger can fire on.
+ */
+export type PlatformTriggerEvent = {
+  /**
+   * The kind of event.
+   */
+  event_type: PlatformTriggerEventType;
+  /**
+   * Datasource the event originated from.
+   */
+  datasource: string;
+  /**
+   * Why the event fired.
+   */
+  reason: PlatformTriggerEventReason;
+  /**
+   * Datasource-specific object type.
+   */
+  doc_type: string;
+  /**
+   * Identifier of the document the event is about.
+   */
+  doc_id: string;
+  /**
+   * Link to the document in its source system.
+   */
+  view_url: string;
+  /**
+   * Title of the document, or the subject for email.
+   */
+  title: string;
+  /**
+   * When the event happened at the source: the document's own change timestamp for a document change, and the scheduled time for a content schedule. Omitted when the source did not supply one.
+   */
+  event_time: Date;
+};
+
+/** @internal */
+export const PlatformTriggerEvent$inboundSchema: z.ZodType<
+  PlatformTriggerEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  event_type: PlatformTriggerEventType$inboundSchema,
+  datasource: z.string(),
+  reason: PlatformTriggerEventReason$inboundSchema,
+  doc_type: z.string(),
+  doc_id: z.string(),
+  view_url: z.string(),
+  title: z.string(),
+  event_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function platformTriggerEventFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerEvent' from JSON`,
+  );
+}

package/src/models/components/platformtriggereventreason.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3e21a733137e
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Why the event fired.
+ */
+export const PlatformTriggerEventReason = {
+  /**
+   * The document was created.
+   */
+  Created: "CREATED",
+  /**
+   * The document was updated.
+   */
+  Updated: "UPDATED",
+  /**
+   * The document was deleted.
+   */
+  Deleted: "DELETED",
+  /**
+   * The document started matching the trigger's conditions.
+   */
+  MeetsCondition: "MEETS_CONDITION",
+  /**
+   * The item was assigned to someone.
+   */
+  Assigned: "ASSIGNED",
+  /**
+   * The item was unassigned.
+   */
+  Unassigned: "UNASSIGNED",
+  /**
+   * A label was added.
+   */
+  Labeled: "LABELED",
+  /**
+   * A label was removed.
+   */
+  Unlabeled: "UNLABELED",
+  /**
+   * A review was requested.
+   */
+  ReviewRequested: "REVIEW_REQUESTED",
+  /**
+   * A review request was withdrawn.
+   */
+  ReviewRequestRemoved: "REVIEW_REQUEST_REMOVED",
+  /**
+   * A draft was marked ready for review.
+   */
+  ReadyForReview: "READY_FOR_REVIEW",
+  /**
+   * The item was converted back to a draft.
+   */
+  ConvertedToDraft: "CONVERTED_TO_DRAFT",
+  /**
+   * The source system sent a webhook update.
+   */
+  WebhookUpdated: "WEBHOOK_UPDATED",
+} as const;
+/**
+ * Why the event fired.
+ */
+export type PlatformTriggerEventReason = OpenEnum<
+  typeof PlatformTriggerEventReason
+>;
+
+/** @internal */
+export const PlatformTriggerEventReason$inboundSchema: z.ZodType<
+  PlatformTriggerEventReason,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformTriggerEventReason);

package/src/models/components/platformtriggereventsearchrequest.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 65684ccd7f59
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformTriggerEventSearchRequest = {
+  /**
+   * Maximum number of events to return.
+   */
+  page_size?: number | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerEventSearchRequest$Outbound = {
+  page_size: number;
+};
+
+/** @internal */
+export const PlatformTriggerEventSearchRequest$outboundSchema: z.ZodType<
+  PlatformTriggerEventSearchRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerEventSearchRequest
+> = z.object({
+  page_size: z.number().int().default(10),
+});
+
+export function platformTriggerEventSearchRequestToJSON(
+  platformTriggerEventSearchRequest: PlatformTriggerEventSearchRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerEventSearchRequest$outboundSchema.parse(
+      platformTriggerEventSearchRequest,
+    ),
+  );
+}

package/src/models/components/platformtriggereventsearchresponse.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b64d9d75e048
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTriggerEvent,
+  PlatformTriggerEvent$inboundSchema,
+} from "./platformtriggerevent.js";
+
+export type PlatformTriggerEventSearchResponse = {
+  /**
+   * Matching events, most recent first.
+   */
+  results: Array<PlatformTriggerEvent>;
+  /**
+   * Whether more events matched than were returned. Raise `page_size` to see more; cursor-based paging is not offered yet.
+   *
+   * @remarks
+   */
+  has_more: boolean;
+  /**
+   * Unique identifier for this request, for support and debugging.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerEventSearchResponse$inboundSchema: z.ZodType<
+  PlatformTriggerEventSearchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.array(PlatformTriggerEvent$inboundSchema),
+  has_more: z.boolean(),
+  request_id: z.string(),
+});
+
+export function platformTriggerEventSearchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerEventSearchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformTriggerEventSearchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerEventSearchResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggereventtype.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d4161262b77b
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The kind of event.
+ */
+export const PlatformTriggerEventType = {
+  /**
+   * A document was created, updated, or deleted.
+   */
+  DocumentChange: "DOCUMENT_CHANGE",
+} as const;
+/**
+ * The kind of event.
+ */
+export type PlatformTriggerEventType = ClosedEnum<
+  typeof PlatformTriggerEventType
+>;
+
+/** @internal */
+export const PlatformTriggerEventType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformTriggerEventType
+> = z.nativeEnum(PlatformTriggerEventType);

package/src/models/components/platformtriggergetresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 833e1cd130ea
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTrigger,
+  PlatformTrigger$inboundSchema,
+} from "./platformtrigger.js";
+
+export type PlatformTriggerGetResponse = {
+  trigger: PlatformTrigger;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerGetResponse$inboundSchema: z.ZodType<
+  PlatformTriggerGetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trigger: PlatformTrigger$inboundSchema,
+  request_id: z.string(),
+});
+
+export function platformTriggerGetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerGetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerGetResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggerlistresponse.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a86bc5bc05bc
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTrigger,
+  PlatformTrigger$inboundSchema,
+} from "./platformtrigger.js";
+
+export type PlatformTriggerListResponse = {
+  /**
+   * Triggers owned by the caller.
+   */
+  results: Array<PlatformTrigger>;
+  /**
+   * Whether additional results are available.
+   */
+  has_more: boolean;
+  /**
+   * Cursor for the next page, or null when no more results are available.
+   */
+  next_cursor: string | null;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerListResponse$inboundSchema: z.ZodType<
+  PlatformTriggerListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.array(PlatformTrigger$inboundSchema),
+  has_more: z.boolean(),
+  next_cursor: z.nullable(z.string()),
+  request_id: z.string(),
+});
+
+export function platformTriggerListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerListResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggerpreset.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f89c600b3e5e
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTriggerPresetInput,
+  PlatformTriggerPresetInput$inboundSchema,
+} from "./platformtriggerpresetinput.js";
+
+export type PlatformTriggerPreset = {
+  /**
+   * ID of the preset. Pass this when creating a trigger.
+   */
+  preset_id: string;
+  /**
+   * Datasource the preset fires on.
+   */
+  datasource: string;
+  /**
+   * Human-readable preset name.
+   */
+  display_name: string;
+  /**
+   * Human-readable description of when the preset fires.
+   */
+  description?: string | undefined;
+  /**
+   * Inputs the caller may supply when creating a trigger from this preset.
+   */
+  inputs: Array<PlatformTriggerPresetInput>;
+};
+
+/** @internal */
+export const PlatformTriggerPreset$inboundSchema: z.ZodType<
+  PlatformTriggerPreset,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  preset_id: z.string(),
+  datasource: z.string(),
+  display_name: z.string(),
+  description: z.string().optional(),
+  inputs: z.array(PlatformTriggerPresetInput$inboundSchema),
+});
+
+export function platformTriggerPresetFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerPreset, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerPreset$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerPreset' from JSON`,
+  );
+}

package/src/models/components/platformtriggerpreseteventsearchrequest.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 29798b980810
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformTriggerPresetEventSearchRequest = {
+  /**
+   * Values for the preset's input fields, keyed by field name.
+   *
+   * @remarks
+   */
+  inputs?: { [k: string]: string } | undefined;
+  /**
+   * Maximum number of events to return.
+   */
+  page_size?: number | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerPresetEventSearchRequest$Outbound = {
+  inputs?: { [k: string]: string } | undefined;
+  page_size: number;
+};
+
+/** @internal */
+export const PlatformTriggerPresetEventSearchRequest$outboundSchema: z.ZodType<
+  PlatformTriggerPresetEventSearchRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerPresetEventSearchRequest
+> = z.object({
+  inputs: z.record(z.string()).optional(),
+  page_size: z.number().int().default(10),
+});
+
+export function platformTriggerPresetEventSearchRequestToJSON(
+  platformTriggerPresetEventSearchRequest:
+    PlatformTriggerPresetEventSearchRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerPresetEventSearchRequest$outboundSchema.parse(
+      platformTriggerPresetEventSearchRequest,
+    ),
+  );
+}

package/src/models/components/platformtriggerpresetgetresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 944dd01b7642
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTriggerPreset,
+  PlatformTriggerPreset$inboundSchema,
+} from "./platformtriggerpreset.js";
+
+export type PlatformTriggerPresetGetResponse = {
+  trigger_preset: PlatformTriggerPreset;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerPresetGetResponse$inboundSchema: z.ZodType<
+  PlatformTriggerPresetGetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trigger_preset: PlatformTriggerPreset$inboundSchema,
+  request_id: z.string(),
+});
+
+export function platformTriggerPresetGetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerPresetGetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerPresetGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerPresetGetResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggerpresetinput.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2c279b6efb4d
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PlatformTriggerPresetInputType,
+  PlatformTriggerPresetInputType$inboundSchema,
+} from "./platformtriggerpresetinputtype.js";
+import {
+  PlatformTriggerPresetInputValue,
+  PlatformTriggerPresetInputValue$inboundSchema,
+} from "./platformtriggerpresetinputvalue.js";
+
+export type PlatformTriggerPresetInput = {
+  /**
+   * Identifier of the input, supplied as a key in the trigger's `inputs`.
+   */
+  field: string;
+  /**
+   * Type of a preset input.
+   */
+  type: PlatformTriggerPresetInputType;
+  /**
+   * Human-readable name for the input.
+   */
+  display_name: string;
+  /**
+   * Whether the caller must supply a value for this input.
+   */
+  is_required: boolean;
+  /**
+   * Bounded initial set of selectable values for a picklist input. Omitted entirely for free-text inputs.
+   *
+   * @remarks
+   */
+  values?: Array<PlatformTriggerPresetInputValue> | undefined;
+  /**
+   * Whether additional selectable values were omitted from `values`. When true, use GET /trigger-presets/{preset_id}/input-values with a query to narrow the result set.
+   *
+   * @remarks
+   */
+  is_truncated?: boolean | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerPresetInput$inboundSchema: z.ZodType<
+  PlatformTriggerPresetInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string(),
+  type: PlatformTriggerPresetInputType$inboundSchema,
+  display_name: z.string(),
+  is_required: z.boolean(),
+  values: z.array(PlatformTriggerPresetInputValue$inboundSchema).optional(),
+  is_truncated: z.boolean().optional(),
+});
+
+export function platformTriggerPresetInputFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerPresetInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerPresetInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerPresetInput' from JSON`,
+  );
+}

package/src/models/components/platformtriggerpresetinputtype.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 11af54e249ad
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Type of a preset input.
+ */
+export const PlatformTriggerPresetInputType = {
+  Picklist: "PICKLIST",
+  Text: "TEXT",
+  User: "USER",
+} as const;
+/**
+ * Type of a preset input.
+ */
+export type PlatformTriggerPresetInputType = OpenEnum<
+  typeof PlatformTriggerPresetInputType
+>;
+
+/** @internal */
+export const PlatformTriggerPresetInputType$inboundSchema: z.ZodType<
+  PlatformTriggerPresetInputType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformTriggerPresetInputType);

package/src/models/components/platformtriggerpresetinputvalue.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 270a25c9c60e
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PlatformTriggerPresetInputValue = {
+  /**
+   * The exact value to send in the trigger's `inputs` for this choice (e.g. a channel name, a user's email, etc).
+   *
+   * @remarks
+   */
+  value: string;
+  /**
+   * Human-readable name for this value.
+   */
+  display_name: string;
+};
+
+/** @internal */
+export const PlatformTriggerPresetInputValue$inboundSchema: z.ZodType<
+  PlatformTriggerPresetInputValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.string(),
+  display_name: z.string(),
+});
+
+export function platformTriggerPresetInputValueFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerPresetInputValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerPresetInputValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerPresetInputValue' from JSON`,
+  );
+}