@gleanwork/api-client 0.18.1 → 0.19.0

package/src/models/components/platformtriggerpresetinputvaluelistresponse.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9aabb071698b
+ */
+
+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 {
+  PlatformTriggerPresetInputValue,
+  PlatformTriggerPresetInputValue$inboundSchema,
+} from "./platformtriggerpresetinputvalue.js";
+
+export type PlatformTriggerPresetInputValueListResponse = {
+  /**
+   * The bounded set of selectable values matching the query.
+   */
+  results: Array<PlatformTriggerPresetInputValue>;
+  /**
+   * Whether additional matches were omitted. When true, refine `query` to narrow the result set.
+   *
+   * @remarks
+   */
+  is_truncated: boolean;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerPresetInputValueListResponse$inboundSchema:
+  z.ZodType<
+    PlatformTriggerPresetInputValueListResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    results: z.array(PlatformTriggerPresetInputValue$inboundSchema),
+    is_truncated: z.boolean(),
+    request_id: z.string(),
+  });
+
+export function platformTriggerPresetInputValueListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlatformTriggerPresetInputValueListResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformTriggerPresetInputValueListResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PlatformTriggerPresetInputValueListResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggerpresetlistresponse.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 23286666d186
+ */
+
+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 {
+  PlatformTriggerPresetSummary,
+  PlatformTriggerPresetSummary$inboundSchema,
+} from "./platformtriggerpresetsummary.js";
+
+export type PlatformTriggerPresetListResponse = {
+  /**
+   * Trigger presets available to the caller.
+   */
+  results: Array<PlatformTriggerPresetSummary>;
+  /**
+   * 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 PlatformTriggerPresetListResponse$inboundSchema: z.ZodType<
+  PlatformTriggerPresetListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.array(PlatformTriggerPresetSummary$inboundSchema),
+  has_more: z.boolean(),
+  next_cursor: z.nullable(z.string()),
+  request_id: z.string(),
+});
+
+export function platformTriggerPresetListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerPresetListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerPresetListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerPresetListResponse' from JSON`,
+  );
+}

package/src/models/components/platformtriggerpresetsummary.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ca7665edf3ac
+ */
+
+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 PlatformTriggerPresetSummary = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export const PlatformTriggerPresetSummary$inboundSchema: z.ZodType<
+  PlatformTriggerPresetSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  preset_id: z.string(),
+  datasource: z.string(),
+  display_name: z.string(),
+  description: z.string().optional(),
+});
+
+export function platformTriggerPresetSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerPresetSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerPresetSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerPresetSummary' from JSON`,
+  );
+}

package/src/models/components/platformtriggerstatus.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a841ee0d06d7
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Current trigger lifecycle state.
+ */
+export const PlatformTriggerStatus = {
+  Enabled: "ENABLED",
+  Disabled: "DISABLED",
+} as const;
+/**
+ * Current trigger lifecycle state.
+ */
+export type PlatformTriggerStatus = OpenEnum<typeof PlatformTriggerStatus>;
+
+/** @internal */
+export const PlatformTriggerStatus$inboundSchema: z.ZodType<
+  PlatformTriggerStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformTriggerStatus);
+/** @internal */
+export const PlatformTriggerStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PlatformTriggerStatus
+> = openEnums.outboundSchema(PlatformTriggerStatus);

