@gleanwork/api-client 0.18.1 → 0.19.0

package/src/models/components/platformchatpersonsource.ts

@@ -5,36 +5,23 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const PlatformChatPersonSourceType = {
-  Person: "person",
-} as const;
-export type PlatformChatPersonSourceType = ClosedEnum<
-  typeof PlatformChatPersonSourceType
->;
-
 export type PlatformChatPersonSource = {
-  type: PlatformChatPersonSourceType;
+  type: "PERSON";
   person_id: string;
   name?: string | undefined;
   url?: string | undefined;
 };
 
-/** @internal */
-export const PlatformChatPersonSourceType$inboundSchema: z.ZodNativeEnum<
-  typeof PlatformChatPersonSourceType
-> = z.nativeEnum(PlatformChatPersonSourceType);
-
 /** @internal */
 export const PlatformChatPersonSource$inboundSchema: z.ZodType<
   PlatformChatPersonSource,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: PlatformChatPersonSourceType$inboundSchema,
+  type: z.literal("PERSON"),
   person_id: z.string(),
   name: z.string().optional(),
   url: z.string().optional(),

package/src/models/components/platformcontentschedulewebhookevent.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 09ece847f0e0
+ */
+
+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 PlatformContentScheduleWebhookEvent = {
+  /**
+   * Webhook payload schema version.
+   */
+  version: string;
+  /**
+   * ID of the Platform trigger that produced the event.
+   */
+  trigger_id: string;
+  event_type: string;
+  /**
+   * Datasource the event originated from.
+   */
+  datasource: string;
+  /**
+   * Why the event fired.
+   */
+  reason: string;
+  /**
+   * 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;
+  /**
+   * Relevant event time. Document changes use the source-observed time when available and otherwise the document ingestion time; content schedules use the scheduled time. Omitted when no timestamp is available.
+   */
+  event_time?: Date | undefined;
+  /**
+   * Offset in seconds from the scheduled time at which the trigger fired.
+   */
+  time_offset_seconds: number;
+};
+
+/** @internal */
+export const PlatformContentScheduleWebhookEvent$inboundSchema: z.ZodType<
+  PlatformContentScheduleWebhookEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  version: z.string(),
+  trigger_id: z.string(),
+  event_type: z.string(),
+  datasource: z.string(),
+  reason: z.string(),
+  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))
+    .optional(),
+  time_offset_seconds: z.number().int(),
+});
+/** @internal */
+export type PlatformContentScheduleWebhookEvent$Outbound = {
+  version: string;
+  trigger_id: string;
+  event_type: string;
+  datasource: string;
+  reason: string;
+  doc_type: string;
+  doc_id: string;
+  view_url: string;
+  title: string;
+  event_time?: string | undefined;
+  time_offset_seconds: number;
+};
+
+/** @internal */
+export const PlatformContentScheduleWebhookEvent$outboundSchema: z.ZodType<
+  PlatformContentScheduleWebhookEvent$Outbound,
+  z.ZodTypeDef,
+  PlatformContentScheduleWebhookEvent
+> = z.object({
+  version: z.string(),
+  trigger_id: z.string(),
+  event_type: z.string(),
+  datasource: z.string(),
+  reason: z.string(),
+  doc_type: z.string(),
+  doc_id: z.string(),
+  view_url: z.string(),
+  title: z.string(),
+  event_time: z.date().transform(v => v.toISOString()).optional(),
+  time_offset_seconds: z.number().int(),
+});
+
+export function platformContentScheduleWebhookEventToJSON(
+  platformContentScheduleWebhookEvent: PlatformContentScheduleWebhookEvent,
+): string {
+  return JSON.stringify(
+    PlatformContentScheduleWebhookEvent$outboundSchema.parse(
+      platformContentScheduleWebhookEvent,
+    ),
+  );
+}
+export function platformContentScheduleWebhookEventFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformContentScheduleWebhookEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformContentScheduleWebhookEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformContentScheduleWebhookEvent' from JSON`,
+  );
+}

