@unified-api/typescript-sdk 2.82.4 → 2.82.5

package/src/funcs/eventUpdateMessagingEvent.ts

@@ -0,0 +1,175 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { UnifiedToCore } from "../core.js";
+import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import { UnifiedToError } from "../sdk/models/errors/unifiedtoerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Update an event
+ */
+export function eventUpdateMessagingEvent(
+  client: UnifiedToCore,
+  request: operations.UpdateMessagingEventRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.MessagingEvent,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnifiedToCore,
+  request: operations.UpdateMessagingEventRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.MessagingEvent,
+      | UnifiedToError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.UpdateMessagingEventRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.MessagingEvent, { explode: true });
+
+  const pathParams = {
+    connection_id: encodeSimple("connection_id", payload.connection_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/messaging/{connection_id}/event/{id}")(pathParams);
+
+  const query = encodeFormQuery({
+    "fields": payload.fields,
+    "raw": payload.raw,
+  });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "updateMessagingEvent",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    shared.MessagingEvent,
+    | UnifiedToError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.MessagingEvent$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -73,8 +73,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.82.4",
-  genVersion: "2.781.2",
+  sdkVersion: "2.82.5",
+  genVersion: "2.788.4",
   userAgent:
-    "speakeasy-sdk/typescript 2.82.4 2.781.2 1.0 @unified-api/typescript-sdk",
+    "speakeasy-sdk/typescript 2.82.5 2.788.4 1.0 @unified-api/typescript-sdk",
 } as const;

package/src/sdk/event.ts

@@ -12,8 +12,10 @@ import { eventCreateCrmEvent } from "../funcs/eventCreateCrmEvent.js";
 import { eventGetCrmEvent } from "../funcs/eventGetCrmEvent.js";
 import { eventListCrmEvents } from "../funcs/eventListCrmEvents.js";
 import { eventPatchCrmEvent } from "../funcs/eventPatchCrmEvent.js";
+import { eventPatchMessagingEvent } from "../funcs/eventPatchMessagingEvent.js";
 import { eventRemoveCrmEvent } from "../funcs/eventRemoveCrmEvent.js";
 import { eventUpdateCrmEvent } from "../funcs/eventUpdateCrmEvent.js";
+import { eventUpdateMessagingEvent } from "../funcs/eventUpdateMessagingEvent.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
@@ -132,6 +134,20 @@ export class Event extends ClientSDK {
     ));
   }
 