package/src/models/components/platformtriggerupdaterequest.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4e3008c8e562
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformTriggerDelivery,
+  PlatformTriggerDelivery$Outbound,
+  PlatformTriggerDelivery$outboundSchema,
+} from "./platformtriggerdelivery.js";
+import {
+  PlatformTriggerStatus,
+  PlatformTriggerStatus$outboundSchema,
+} from "./platformtriggerstatus.js";
+
+/**
+ * Partial update. Only the supplied fields are changed.
+ */
+export type PlatformTriggerUpdateRequest = {
+  /**
+   * Current trigger lifecycle state.
+   */
+  status?: PlatformTriggerStatus | undefined;
+  /**
+   * Optional note describing this trigger.
+   */
+  description?: string | undefined;
+  /**
+   * Values for the preset's inputs.
+   */
+  inputs?: { [k: string]: any } | undefined;
+  delivery?: PlatformTriggerDelivery | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerUpdateRequest$Outbound = {
+  status?: string | undefined;
+  description?: string | undefined;
+  inputs?: { [k: string]: any } | undefined;
+  delivery?: PlatformTriggerDelivery$Outbound | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerUpdateRequest$outboundSchema: z.ZodType<
+  PlatformTriggerUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerUpdateRequest
+> = z.object({
+  status: PlatformTriggerStatus$outboundSchema.optional(),
+  description: z.string().optional(),
+  inputs: z.record(z.any()).optional(),
+  delivery: PlatformTriggerDelivery$outboundSchema.optional(),
+});
+
+export function platformTriggerUpdateRequestToJSON(
+  platformTriggerUpdateRequest: PlatformTriggerUpdateRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerUpdateRequest$outboundSchema.parse(
+      platformTriggerUpdateRequest,
+    ),
+  );
+}

package/src/models/components/platformtriggerwebhookevent.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2824d82a6b5e
+ */
+
+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 {
+  PlatformContentScheduleWebhookEvent,
+  PlatformContentScheduleWebhookEvent$inboundSchema,
+  PlatformContentScheduleWebhookEvent$Outbound,
+  PlatformContentScheduleWebhookEvent$outboundSchema,
+} from "./platformcontentschedulewebhookevent.js";
+import {
+  PlatformDocumentChangeWebhookEvent,
+  PlatformDocumentChangeWebhookEvent$inboundSchema,
+  PlatformDocumentChangeWebhookEvent$Outbound,
+  PlatformDocumentChangeWebhookEvent$outboundSchema,
+} from "./platformdocumentchangewebhookevent.js";
+
+/**
+ * Every delivered webhook is one of these two variants. A trigger with a cron schedule carries no document and so cannot be delivered over a webhook.
+ */
+export type PlatformTriggerWebhookEvent =
+  | (PlatformDocumentChangeWebhookEvent & { eventType: "DOCUMENT_CHANGE" })
+  | (PlatformContentScheduleWebhookEvent & { eventType: "CONTENT_SCHEDULE" });
+
+/** @internal */
+export const PlatformTriggerWebhookEvent$inboundSchema: z.ZodType<
+  PlatformTriggerWebhookEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  PlatformDocumentChangeWebhookEvent$inboundSchema.and(
+    z.object({ event_type: z.literal("DOCUMENT_CHANGE") }).transform((v) => ({
+      eventType: v.event_type,
+    })),
+  ),
+  PlatformContentScheduleWebhookEvent$inboundSchema.and(
+    z.object({ event_type: z.literal("CONTENT_SCHEDULE") }).transform((v) => ({
+      eventType: v.event_type,
+    })),
+  ),
+]);
+/** @internal */
+export type PlatformTriggerWebhookEvent$Outbound =
+  | (PlatformDocumentChangeWebhookEvent$Outbound & {
+    event_type: "DOCUMENT_CHANGE";
+  })
+  | (PlatformContentScheduleWebhookEvent$Outbound & {
+    event_type: "CONTENT_SCHEDULE";
+  });
+
+/** @internal */
+export const PlatformTriggerWebhookEvent$outboundSchema: z.ZodType<
+  PlatformTriggerWebhookEvent$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerWebhookEvent
+> = z.union([
+  PlatformDocumentChangeWebhookEvent$outboundSchema.and(
+    z.object({ eventType: z.literal("DOCUMENT_CHANGE") }).transform((v) => ({
+      event_type: v.eventType,
+    })),
+  ),
+  PlatformContentScheduleWebhookEvent$outboundSchema.and(
+    z.object({ eventType: z.literal("CONTENT_SCHEDULE") }).transform((v) => ({
+      event_type: v.eventType,
+    })),
+  ),
+]);
+
+export function platformTriggerWebhookEventToJSON(
+  platformTriggerWebhookEvent: PlatformTriggerWebhookEvent,
+): string {
+  return JSON.stringify(
+    PlatformTriggerWebhookEvent$outboundSchema.parse(
+      platformTriggerWebhookEvent,
+    ),
+  );
+}
+export function platformTriggerWebhookEventFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerWebhookEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerWebhookEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerWebhookEvent' from JSON`,
+  );
+}