package/src/models/components/platformdocumentchangewebhookevent.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0aee86e6607b
+ */
+
+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 PlatformDocumentChangeWebhookEvent = {
+  /**
+   * Webhook payload schema version.
+   */
+  version: string;
+  /**
+   * ID of the Platform trigger that produced the event.
+   */
+  trigger_id: string;
+  event_type: string;
+  /**
+   * Datasource the event originated from.
+   */
+  datasource: string;
+  /**
+   * Why the event fired.
+   */
+  reason: string;
+  /**
+   * 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;
+  /**
+   * Relevant event time. Document changes use the source-observed time when available and otherwise the document ingestion time; content schedules use the scheduled time. Omitted when no timestamp is available.
+   */
+  event_time?: Date | undefined;
+  /**
+   * Email body content when the event is for an email document.
+   */
+  content?: string | undefined;
+  /**
+   * Present and true when source content exceeded the delivery size limit.
+   */
+  content_truncated?: boolean | undefined;
+};
+
+/** @internal */
+export const PlatformDocumentChangeWebhookEvent$inboundSchema: z.ZodType<
+  PlatformDocumentChangeWebhookEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  version: z.string(),
+  trigger_id: z.string(),
+  event_type: z.string(),
+  datasource: z.string(),
+  reason: z.string(),
+  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))
+    .optional(),
+  content: z.string().optional(),
+  content_truncated: z.boolean().optional(),
+});
+/** @internal */
+export type PlatformDocumentChangeWebhookEvent$Outbound = {
+  version: string;
+  trigger_id: string;
+  event_type: string;
+  datasource: string;
+  reason: string;
+  doc_type: string;
+  doc_id: string;
+  view_url: string;
+  title: string;
+  event_time?: string | undefined;
+  content?: string | undefined;
+  content_truncated?: boolean | undefined;
+};
+
+/** @internal */
+export const PlatformDocumentChangeWebhookEvent$outboundSchema: z.ZodType<
+  PlatformDocumentChangeWebhookEvent$Outbound,
+  z.ZodTypeDef,
+  PlatformDocumentChangeWebhookEvent
+> = z.object({
+  version: z.string(),
+  trigger_id: z.string(),
+  event_type: z.string(),
+  datasource: z.string(),
+  reason: z.string(),
+  doc_type: z.string(),
+  doc_id: z.string(),
+  view_url: z.string(),
+  title: z.string(),
+  event_time: z.date().transform(v => v.toISOString()).optional(),
+  content: z.string().optional(),
+  content_truncated: z.boolean().optional(),
+});
+
+export function platformDocumentChangeWebhookEventToJSON(
+  platformDocumentChangeWebhookEvent: PlatformDocumentChangeWebhookEvent,
+): string {
+  return JSON.stringify(
+    PlatformDocumentChangeWebhookEvent$outboundSchema.parse(
+      platformDocumentChangeWebhookEvent,
+    ),
+  );
+}
+export function platformDocumentChangeWebhookEventFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformDocumentChangeWebhookEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformDocumentChangeWebhookEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformDocumentChangeWebhookEvent' from JSON`,
+  );
+}

package/src/models/components/platformtrigger.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dd8355f80c8b
+ */
+
+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 {
+  PlatformTriggerDeliveryOutput,
+  PlatformTriggerDeliveryOutput$inboundSchema,
+} from "./platformtriggerdeliveryoutput.js";
+import {
+  PlatformTriggerStatus,
+  PlatformTriggerStatus$inboundSchema,
+} from "./platformtriggerstatus.js";
+
+export type PlatformTrigger = {
+  /**
+   * ID of the trigger.
+   */
+  trigger_id: string;
+  /**
+   * ID of the preset this trigger was created from.
+   */
+  preset_id: string;
+  /**
+   * Optional caller-supplied note describing this trigger.
+   */
+  description?: string | undefined;
+  /**
+   * Current trigger lifecycle state.
+   */
+  status: PlatformTriggerStatus;
+  /**
+   * Values supplied for the preset's inputs.
+   */
+  inputs?: { [k: string]: any } | undefined;
+  delivery: PlatformTriggerDeliveryOutput;
+  /**
+   * Time the trigger was created.
+   */
+  created_at: Date;
+  /**
+   * Time the trigger was last updated.
+   */
+  updated_at: Date;
+};
+
+/** @internal */
+export const PlatformTrigger$inboundSchema: z.ZodType<
+  PlatformTrigger,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trigger_id: z.string(),
+  preset_id: z.string(),
+  description: z.string().optional(),
+  status: PlatformTriggerStatus$inboundSchema,
+  inputs: z.record(z.any()).optional(),
+  delivery: PlatformTriggerDeliveryOutput$inboundSchema,
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function platformTriggerFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTrigger, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTrigger$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTrigger' from JSON`,
+  );
+}