+  /**
+   * Update an event
+   */
+  async patchMessagingEvent(
+    request: operations.PatchMessagingEventRequest,
+    options?: RequestOptions,
+  ): Promise<shared.MessagingEvent> {
+    return unwrapAsync(eventPatchMessagingEvent(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Remove an event
    */
@@ -187,4 +203,18 @@ export class Event extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Update an event
+   */
+  async updateMessagingEvent(
+    request: operations.UpdateMessagingEventRequest,
+    options?: RequestOptions,
+  ): Promise<shared.MessagingEvent> {
+    return unwrapAsync(eventUpdateMessagingEvent(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/messaging.ts

@@ -2,6 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { eventPatchMessagingEvent } from "../funcs/eventPatchMessagingEvent.js";
+import { eventUpdateMessagingEvent } from "../funcs/eventUpdateMessagingEvent.js";
 import { messagingCreateMessagingMessage } from "../funcs/messagingCreateMessagingMessage.js";
 import { messagingGetMessagingChannel } from "../funcs/messagingGetMessagingChannel.js";
 import { messagingGetMessagingMessage } from "../funcs/messagingGetMessagingMessage.js";
@@ -86,6 +88,20 @@ export class Messaging extends ClientSDK {
     ));
   }
 
+  /**
+   * Update an event
+   */
+  async patchMessagingEvent(
+    request: operations.PatchMessagingEventRequest,
+    options?: RequestOptions,
+  ): Promise<shared.MessagingEvent> {
+    return unwrapAsync(eventPatchMessagingEvent(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a message
    */
@@ -114,6 +130,20 @@ export class Messaging extends ClientSDK {
     ));
   }
 
+  /**
+   * Update an event
+   */
+  async updateMessagingEvent(
+    request: operations.UpdateMessagingEventRequest,
+    options?: RequestOptions,
+  ): Promise<shared.MessagingEvent> {
+    return unwrapAsync(eventUpdateMessagingEvent(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a message
    */

package/src/sdk/models/operations/index.ts

@@ -340,6 +340,7 @@ export * from "./patchlmsinstructor.js";
 export * from "./patchlmsstudent.js";
 export * from "./patchmartechlist.js";
 export * from "./patchmartechmember.js";
+export * from "./patchmessagingevent.js";
 export * from "./patchmessagingmessage.js";
 export * from "./patchmetadatametadata.js";
 export * from "./patchpassthroughjson.js";
@@ -503,6 +504,7 @@ export * from "./updatelmsinstructor.js";
 export * from "./updatelmsstudent.js";
 export * from "./updatemartechlist.js";
 export * from "./updatemartechmember.js";
+export * from "./updatemessagingevent.js";
 export * from "./updatemessagingmessage.js";
 export * from "./updatemetadatametadata.js";
 export * from "./updatepassthroughjson.js";

package/src/sdk/models/operations/patchmessagingevent.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import * as shared from "../shared/index.js";
+
+export type PatchMessagingEventRequest = {
+  messagingEvent: shared.MessagingEvent;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Event
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export type PatchMessagingEventRequest$Outbound = {
+  MessagingEvent: shared.MessagingEvent$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchMessagingEventRequest$outboundSchema: z.ZodType<
+  PatchMessagingEventRequest$Outbound,
+  z.ZodTypeDef,
+  PatchMessagingEventRequest
+> = z.object({
+  messagingEvent: shared.MessagingEvent$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    messagingEvent: "MessagingEvent",
+    connectionId: "connection_id",
+  });
+});
+
+export function patchMessagingEventRequestToJSON(
+  patchMessagingEventRequest: PatchMessagingEventRequest,
+): string {
+  return JSON.stringify(
+    PatchMessagingEventRequest$outboundSchema.parse(patchMessagingEventRequest),
+  );
+}

package/src/sdk/models/operations/updatemessagingevent.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import * as shared from "../shared/index.js";
+
+export type UpdateMessagingEventRequest = {
+  messagingEvent: shared.MessagingEvent;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Event
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export type UpdateMessagingEventRequest$Outbound = {
+  MessagingEvent: shared.MessagingEvent$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const UpdateMessagingEventRequest$outboundSchema: z.ZodType<
+  UpdateMessagingEventRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateMessagingEventRequest
+> = z.object({
+  messagingEvent: shared.MessagingEvent$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    messagingEvent: "MessagingEvent",
+    connectionId: "connection_id",
+  });
+});
+
+export function updateMessagingEventRequestToJSON(
+  updateMessagingEventRequest: UpdateMessagingEventRequest,
+): string {
+  return JSON.stringify(
+    UpdateMessagingEventRequest$outboundSchema.parse(
+      updateMessagingEventRequest,
+    ),
+  );
+}

package/src/sdk/models/shared/apicall.ts

@@ -21,7 +21,7 @@ export type ApiCallType = OpenEnum<typeof ApiCallType>;
 export type ApiCall = {
   connectionId?: string | undefined;
   createdAt?: Date | undefined;
-  environment?: string | undefined;
+  environment: string;
   error?: string | undefined;
   externalXref?: string | undefined;
   id?: string | undefined;

package/src/sdk/models/shared/index.ts

@@ -144,11 +144,13 @@ export * from "./marketingemail.js";
 export * from "./marketinglist.js";
 export * from "./marketingmember.js";
 export * from "./messagingattachment.js";
+export * from "./messagingbutton.js";
 export * from "./messagingchannel.js";
-export * from "./messagingchannelmessage.js";
+export * from "./messagingevent.js";
 export * from "./messagingmember.js";
 export * from "./messagingmessage.js";
 export * from "./messagingreaction.js";
+export * from "./messagingreference.js";
 export * from "./metadatametadata.js";
 export * from "./paymentlineitem.js";
 export * from "./paymentlink.js";
@@ -204,6 +206,11 @@ export * from "./propertyintegrationsupportwebhookeventscreated.js";
 export * from "./propertyintegrationsupportwebhookeventsdeleted.js";
 export * from "./propertyintegrationsupportwebhookeventsupdated.js";
 export * from "./propertylmsstudentaddress.js";
+export * from "./propertymessagingeventbutton.js";
+export * from "./propertymessagingeventchannel.js";
+export * from "./propertymessagingeventmessage.js";
+export * from "./propertymessagingeventmessageauthormember.js";
+export * from "./propertymessagingeventuser.js";
 export * from "./propertymessagingmessageauthormember.js";
 export * from "./propertymessagingreactionmember.js";
 export * from "./propertyscimgroupmeta.js";

package/src/sdk/models/shared/messagingbutton.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 MessagingButton = {
+  icon?: string | undefined;
+  id: string;
+  text?: string | undefined;
+};
+
+/** @internal */
+export const MessagingButton$inboundSchema: z.ZodType<
+  MessagingButton,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  icon: z.string().optional(),
+  id: z.string(),
+  text: z.string().optional(),
+});
+/** @internal */
+export type MessagingButton$Outbound = {
+  icon?: string | undefined;
+  id: string;
+  text?: string | undefined;
+};
+
+/** @internal */
+export const MessagingButton$outboundSchema: z.ZodType<
+  MessagingButton$Outbound,
+  z.ZodTypeDef,
+  MessagingButton
+> = z.object({
+  icon: z.string().optional(),
+  id: z.string(),
+  text: z.string().optional(),
+});
+
+export function messagingButtonToJSON(
+  messagingButton: MessagingButton,
+): string {
+  return JSON.stringify(MessagingButton$outboundSchema.parse(messagingButton));
+}
+export function messagingButtonFromJSON(
+  jsonString: string,
+): SafeParseResult<MessagingButton, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessagingButton$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessagingButton' from JSON`,
+  );
+}

package/src/sdk/models/shared/messagingevent.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PropertyMessagingEventButton,
+  PropertyMessagingEventButton$inboundSchema,
+  PropertyMessagingEventButton$Outbound,
+  PropertyMessagingEventButton$outboundSchema,
+} from "./propertymessagingeventbutton.js";
+import {
+  PropertyMessagingEventChannel,
+  PropertyMessagingEventChannel$inboundSchema,
+  PropertyMessagingEventChannel$Outbound,
+  PropertyMessagingEventChannel$outboundSchema,
+} from "./propertymessagingeventchannel.js";
+import {
+  PropertyMessagingEventMessage,
+  PropertyMessagingEventMessage$inboundSchema,
+  PropertyMessagingEventMessage$Outbound,
+  PropertyMessagingEventMessage$outboundSchema,
+} from "./propertymessagingeventmessage.js";
+import {
+  PropertyMessagingEventUser,
+  PropertyMessagingEventUser$inboundSchema,
+  PropertyMessagingEventUser$Outbound,
+  PropertyMessagingEventUser$outboundSchema,
+} from "./propertymessagingeventuser.js";
+
+export const MessagingEventType = {
+  MessageReceived: "MESSAGE_RECEIVED",
+  ReactionAdded: "REACTION_ADDED",
+  ReactionRemoved: "REACTION_REMOVED",
+  ButtonClick: "BUTTON_CLICK",
+  AppMention: "APP_MENTION",
+  ChannelJoined: "CHANNEL_JOINED",
+  ChannelLeft: "CHANNEL_LEFT",
+  ChannelCreated: "CHANNEL_CREATED",
+  ChannelDeleted: "CHANNEL_DELETED",
+  UserCreated: "USER_CREATED",
+  UserDeleted: "USER_DELETED",
+  UserUpdated: "USER_UPDATED",
+} as const;
+export type MessagingEventType = OpenEnum<typeof MessagingEventType>;
+
+export type MessagingEvent = {
+  button?: PropertyMessagingEventButton | undefined;
+  channel?: PropertyMessagingEventChannel | undefined;
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  message?: PropertyMessagingEventMessage | undefined;
+  raw?: { [k: string]: any } | undefined;
+  type: MessagingEventType;
+  user?: PropertyMessagingEventUser | undefined;
+};
+
+/** @internal */
+export const MessagingEventType$inboundSchema: z.ZodType<
+  MessagingEventType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(MessagingEventType);
+/** @internal */
+export const MessagingEventType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  MessagingEventType
+> = openEnums.outboundSchema(MessagingEventType);
+
+/** @internal */
+export const MessagingEvent$inboundSchema: z.ZodType<
+  MessagingEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  button: PropertyMessagingEventButton$inboundSchema.optional(),
+  channel: PropertyMessagingEventChannel$inboundSchema.optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  message: PropertyMessagingEventMessage$inboundSchema.optional(),
+  raw: z.record(z.any()).optional(),
+  type: MessagingEventType$inboundSchema,
+  user: PropertyMessagingEventUser$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+  });
+});
+/** @internal */
+export type MessagingEvent$Outbound = {
+  button?: PropertyMessagingEventButton$Outbound | undefined;
+  channel?: PropertyMessagingEventChannel$Outbound | undefined;
+  created_at?: string | undefined;
+  id?: string | undefined;
+  message?: PropertyMessagingEventMessage$Outbound | undefined;
+  raw?: { [k: string]: any } | undefined;
+  type: string;
+  user?: PropertyMessagingEventUser$Outbound | undefined;
+};
+
+/** @internal */
+export const MessagingEvent$outboundSchema: z.ZodType<
+  MessagingEvent$Outbound,
+  z.ZodTypeDef,
+  MessagingEvent
+> = z.object({
+  button: PropertyMessagingEventButton$outboundSchema.optional(),
+  channel: PropertyMessagingEventChannel$outboundSchema.optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  message: PropertyMessagingEventMessage$outboundSchema.optional(),
+  raw: z.record(z.any()).optional(),
+  type: MessagingEventType$outboundSchema,
+  user: PropertyMessagingEventUser$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+  });
+});
+
+export function messagingEventToJSON(messagingEvent: MessagingEvent): string {
+  return JSON.stringify(MessagingEvent$outboundSchema.parse(messagingEvent));
+}
+export function messagingEventFromJSON(
+  jsonString: string,
+): SafeParseResult<MessagingEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessagingEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessagingEvent' from JSON`,
+  );
+}