package/src/models/components/platformtriggerwithsecret.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 740e30c53656
+ */
+
+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 PlatformTriggerWithSecret = {
+  /**
+   * 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;
+  /**
+   * Secret for verifying webhook signatures, serialized as `whsec_<base64-encoded key>` following Standard Webhooks. Returned only when the trigger is created and cannot be retrieved later. Store it securely.
+   */
+  signing_secret: string;
+};
+
+/** @internal */
+export const PlatformTriggerWithSecret$inboundSchema: z.ZodType<
+  PlatformTriggerWithSecret,
+  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)),
+  signing_secret: z.string(),
+});
+
+export function platformTriggerWithSecretFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformTriggerWithSecret, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformTriggerWithSecret$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformTriggerWithSecret' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -90,6 +90,15 @@ export * from "./platformskillslistversions.js";
 export * from "./platformskillspreviewsource.js";
 export * from "./platformskillssync.js";
 export * from "./platformskillsupdate.js";
+export * from "./platformtriggerpresetseventssearch.js";
+export * from "./platformtriggerpresetsget.js";
+export * from "./platformtriggerpresetsinputvalueslist.js";
+export * from "./platformtriggerpresetslist.js";
+export * from "./platformtriggersdelete.js";
+export * from "./platformtriggerseventssearch.js";
+export * from "./platformtriggersget.js";
+export * from "./platformtriggerslist.js";
+export * from "./platformtriggersupdate.js";
 export * from "./postapiindexv1debugdatasourcedocument.js";
 export * from "./postapiindexv1debugdatasourcedocumentevents.js";
 export * from "./postapiindexv1debugdatasourcedocuments.js";

package/src/models/operations/platformtriggerpresetseventssearch.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 815ee5e068db
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type PlatformTriggerPresetsEventsSearchRequest = {
+  /**
+   * ID of the preset to preview.
+   */
+  preset_id: string;
+  platformTriggerPresetEventSearchRequest?:
+    | components.PlatformTriggerPresetEventSearchRequest
+    | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerPresetsEventsSearchRequest$Outbound = {
+  preset_id: string;
+  PlatformTriggerPresetEventSearchRequest?:
+    | components.PlatformTriggerPresetEventSearchRequest$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerPresetsEventsSearchRequest$outboundSchema:
+  z.ZodType<
+    PlatformTriggerPresetsEventsSearchRequest$Outbound,
+    z.ZodTypeDef,
+    PlatformTriggerPresetsEventsSearchRequest
+  > = z.object({
+    preset_id: z.string(),
+    platformTriggerPresetEventSearchRequest: components
+      .PlatformTriggerPresetEventSearchRequest$outboundSchema.optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      platformTriggerPresetEventSearchRequest:
+        "PlatformTriggerPresetEventSearchRequest",
+    });
+  });
+
+export function platformTriggerPresetsEventsSearchRequestToJSON(
+  platformTriggerPresetsEventsSearchRequest:
+    PlatformTriggerPresetsEventsSearchRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerPresetsEventsSearchRequest$outboundSchema.parse(
+      platformTriggerPresetsEventsSearchRequest,
+    ),
+  );
+}