package/src/models/components/platformtriggerauthoutput.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: df4f84046d5c
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Credential scheme.
+ */
+export const PlatformTriggerAuthType = {
+  Bearer: "BEARER",
+} as const;
+/**
+ * Credential scheme.
+ */
+export type PlatformTriggerAuthType = ClosedEnum<
+  typeof PlatformTriggerAuthType
+>;
+
+/**
+ * Optional caller credential sent as an HTTP auth header on each delivery, in addition to the HMAC signature. Lets the receiving endpoint authenticate the request. On update, omit `auth` to preserve the existing credential; there is no in-place removal — recreate the trigger to remove auth.
+ */
+export type PlatformTriggerAuthOutput = {
+  /**
+   * Credential scheme.
+   */
+  type: PlatformTriggerAuthType;
+};
+
+/**
+ * Optional caller credential sent as an HTTP auth header on each delivery, in addition to the HMAC signature. Lets the receiving endpoint authenticate the request. On update, omit `auth` to preserve the existing credential; there is no in-place removal — recreate the trigger to remove auth.
+ */
+export type PlatformTriggerAuth = {
+  /**
+   * Credential scheme.
+   */
+  type: PlatformTriggerAuthType;
+  /**
+   * Secret credential value. Write-only; never returned on reads.
+   */
+  secret: string;
+};
+
+/** @internal */
+export const PlatformTriggerAuthType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformTriggerAuthType
+> = z.nativeEnum(PlatformTriggerAuthType);
+/** @internal */
+export const PlatformTriggerAuthType$outboundSchema: z.ZodNativeEnum<
+  typeof PlatformTriggerAuthType
+> = PlatformTriggerAuthType$inboundSchema;
+
+/** @internal */
+export const PlatformTriggerAuthOutput$inboundSchema: z.ZodType<
+  PlatformTriggerAuthOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformTriggerAuthType$inboundSchema,
+});
+
+export function platformTriggerAuthOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerAuthOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerAuthOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerAuthOutput' from JSON`,
+  );
+}
+
+/** @internal */
+export type PlatformTriggerAuth$Outbound = {
+  type: string;
+  secret: string;
+};
+
+/** @internal */
+export const PlatformTriggerAuth$outboundSchema: z.ZodType<
+  PlatformTriggerAuth$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerAuth
+> = z.object({
+  type: PlatformTriggerAuthType$outboundSchema,
+  secret: z.string(),
+});
+
+export function platformTriggerAuthToJSON(
+  platformTriggerAuth: PlatformTriggerAuth,
+): string {
+  return JSON.stringify(
+    PlatformTriggerAuth$outboundSchema.parse(platformTriggerAuth),
+  );
+}

