bereach 0.1.4 → 1.2.3

package/src/models/operations/get-campaign-status.ts

@@ -0,0 +1,656 @@
+/*
+ * 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 GetCampaignStatusRequestBody = {
+  /**
+   * LinkedIn profile URLs or URNs to check status for within this campaign.
+   */
+  profiles: Array<string>;
+};
+
+export type GetCampaignStatusRequest = {
+  /**
+   * Campaign identifier
+   */
+  campaignSlug: string;
+  body: GetCampaignStatusRequestBody;
+};
+
+export type GetCampaignStatusInternalServerErrorDetails =
+  | string
+  | Array<string>;
+
+export type GetCampaignStatusInternalServerErrorError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export const GetCampaignStatusCode = {
+  RateLimitExceeded: "rate_limit_exceeded",
+} as const;
+export type GetCampaignStatusCode = ClosedEnum<typeof GetCampaignStatusCode>;
+
+/**
+ * Current and max daily usage (null if no daily cap).
+ */
+export type GetCampaignStatusDaily = {
+  current: number;
+  limit: number;
+};
+
+/**
+ * Current and max weekly usage (null if no weekly cap).
+ */
+export type GetCampaignStatusWeekly = {
+  current: number;
+  limit: number;
+};
+
+export type GetCampaignStatusTooManyRequestsError = {
+  code: GetCampaignStatusCode;
+  message: string;
+  docs?: string | undefined;
+  /**
+   * Seconds to wait before retrying.
+   */
+  retryAfter: number;
+  /**
+   * Current and max daily usage (null if no daily cap).
+   */
+  daily: GetCampaignStatusDaily | null;
+  /**
+   * Current and max weekly usage (null if no weekly cap).
+   */
+  weekly: GetCampaignStatusWeekly | null;
+};
+
+export type GetCampaignStatusUnprocessableEntityDetails =
+  | string
+  | Array<string>;
+
+export type GetCampaignStatusUnprocessableEntityError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusGoneDetails = string | Array<string>;
+
+export type GetCampaignStatusGoneError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusConflictDetails = string | Array<string>;
+
+export type GetCampaignStatusConflictError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusNotFoundDetails = string | Array<string>;
+
+export type GetCampaignStatusNotFoundError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusForbiddenDetails = string | Array<string>;
+
+export type GetCampaignStatusForbiddenError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusUnauthorizedDetails = string | Array<string>;
+
+export type GetCampaignStatusUnauthorizedError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusBadRequestDetails = string | Array<string>;
+
+export type GetCampaignStatusBadRequestError = {
+  code: string;
+  message: string;
+  docs?: string | undefined;
+  details?: string | Array<string> | undefined;
+};
+
+export type GetCampaignStatusProfile = {
+  profile: string;
+  message: boolean;
+  reply: boolean;
+  like: boolean;
+  visit: boolean;
+  connect: boolean;
+};
+
+/**
+ * Per-profile action completion status
+ */
+export type GetCampaignStatusResponse = {
+  success: true;
+  profiles: Array<GetCampaignStatusProfile>;
+  /**
+   * Credits consumed by this call (always 0 for campaign queries).
+   */
+  creditsUsed: number;
+  /**
+   * Seconds to wait before next call of the same type (always 0 for campaign queries).
+   */
+  retryAfter: number;
+};
+
+/** @internal */
+export type GetCampaignStatusRequestBody$Outbound = {
+  profiles: Array<string>;
+};
+
+/** @internal */
+export const GetCampaignStatusRequestBody$outboundSchema: z.ZodMiniType<
+  GetCampaignStatusRequestBody$Outbound,
+  GetCampaignStatusRequestBody
+> = z.object({
+  profiles: z.array(z.string()),
+});
+
+export function getCampaignStatusRequestBodyToJSON(
+  getCampaignStatusRequestBody: GetCampaignStatusRequestBody,
+): string {
+  return JSON.stringify(
+    GetCampaignStatusRequestBody$outboundSchema.parse(
+      getCampaignStatusRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type GetCampaignStatusRequest$Outbound = {
+  campaignSlug: string;
+  body: GetCampaignStatusRequestBody$Outbound;
+};
+
+/** @internal */
+export const GetCampaignStatusRequest$outboundSchema: z.ZodMiniType<
+  GetCampaignStatusRequest$Outbound,
+  GetCampaignStatusRequest
+> = z.object({
+  campaignSlug: z.string(),
+  body: z.lazy(() => GetCampaignStatusRequestBody$outboundSchema),
+});
+
+export function getCampaignStatusRequestToJSON(
+  getCampaignStatusRequest: GetCampaignStatusRequest,
+): string {
+  return JSON.stringify(
+    GetCampaignStatusRequest$outboundSchema.parse(getCampaignStatusRequest),
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusInternalServerErrorDetails$inboundSchema:
+  z.ZodMiniType<GetCampaignStatusInternalServerErrorDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusInternalServerErrorDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCampaignStatusInternalServerErrorDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusInternalServerErrorDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCampaignStatusInternalServerErrorDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusInternalServerErrorError$inboundSchema:
+  z.ZodMiniType<GetCampaignStatusInternalServerErrorError, 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 getCampaignStatusInternalServerErrorErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCampaignStatusInternalServerErrorError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusInternalServerErrorError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCampaignStatusInternalServerErrorError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusCode$inboundSchema: z.ZodMiniEnum<
+  typeof GetCampaignStatusCode
+> = z.enum(GetCampaignStatusCode);
+
+/** @internal */
+export const GetCampaignStatusDaily$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusDaily,
+  unknown
+> = z.object({
+  current: types.number(),
+  limit: types.number(),
+});
+
+export function getCampaignStatusDailyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusDaily, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusDaily$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusDaily' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusWeekly$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusWeekly,
+  unknown
+> = z.object({
+  current: types.number(),
+  limit: types.number(),
+});
+
+export function getCampaignStatusWeeklyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusWeekly, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusWeekly$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusWeekly' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusTooManyRequestsError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusTooManyRequestsError,
+  unknown
+> = z.object({
+  code: GetCampaignStatusCode$inboundSchema,
+  message: types.string(),
+  docs: types.optional(types.string()),
+  retryAfter: types.number(),
+  daily: types.nullable(z.lazy(() => GetCampaignStatusDaily$inboundSchema)),
+  weekly: types.nullable(z.lazy(() => GetCampaignStatusWeekly$inboundSchema)),
+});
+
+export function getCampaignStatusTooManyRequestsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusTooManyRequestsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusTooManyRequestsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusTooManyRequestsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusUnprocessableEntityDetails$inboundSchema:
+  z.ZodMiniType<GetCampaignStatusUnprocessableEntityDetails, unknown> =
+    smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusUnprocessableEntityDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCampaignStatusUnprocessableEntityDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusUnprocessableEntityDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCampaignStatusUnprocessableEntityDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusUnprocessableEntityError$inboundSchema:
+  z.ZodMiniType<GetCampaignStatusUnprocessableEntityError, 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 getCampaignStatusUnprocessableEntityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCampaignStatusUnprocessableEntityError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusUnprocessableEntityError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCampaignStatusUnprocessableEntityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusGoneDetails$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusGoneDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusGoneDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusGoneDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusGoneDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusGoneDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusGoneError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusGoneError,
+  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 getCampaignStatusGoneErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusGoneError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusGoneError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusGoneError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusConflictDetails$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusConflictDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusConflictDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusConflictDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusConflictDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusConflictDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusConflictError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusConflictError,
+  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 getCampaignStatusConflictErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusConflictError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusConflictError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusConflictError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusNotFoundDetails$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusNotFoundDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusNotFoundDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusNotFoundDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusNotFoundDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusNotFoundDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusNotFoundError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusNotFoundError,
+  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 getCampaignStatusNotFoundErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusNotFoundError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusNotFoundError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusNotFoundError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusForbiddenDetails$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusForbiddenDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusForbiddenDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusForbiddenDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusForbiddenDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusForbiddenDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusForbiddenError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusForbiddenError,
+  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 getCampaignStatusForbiddenErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusForbiddenError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusForbiddenError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusForbiddenError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusUnauthorizedDetails$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusUnauthorizedDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusUnauthorizedDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusUnauthorizedDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusUnauthorizedDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusUnauthorizedDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusUnauthorizedError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusUnauthorizedError,
+  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 getCampaignStatusUnauthorizedErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusUnauthorizedError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusUnauthorizedError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusUnauthorizedError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusBadRequestDetails$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusBadRequestDetails,
+  unknown
+> = smartUnion([types.string(), z.array(types.string())]);
+
+export function getCampaignStatusBadRequestDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusBadRequestDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCampaignStatusBadRequestDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusBadRequestDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusBadRequestError$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusBadRequestError,
+  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 getCampaignStatusBadRequestErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusBadRequestError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusBadRequestError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusBadRequestError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusProfile$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusProfile,
+  unknown
+> = z.object({
+  profile: types.string(),
+  message: types.boolean(),
+  reply: types.boolean(),
+  like: types.boolean(),
+  visit: types.boolean(),
+  connect: types.boolean(),
+});
+
+export function getCampaignStatusProfileFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusProfile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusProfile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusProfile' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCampaignStatusResponse$inboundSchema: z.ZodMiniType<
+  GetCampaignStatusResponse,
+  unknown
+> = z.object({
+  success: types.literal(true),
+  profiles: z.array(z.lazy(() => GetCampaignStatusProfile$inboundSchema)),
+  creditsUsed: types.number(),
+  retryAfter: types.number(),
+});
+
+export function getCampaignStatusResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCampaignStatusResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCampaignStatusResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCampaignStatusResponse' from JSON`,
+  );
+}