package/src/models/operations/platformtriggerpresetsget.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fa69fa99c2eb
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformTriggerPresetsGetRequest = {
+  /**
+   * ID of the preset to retrieve.
+   */
+  preset_id: string;
+};
+
+/** @internal */
+export type PlatformTriggerPresetsGetRequest$Outbound = {
+  preset_id: string;
+};
+
+/** @internal */
+export const PlatformTriggerPresetsGetRequest$outboundSchema: z.ZodType<
+  PlatformTriggerPresetsGetRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerPresetsGetRequest
+> = z.object({
+  preset_id: z.string(),
+});
+
+export function platformTriggerPresetsGetRequestToJSON(
+  platformTriggerPresetsGetRequest: PlatformTriggerPresetsGetRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerPresetsGetRequest$outboundSchema.parse(
+      platformTriggerPresetsGetRequest,
+    ),
+  );
+}

package/src/models/operations/platformtriggerpresetsinputvalueslist.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 37596aaba8e9
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformTriggerPresetsInputValuesListRequest = {
+  /**
+   * ID of the preset the input belongs to.
+   */
+  preset_id: string;
+  /**
+   * Field identifier of the input whose values to list.
+   */
+  field: string;
+  /**
+   * Prefix filter over the input's option values, for typeahead. Matching is on the option value, not its display name.
+   *
+   * @remarks
+   */
+  query?: string | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerPresetsInputValuesListRequest$Outbound = {
+  preset_id: string;
+  field: string;
+  query?: string | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerPresetsInputValuesListRequest$outboundSchema:
+  z.ZodType<
+    PlatformTriggerPresetsInputValuesListRequest$Outbound,
+    z.ZodTypeDef,
+    PlatformTriggerPresetsInputValuesListRequest
+  > = z.object({
+    preset_id: z.string(),
+    field: z.string(),
+    query: z.string().optional(),
+  });
+
+export function platformTriggerPresetsInputValuesListRequestToJSON(
+  platformTriggerPresetsInputValuesListRequest:
+    PlatformTriggerPresetsInputValuesListRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerPresetsInputValuesListRequest$outboundSchema.parse(
+      platformTriggerPresetsInputValuesListRequest,
+    ),
+  );
+}

package/src/models/operations/platformtriggerpresetslist.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9c9a79861d1a
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformTriggerPresetsListRequest = {
+  /**
+   * Restrict results to presets for a single datasource (e.g. github).
+   */
+  datasource?: string | undefined;
+  /**
+   * Maximum number of presets to return.
+   */
+  page_size?: number | undefined;
+  /**
+   * Opaque pagination cursor from a previous response.
+   */
+  cursor?: string | undefined;
+};
+
+/** @internal */
+export type PlatformTriggerPresetsListRequest$Outbound = {
+  datasource?: string | undefined;
+  page_size: number;
+  cursor?: string | undefined;
+};
+
+/** @internal */
+export const PlatformTriggerPresetsListRequest$outboundSchema: z.ZodType<
+  PlatformTriggerPresetsListRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggerPresetsListRequest
+> = z.object({
+  datasource: z.string().optional(),
+  page_size: z.number().int().default(50),
+  cursor: z.string().optional(),
+});
+
+export function platformTriggerPresetsListRequestToJSON(
+  platformTriggerPresetsListRequest: PlatformTriggerPresetsListRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggerPresetsListRequest$outboundSchema.parse(
+      platformTriggerPresetsListRequest,
+    ),
+  );
+}

package/src/models/operations/platformtriggersdelete.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5689f4ee466e
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformTriggersDeleteRequest = {
+  /**
+   * ID of the trigger to delete.
+   */
+  trigger_id: string;
+};
+
+/** @internal */
+export type PlatformTriggersDeleteRequest$Outbound = {
+  trigger_id: string;
+};
+
+/** @internal */
+export const PlatformTriggersDeleteRequest$outboundSchema: z.ZodType<
+  PlatformTriggersDeleteRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformTriggersDeleteRequest
+> = z.object({
+  trigger_id: z.string(),
+});
+
+export function platformTriggersDeleteRequestToJSON(
+  platformTriggersDeleteRequest: PlatformTriggersDeleteRequest,
+): string {
+  return JSON.stringify(
+    PlatformTriggersDeleteRequest$outboundSchema.parse(
+      platformTriggersDeleteRequest,
+    ),
+  );
+}