package/src/models/components/platformtriggercreaterequest.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5ee73a28eef8
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformTriggerDelivery,
+  PlatformTriggerDelivery$Outbound,
+  PlatformTriggerDelivery$outboundSchema,
+} from "./platformtriggerdelivery.js";
+
+export type PlatformTriggerCreateRequest = {
+  /**
+   * ID of the preset to instantiate.
+   */
+  preset_id: string;
+  /**
+   * Optional note describing this trigger.
+   */
+  description?: string | undefined;
+  /**
+   * Values for the preset's inputs.
+   */
+  inputs?: { [k: string]: any } | undefined;
+  delivery: PlatformTriggerDelivery;
+};
+
+/** @internal */
+export type PlatformTriggerCreateRequest$Outbound = {
+  preset_id: string;
+  description?: string | undefined;
+  inputs?: { [k: string]: any } | undefined;
+  delivery: PlatformTriggerDelivery$Outbound;
+};
+
+/** @internal */
+export const PlatformTriggerCreateRequest$outboundSchema: z.ZodType<
+  PlatformTriggerCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerCreateRequest
+> = z.object({
+  preset_id: z.string(),
+  description: z.string().optional(),
+  inputs: z.record(z.any()).optional(),
+  delivery: PlatformTriggerDelivery$outboundSchema,
+});
+
+export function platformTriggerCreateRequestToJSON(
+  platformTriggerCreateRequest: PlatformTriggerCreateRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerCreateRequest$outboundSchema.parse(
+      platformTriggerCreateRequest,
+    ),
+  );
+}

package/src/models/components/platformtriggercreateresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 364d4d3240e3
+ */
+
+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 {
+  PlatformTriggerWithSecret,
+  PlatformTriggerWithSecret$inboundSchema,
+} from "./platformtriggerwithsecret.js";
+
+export type PlatformTriggerCreateResponse = {
+  trigger: PlatformTriggerWithSecret;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerCreateResponse$inboundSchema: z.ZodType<
+  PlatformTriggerCreateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trigger: PlatformTriggerWithSecret$inboundSchema,
+  request_id: z.string(),
+});
+
+export function platformTriggerCreateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerCreateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerCreateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerCreateResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggerdelivery.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5ff59c50e574
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformTriggerAuth,
+  PlatformTriggerAuth$Outbound,
+  PlatformTriggerAuth$outboundSchema,
+} from "./platformtriggerauthoutput.js";
+
+export type PlatformTriggerDelivery = {
+  /**
+   * HTTPS URL that signed events are delivered to.
+   */
+  webhook_url: string;
+  /**
+   * Optional caller credential sent as an HTTP auth header on each delivery, in addition to the HMAC signature. Lets the receiving endpoint authenticate the request. On update, omit `auth` to preserve the existing credential; there is no in-place removal — recreate the trigger to remove auth.
+   */
+  auth?: PlatformTriggerAuth | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerDelivery$Outbound = {
+  webhook_url: string;
+  auth?: PlatformTriggerAuth$Outbound | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerDelivery$outboundSchema: z.ZodType<
+  PlatformTriggerDelivery$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerDelivery
+> = z.object({
+  webhook_url: z.string(),
+  auth: PlatformTriggerAuth$outboundSchema.optional(),
+});
+
+export function platformTriggerDeliveryToJSON(
+  platformTriggerDelivery: PlatformTriggerDelivery,
+): string {
+  return JSON.stringify(
+    PlatformTriggerDelivery$outboundSchema.parse(platformTriggerDelivery),
+  );
+}

package/src/models/components/platformtriggerdeliveryoutput.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 039d513704e1
+ */
+
+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 {
+  PlatformTriggerAuthOutput,
+  PlatformTriggerAuthOutput$inboundSchema,
+} from "./platformtriggerauthoutput.js";
+
+export type PlatformTriggerDeliveryOutput = {
+  /**
+   * HTTPS URL that signed events are delivered to.
+   */
+  webhook_url: string;
+  /**
+   * Optional caller credential sent as an HTTP auth header on each delivery, in addition to the HMAC signature. Lets the receiving endpoint authenticate the request. On update, omit `auth` to preserve the existing credential; there is no in-place removal — recreate the trigger to remove auth.
+   */
+  auth?: PlatformTriggerAuthOutput | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerDeliveryOutput$inboundSchema: z.ZodType<
+  PlatformTriggerDeliveryOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  webhook_url: z.string(),
+  auth: PlatformTriggerAuthOutput$inboundSchema.optional(),
+});
+
+export function platformTriggerDeliveryOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerDeliveryOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerDeliveryOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerDeliveryOutput' from JSON`,
+  );
+}