bereach 0.1.4 → 1.2.3

package/src/models/operations/send-linked-in-message.ts

@@ -0,0 +1,636 @@
+/*
+ * 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 SendLinkedInMessageRequest = {
+  /**
+   * LinkedIn profile URL (e.g., 'https://www.linkedin.com/in/username') or profile URN (e.g., 'urn:li:member:123456')
+   */
+  profile?: string | undefined;
+  /**
+   * LinkedIn conversation URN. When provided, bypasses profile URL lookup and replies to an existing conversation.
+   */
+  conversationUrn?: string | undefined;
+  /**
+   * Message content to send
+   */
+  message: string;
+  /**
+   * Campaign identifier for deduplication. Dedup by profile automatically.
+   */
+  campaignSlug?: string | undefined;
+  /**
+   * Deprecated. Use campaignSlug only.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  actionSlug?: string | undefined;
+};
+
+export type SendLinkedInMessageInternalServerErrorDetails =
+  | string
+  | Array<string>;
+
+export type SendLinkedInMessageInternalServerErrorError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export const SendLinkedInMessageCode = {
+  RateLimitExceeded: "rate_limit_exceeded",
+} as const;
+export type SendLinkedInMessageCode = ClosedEnum<
+  typeof SendLinkedInMessageCode
+>;
+
+/**
+ * Current and max daily usage (null if no daily cap).
+ */
+export type SendLinkedInMessageDaily = {
+  current: number;
+  limit: number;
+};
+
+/**
+ * Current and max weekly usage (null if no weekly cap).
+ */
+export type SendLinkedInMessageWeekly = {
+  current: number;
+  limit: number;
+};
+
+export type SendLinkedInMessageTooManyRequestsError = {
+  code: SendLinkedInMessageCode;
+  message: string;
+  docs?: string | undefined;
+  /**
+   * Seconds to wait before retrying.
+   */
+  retryAfter: number;
+  /**
+   * Current and max daily usage (null if no daily cap).
+   */
+  daily: SendLinkedInMessageDaily | null;
+  /**
+   * Current and max weekly usage (null if no weekly cap).
+   */
+  weekly: SendLinkedInMessageWeekly | null;
+};
+
+export type SendLinkedInMessageUnprocessableEntityDetails =
+  | string
+  | Array<string>;
+
+export type SendLinkedInMessageUnprocessableEntityError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type SendLinkedInMessageGoneDetails = string | Array<string>;
+
+export type SendLinkedInMessageGoneError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type SendLinkedInMessageConflictDetails = string | Array<string>;
+
+export type SendLinkedInMessageConflictError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type SendLinkedInMessageNotFoundDetails = string | Array<string>;
+
+export type SendLinkedInMessageNotFoundError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type SendLinkedInMessageForbiddenDetails = string | Array<string>;
+
+export type SendLinkedInMessageForbiddenError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type SendLinkedInMessageUnauthorizedDetails = string | Array<string>;
+
+export type SendLinkedInMessageUnauthorizedError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type SendLinkedInMessageBadRequestDetails = string | Array<string>;
+
+export type SendLinkedInMessageBadRequestError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+/**
+ * Message sent successfully
+ */
+export type SendLinkedInMessageResponse = {
+  success: true;
+  messageId: string;
+  /**
+   * True if this action was already executed for the given campaignSlug + target.
+   */
+  duplicate?: boolean | undefined;
+  /**
+   * 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 SendLinkedInMessageRequest$Outbound = {
+  profile?: string | undefined;
+  conversationUrn?: string | undefined;
+  message: string;
+  campaignSlug?: string | undefined;
+  actionSlug?: string | undefined;
+};
+
+/** @internal */
+export const SendLinkedInMessageRequest$outboundSchema: z.ZodMiniType<
+  SendLinkedInMessageRequest$Outbound,
+  SendLinkedInMessageRequest
+> = z.object({
+  profile: z.optional(z.string()),
+  conversationUrn: z.optional(z.string()),
+  message: z.string(),
+  campaignSlug: z.optional(z.string()),
+  actionSlug: z.optional(z.string()),
+});
+
+export function sendLinkedInMessageRequestToJSON(
+  sendLinkedInMessageRequest: SendLinkedInMessageRequest,
+): string {
+  return JSON.stringify(
+    SendLinkedInMessageRequest$outboundSchema.parse(sendLinkedInMessageRequest),
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageInternalServerErrorDetails$inboundSchema:
+  z.ZodMiniType<SendLinkedInMessageInternalServerErrorDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageInternalServerErrorDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SendLinkedInMessageInternalServerErrorDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageInternalServerErrorDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SendLinkedInMessageInternalServerErrorDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageInternalServerErrorError$inboundSchema:
+  z.ZodMiniType<SendLinkedInMessageInternalServerErrorError, 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 sendLinkedInMessageInternalServerErrorErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SendLinkedInMessageInternalServerErrorError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageInternalServerErrorError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SendLinkedInMessageInternalServerErrorError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageCode$inboundSchema: z.ZodMiniEnum<
+  typeof SendLinkedInMessageCode
+> = z.enum(SendLinkedInMessageCode);
+
+/** @internal */
+export const SendLinkedInMessageDaily$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageDaily,
+  unknown
+> = z.object({
+  current: types.number(),
+  limit: types.number(),
+});
+
+export function sendLinkedInMessageDailyFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageDaily, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageDaily$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageDaily' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageWeekly$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageWeekly,
+  unknown
+> = z.object({
+  current: types.number(),
+  limit: types.number(),
+});
+
+export function sendLinkedInMessageWeeklyFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageWeekly, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageWeekly$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageWeekly' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageTooManyRequestsError$inboundSchema:
+  z.ZodMiniType<SendLinkedInMessageTooManyRequestsError, unknown> = z.object({
+    code: SendLinkedInMessageCode$inboundSchema,
+    message: types.string(),
+    docs: types.optional(types.string()),
+    retryAfter: types.number(),
+    daily: types.nullable(z.lazy(() => SendLinkedInMessageDaily$inboundSchema)),
+    weekly: types.nullable(
+      z.lazy(() => SendLinkedInMessageWeekly$inboundSchema),
+    ),
+  });
+
+export function sendLinkedInMessageTooManyRequestsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SendLinkedInMessageTooManyRequestsError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageTooManyRequestsError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SendLinkedInMessageTooManyRequestsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageUnprocessableEntityDetails$inboundSchema:
+  z.ZodMiniType<SendLinkedInMessageUnprocessableEntityDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageUnprocessableEntityDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SendLinkedInMessageUnprocessableEntityDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageUnprocessableEntityDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SendLinkedInMessageUnprocessableEntityDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageUnprocessableEntityError$inboundSchema:
+  z.ZodMiniType<SendLinkedInMessageUnprocessableEntityError, 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 sendLinkedInMessageUnprocessableEntityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SendLinkedInMessageUnprocessableEntityError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageUnprocessableEntityError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SendLinkedInMessageUnprocessableEntityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageGoneDetails$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageGoneDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageGoneDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageGoneDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageGoneDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageGoneDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageGoneError$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageGoneError,
+  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 sendLinkedInMessageGoneErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageGoneError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageGoneError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageGoneError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageConflictDetails$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageConflictDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageConflictDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageConflictDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageConflictDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageConflictDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageConflictError$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageConflictError,
+  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 sendLinkedInMessageConflictErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageConflictError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageConflictError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageConflictError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageNotFoundDetails$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageNotFoundDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageNotFoundDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageNotFoundDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageNotFoundDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageNotFoundDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageNotFoundError$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageNotFoundError,
+  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 sendLinkedInMessageNotFoundErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageNotFoundError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageNotFoundError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageNotFoundError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageForbiddenDetails$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageForbiddenDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageForbiddenDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageForbiddenDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageForbiddenDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageForbiddenDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageForbiddenError$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageForbiddenError,
+  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 sendLinkedInMessageForbiddenErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageForbiddenError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageForbiddenError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageForbiddenError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageUnauthorizedDetails$inboundSchema:
+  z.ZodMiniType<SendLinkedInMessageUnauthorizedDetails, unknown> = smartUnion([
+    types.string(),
+    z.array(types.string()),
+  ]);
+
+export function sendLinkedInMessageUnauthorizedDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageUnauthorizedDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageUnauthorizedDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageUnauthorizedDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageUnauthorizedError$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageUnauthorizedError,
+  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 sendLinkedInMessageUnauthorizedErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageUnauthorizedError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageUnauthorizedError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageUnauthorizedError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageBadRequestDetails$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageBadRequestDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function sendLinkedInMessageBadRequestDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageBadRequestDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageBadRequestDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageBadRequestDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageBadRequestError$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageBadRequestError,
+  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 sendLinkedInMessageBadRequestErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageBadRequestError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SendLinkedInMessageBadRequestError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageBadRequestError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendLinkedInMessageResponse$inboundSchema: z.ZodMiniType<
+  SendLinkedInMessageResponse,
+  unknown
+> = z.object({
+  success: types.literal(true),
+  messageId: types.string(),
+  duplicate: types.optional(types.boolean()),
+  creditsUsed: types.number(),
+  retryAfter: types.number(),
+});
+
+export function sendLinkedInMessageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SendLinkedInMessageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendLinkedInMessageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendLinkedInMessageResponse' from JSON`,
+  );
+}