bereach 0.1.4 → 1.2.3

package/src/models/operations/list-inbox-conversations.ts

@@ -0,0 +1,735 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { smartUnion } from "../../types/smart-union.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+export type ListInboxConversationsRequest = {
+  /**
+   * Pagination cursor from a previous response
+   */
+  nextCursor?: string | undefined;
+};
+
+export type ListInboxConversationsInternalServerErrorDetails =
+  | string
+  | Array<string>;
+
+export type ListInboxConversationsInternalServerErrorError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export const ListInboxConversationsCode = {
+  RateLimitExceeded: "rate_limit_exceeded",
+} as const;
+export type ListInboxConversationsCode = ClosedEnum<
+  typeof ListInboxConversationsCode
+>;
+
+/**
+ * Current and max daily usage (null if no daily cap).
+ */
+export type ListInboxConversationsDaily = {
+  current: number;
+  limit: number;
+};
+
+/**
+ * Current and max weekly usage (null if no weekly cap).
+ */
+export type ListInboxConversationsWeekly = {
+  current: number;
+  limit: number;
+};
+
+export type ListInboxConversationsTooManyRequestsError = {
+  code: ListInboxConversationsCode;
+  message: string;
+  docs?: string | undefined;
+  /**
+   * Seconds to wait before retrying.
+   */
+  retryAfter: number;
+  /**
+   * Current and max daily usage (null if no daily cap).
+   */
+  daily: ListInboxConversationsDaily | null;
+  /**
+   * Current and max weekly usage (null if no weekly cap).
+   */
+  weekly: ListInboxConversationsWeekly | null;
+};
+
+export type ListInboxConversationsUnprocessableEntityDetails =
+  | string
+  | Array<string>;
+
+export type ListInboxConversationsUnprocessableEntityError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsGoneDetails = string | Array<string>;
+
+export type ListInboxConversationsGoneError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsConflictDetails = string | Array<string>;
+
+export type ListInboxConversationsConflictError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsNotFoundDetails = string | Array<string>;
+
+export type ListInboxConversationsNotFoundError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsForbiddenDetails = string | Array<string>;
+
+export type ListInboxConversationsForbiddenError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsUnauthorizedDetails = string | Array<string>;
+
+export type ListInboxConversationsUnauthorizedError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsBadRequestDetails = string | Array<string>;
+
+export type ListInboxConversationsBadRequestError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type ListInboxConversationsParticipant = {
+  profileUrn: string;
+  firstName: string;
+  lastName: string;
+  profileUrl: string | null;
+  headline: string | null;
+  profilePicture: string | null;
+};
+
+export type ListInboxConversationsLastMessage = {
+  text: string | null;
+  deliveredAt: number;
+  senderProfileUrn: string;
+};
+
+export type ListInboxConversationsConversation = {
+  conversationUrn: string;
+  conversationUrl: string;
+  lastActivityAt: number;
+  createdAt: number;
+  read: boolean;
+  unreadCount: number;
+  groupChat: boolean;
+  participants: Array<ListInboxConversationsParticipant>;
+  lastMessage: ListInboxConversationsLastMessage | null;
+};
+
+/**
+ * Inbox conversations
+ */
+export type ListInboxConversationsResponse = {
+  success: true;
+  conversations: Array<ListInboxConversationsConversation>;
+  /**
+   * Cursor for fetching next page
+   */
+  nextCursor: string | null;
+  /**
+   * Credits consumed by this call (0 for free endpoints, cached results, or duplicates).
+   */
+  creditsUsed: number;
+  /**
+   * Seconds to wait before making another call of the same type. 0 means no wait needed.
+   */
+  retryAfter: number;
+};
+
+/** @internal */
+export type ListInboxConversationsRequest$Outbound = {
+  nextCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListInboxConversationsRequest$outboundSchema: z.ZodMiniType<
+  ListInboxConversationsRequest$Outbound,
+  ListInboxConversationsRequest
+> = z.object({
+  nextCursor: z.optional(z.string()),
+});
+
+export function listInboxConversationsRequestToJSON(
+  listInboxConversationsRequest: ListInboxConversationsRequest,
+): string {
+  return JSON.stringify(
+    ListInboxConversationsRequest$outboundSchema.parse(
+      listInboxConversationsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsInternalServerErrorDetails$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsInternalServerErrorDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function listInboxConversationsInternalServerErrorDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsInternalServerErrorDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsInternalServerErrorDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsInternalServerErrorDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsInternalServerErrorError$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsInternalServerErrorError, unknown> = z
+    .object({
+      code: types.string(),
+      message: types.string(),
+      docs: types.optional(types.string()),
+      details: types.optional(
+        smartUnion([types.string(), z.array(types.string())]),
+      ),
+    });
+
+export function listInboxConversationsInternalServerErrorErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsInternalServerErrorError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsInternalServerErrorError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsInternalServerErrorError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsCode$inboundSchema: z.ZodMiniEnum<
+  typeof ListInboxConversationsCode
+> = z.enum(ListInboxConversationsCode);
+
+/** @internal */
+export const ListInboxConversationsDaily$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsDaily,
+  unknown
+> = z.object({
+  current: types.number(),
+  limit: types.number(),
+});
+
+export function listInboxConversationsDailyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsDaily, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsDaily$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsDaily' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsWeekly$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsWeekly,
+  unknown
+> = z.object({
+  current: types.number(),
+  limit: types.number(),
+});
+
+export function listInboxConversationsWeeklyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsWeekly, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsWeekly$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsWeekly' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsTooManyRequestsError$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsTooManyRequestsError, unknown> = z.object(
+    {
+      code: ListInboxConversationsCode$inboundSchema,
+      message: types.string(),
+      docs: types.optional(types.string()),
+      retryAfter: types.number(),
+      daily: types.nullable(z.lazy(() =>
+        ListInboxConversationsDaily$inboundSchema
+      )),
+      weekly: types.nullable(z.lazy(() =>
+        ListInboxConversationsWeekly$inboundSchema
+      )),
+    },
+  );
+
+export function listInboxConversationsTooManyRequestsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsTooManyRequestsError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsTooManyRequestsError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsTooManyRequestsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsUnprocessableEntityDetails$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsUnprocessableEntityDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function listInboxConversationsUnprocessableEntityDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsUnprocessableEntityDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsUnprocessableEntityDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsUnprocessableEntityDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsUnprocessableEntityError$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsUnprocessableEntityError, unknown> = z
+    .object({
+      code: types.string(),
+      message: types.string(),
+      docs: types.optional(types.string()),
+      details: types.optional(
+        smartUnion([types.string(), z.array(types.string())]),
+      ),
+    });
+
+export function listInboxConversationsUnprocessableEntityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsUnprocessableEntityError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsUnprocessableEntityError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsUnprocessableEntityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsGoneDetails$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsGoneDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function listInboxConversationsGoneDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsGoneDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsGoneDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsGoneDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsGoneError$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsGoneError,
+  unknown
+> = z.object({
+  code: types.string(),
+  message: types.string(),
+  docs: types.optional(types.string()),
+  details: types.optional(
+    smartUnion([types.string(), z.array(types.string())]),
+  ),
+});
+
+export function listInboxConversationsGoneErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsGoneError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsGoneError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsGoneError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsConflictDetails$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsConflictDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function listInboxConversationsConflictDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsConflictDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsConflictDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsConflictDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsConflictError$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsConflictError,
+  unknown
+> = z.object({
+  code: types.string(),
+  message: types.string(),
+  docs: types.optional(types.string()),
+  details: types.optional(
+    smartUnion([types.string(), z.array(types.string())]),
+  ),
+});
+
+export function listInboxConversationsConflictErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsConflictError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsConflictError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsConflictError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsNotFoundDetails$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsNotFoundDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function listInboxConversationsNotFoundDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsNotFoundDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsNotFoundDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsNotFoundDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsNotFoundError$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsNotFoundError,
+  unknown
+> = z.object({
+  code: types.string(),
+  message: types.string(),
+  docs: types.optional(types.string()),
+  details: types.optional(
+    smartUnion([types.string(), z.array(types.string())]),
+  ),
+});
+
+export function listInboxConversationsNotFoundErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsNotFoundError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsNotFoundError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsNotFoundError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsForbiddenDetails$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsForbiddenDetails, unknown> = smartUnion([
+    types.string(),
+    z.array(types.string()),
+  ]);
+
+export function listInboxConversationsForbiddenDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsForbiddenDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsForbiddenDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsForbiddenDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsForbiddenError$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsForbiddenError,
+  unknown
+> = z.object({
+  code: types.string(),
+  message: types.string(),
+  docs: types.optional(types.string()),
+  details: types.optional(
+    smartUnion([types.string(), z.array(types.string())]),
+  ),
+});
+
+export function listInboxConversationsForbiddenErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsForbiddenError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsForbiddenError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsForbiddenError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsUnauthorizedDetails$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsUnauthorizedDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function listInboxConversationsUnauthorizedDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsUnauthorizedDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsUnauthorizedDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsUnauthorizedDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsUnauthorizedError$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsUnauthorizedError, unknown> = z.object({
+    code: types.string(),
+    message: types.string(),
+    docs: types.optional(types.string()),
+    details: types.optional(
+      smartUnion([types.string(), z.array(types.string())]),
+    ),
+  });
+
+export function listInboxConversationsUnauthorizedErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsUnauthorizedError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsUnauthorizedError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsUnauthorizedError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsBadRequestDetails$inboundSchema:
+  z.ZodMiniType<ListInboxConversationsBadRequestDetails, unknown> = smartUnion([
+    types.string(),
+    z.array(types.string()),
+  ]);
+
+export function listInboxConversationsBadRequestDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInboxConversationsBadRequestDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsBadRequestDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInboxConversationsBadRequestDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsBadRequestError$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsBadRequestError,
+  unknown
+> = z.object({
+  code: types.string(),
+  message: types.string(),
+  docs: types.optional(types.string()),
+  details: types.optional(
+    smartUnion([types.string(), z.array(types.string())]),
+  ),
+});
+
+export function listInboxConversationsBadRequestErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsBadRequestError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsBadRequestError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsBadRequestError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsParticipant$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsParticipant,
+  unknown
+> = z.object({
+  profileUrn: types.string(),
+  firstName: types.string(),
+  lastName: types.string(),
+  profileUrl: types.nullable(types.string()),
+  headline: types.nullable(types.string()),
+  profilePicture: types.nullable(types.string()),
+});
+
+export function listInboxConversationsParticipantFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsParticipant, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsParticipant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsParticipant' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsLastMessage$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsLastMessage,
+  unknown
+> = z.object({
+  text: types.nullable(types.string()),
+  deliveredAt: types.number(),
+  senderProfileUrn: types.string(),
+});
+
+export function listInboxConversationsLastMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsLastMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsLastMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsLastMessage' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsConversation$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsConversation,
+  unknown
+> = z.object({
+  conversationUrn: types.string(),
+  conversationUrl: types.string(),
+  lastActivityAt: types.number(),
+  createdAt: types.number(),
+  read: types.boolean(),
+  unreadCount: types.number(),
+  groupChat: types.boolean(),
+  participants: z.array(
+    z.lazy(() => ListInboxConversationsParticipant$inboundSchema),
+  ),
+  lastMessage: types.nullable(
+    z.lazy(() => ListInboxConversationsLastMessage$inboundSchema),
+  ),
+});
+
+export function listInboxConversationsConversationFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsConversation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInboxConversationsConversation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsConversation' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInboxConversationsResponse$inboundSchema: z.ZodMiniType<
+  ListInboxConversationsResponse,
+  unknown
+> = z.object({
+  success: types.literal(true),
+  conversations: z.array(
+    z.lazy(() => ListInboxConversationsConversation$inboundSchema),
+  ),
+  nextCursor: types.nullable(types.string()),
+  creditsUsed: types.number(),
+  retryAfter: types.number(),
+});
+
+export function listInboxConversationsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInboxConversationsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInboxConversationsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInboxConversationsResponse' from JSON`,
+  );
+}