bereach 1.4.0 → 1.4.2

package/src/models/operations/update-schedule-response.ts

@@ -677,32 +677,18 @@ export type SetAgentStateResponse = {
   retryAfter: number;
 };
 
-export type PatchAgentStateRequestBody = {
-  /**
-   * Partial state fields to merge
-   */
-  data: { [k: string]: any };
-};
-
-export type PatchAgentStateRequest = {
+export type DeleteAgentStateRequest = {
   /**
    * State key
    */
   key: string;
-  body: PatchAgentStateRequestBody;
 };
 
 /**
- * State merged
+ * State deleted
  */
-export type PatchAgentStateResponse = {
+export type DeleteAgentStateResponse = {
   success: true;
-  key: string;
-  /**
-   * Full state object
-   */
-  data: any;
-  updatedAt: string | null;
   /**
    * Credits consumed by this call (always 0 for contacts queries).
    */
@@ -713,18 +699,32 @@ export type PatchAgentStateResponse = {
   retryAfter: number;
 };
 
-export type DeleteAgentStateRequest = {
+export type PatchAgentStateRequestBody = {
+  /**
+   * Partial state fields to merge
+   */
+  data: { [k: string]: any };
+};
+
+export type PatchAgentStateRequest = {
   /**
    * State key
    */
   key: string;
+  body: PatchAgentStateRequestBody;
 };
 
 /**
- * State deleted
+ * State merged
  */
-export type DeleteAgentStateResponse = {
+export type PatchAgentStateResponse = {
   success: true;
+  key: string;
+  /**
+   * Full state object
+   */
+  data: any;
+  updatedAt: string | null;
   /**
    * Credits consumed by this call (always 0 for contacts queries).
    */
@@ -758,8 +758,18 @@ export type ListCampaignsStageCounts = {
 };
 
 export type ListCampaignsCampaign = {
+  /**
+   * Campaign unique ID (nanoid). Use this as campaignSlug in API calls.
+   */
   id: string;
+  /**
+   * Human-readable campaign name.
+   */
   name: string;
+  /**
+   * URL-safe slug auto-generated from name.
+   */
+  slug?: string | null | undefined;
   description: string | null;
   context: string | null;
   type: string;
@@ -836,7 +846,7 @@ export type CreateCampaignType = ClosedEnum<typeof CreateCampaignType>;
 
 export type CreateCampaignRequest = {
   /**
-   * Campaign name (e.g., 'lg-engagement-competitor-openai')
+   * Human-readable campaign name. Use a clear, descriptive title (e.g., 'Reverse Prospecting — LinkedIn Connections', 'SaaS Sales Leaders EU'). Do NOT use slugs or technical IDs.
    */
   name: string;
   /**
@@ -862,8 +872,18 @@ export type CreateCampaignStageCounts = {
 };
 
 export type CreateCampaignCampaign = {
+  /**
+   * Campaign unique ID (nanoid). Use this as campaignSlug in API calls.
+   */
   id: string;
+  /**
+   * Human-readable campaign name.
+   */
   name: string;
+  /**
+   * URL-safe slug auto-generated from name.
+   */
+  slug?: string | null | undefined;
   description: string | null;
   context: string | null;
   type: string;
@@ -934,8 +954,18 @@ export type GetCampaignStageCounts = {
 };
 
 export type GetCampaignCampaign = {
+  /**
+   * Campaign unique ID (nanoid). Use this as campaignSlug in API calls.
+   */
   id: string;
+  /**
+   * Human-readable campaign name.
+   */
   name: string;
+  /**
+   * URL-safe slug auto-generated from name.
+   */
+  slug?: string | null | undefined;
   description: string | null;
   context: string | null;
   type: string;
@@ -990,6 +1020,28 @@ export type GetCampaignResponse = {
   retryAfter: number;
 };
 
+export type DeleteCampaignRequest = {
+  /**
+   * Campaign ID
+   */
+  campaignId: string;
+};
+
+/**
+ * Campaign deleted
+ */
+export type DeleteCampaignResponse = {
+  success: true;
+  /**
+   * Credits consumed by this call (always 0 for contacts queries).
+   */
+  creditsUsed: number;
+  /**
+   * Seconds to wait before next call of the same type (always 0 for contacts queries).
+   */
+  retryAfter: number;
+};
+
 export const UpdateCampaignStatus = {
   Draft: "draft",
   Scheduled: "scheduled",
@@ -1029,8 +1081,18 @@ export type UpdateCampaignStageCounts = {
 };
 
 export type UpdateCampaignCampaign = {
+  /**
+   * Campaign unique ID (nanoid). Use this as campaignSlug in API calls.
+   */
   id: string;
+  /**
+   * Human-readable campaign name.
+   */
   name: string;
+  /**
+   * URL-safe slug auto-generated from name.
+   */
+  slug?: string | null | undefined;
   description: string | null;
   context: string | null;
   type: string;
@@ -1085,28 +1147,6 @@ export type UpdateCampaignResponse = {
   retryAfter: number;
 };
 
-export type DeleteCampaignRequest = {
-  /**
-   * Campaign ID
-   */
-  campaignId: string;
-};
-
-/**
- * Campaign deleted
- */
-export type DeleteCampaignResponse = {
-  success: true;
-  /**
-   * Credits consumed by this call (always 0 for contacts queries).
-   */
-  creditsUsed: number;
-  /**
-   * Seconds to wait before next call of the same type (always 0 for contacts queries).
-   */
-  retryAfter: number;
-};
-
 export const CampaignStatusTransitionAction = {
   Activate: "activate",
   Start: "start",
@@ -1145,8 +1185,18 @@ export type CampaignStatusTransitionStageCounts = {
 };
 
 export type CampaignStatusTransitionCampaign = {
+  /**
+   * Campaign unique ID (nanoid). Use this as campaignSlug in API calls.
+   */
   id: string;
+  /**
+   * Human-readable campaign name.
+   */
   name: string;
+  /**
+   * URL-safe slug auto-generated from name.
+   */
+  slug?: string | null | undefined;
   description: string | null;
   context: string | null;
   type: string;
@@ -2995,6 +3045,47 @@ export function setAgentStateResponseFromJSON(
   );
 }
 
+/** @internal */
+export type DeleteAgentStateRequest$Outbound = {
+  key: string;
+};
+
+/** @internal */
+export const DeleteAgentStateRequest$outboundSchema: z.ZodMiniType<
+  DeleteAgentStateRequest$Outbound,
+  DeleteAgentStateRequest
+> = z.object({
+  key: z.string(),
+});
+
+export function deleteAgentStateRequestToJSON(
+  deleteAgentStateRequest: DeleteAgentStateRequest,
+): string {
+  return JSON.stringify(
+    DeleteAgentStateRequest$outboundSchema.parse(deleteAgentStateRequest),
+  );
+}
+
+/** @internal */
+export const DeleteAgentStateResponse$inboundSchema: z.ZodMiniType<
+  DeleteAgentStateResponse,
+  unknown
+> = z.object({
+  success: types.literal(true),
+  creditsUsed: types.number(),
+  retryAfter: types.number(),
+});
+
+export function deleteAgentStateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteAgentStateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteAgentStateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteAgentStateResponse' from JSON`,
+  );
+}
+
 /** @internal */
 export type PatchAgentStateRequestBody$Outbound = {
   data: { [k: string]: any };
@@ -3062,47 +3153,6 @@ export function patchAgentStateResponseFromJSON(
   );
 }
 
-/** @internal */
-export type DeleteAgentStateRequest$Outbound = {
-  key: string;
-};
-
-/** @internal */
-export const DeleteAgentStateRequest$outboundSchema: z.ZodMiniType<
-  DeleteAgentStateRequest$Outbound,
-  DeleteAgentStateRequest
-> = z.object({
-  key: z.string(),
-});
-
-export function deleteAgentStateRequestToJSON(
-  deleteAgentStateRequest: DeleteAgentStateRequest,
-): string {
-  return JSON.stringify(
-    DeleteAgentStateRequest$outboundSchema.parse(deleteAgentStateRequest),
-  );
-}
-
-/** @internal */
-export const DeleteAgentStateResponse$inboundSchema: z.ZodMiniType<
-  DeleteAgentStateResponse,
-  unknown
-> = z.object({
-  success: types.literal(true),
-  creditsUsed: types.number(),
-  retryAfter: types.number(),
-});
-
-export function deleteAgentStateResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<DeleteAgentStateResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => DeleteAgentStateResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'DeleteAgentStateResponse' from JSON`,
-  );
-}
-
 /** @internal */
 export const ListCampaignsType$outboundSchema: z.ZodMiniEnum<
   typeof ListCampaignsType
@@ -3164,6 +3214,7 @@ export const ListCampaignsCampaign$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.string(),
   name: types.string(),
+  slug: z.optional(z.nullable(types.string())),
   description: types.nullable(types.string()),
   context: types.nullable(types.string()),
   type: types.string(),
@@ -3296,6 +3347,7 @@ export const CreateCampaignCampaign$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.string(),
   name: types.string(),
+  slug: z.optional(z.nullable(types.string())),
   description: types.nullable(types.string()),
   context: types.nullable(types.string()),
   type: types.string(),
@@ -3396,6 +3448,7 @@ export const GetCampaignCampaign$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.string(),
   name: types.string(),
+  slug: z.optional(z.nullable(types.string())),
   description: types.nullable(types.string()),
   context: types.nullable(types.string()),
   type: types.string(),
@@ -3446,6 +3499,47 @@ export function getCampaignResponseFromJSON(
   );
 }
 
+/** @internal */
+export type DeleteCampaignRequest$Outbound = {
+  campaignId: string;
+};
+
+/** @internal */
+export const DeleteCampaignRequest$outboundSchema: z.ZodMiniType<
+  DeleteCampaignRequest$Outbound,
+  DeleteCampaignRequest
+> = z.object({
+  campaignId: z.string(),
+});
+
+export function deleteCampaignRequestToJSON(
+  deleteCampaignRequest: DeleteCampaignRequest,
+): string {
+  return JSON.stringify(
+    DeleteCampaignRequest$outboundSchema.parse(deleteCampaignRequest),
+  );
+}
+
+/** @internal */
+export const DeleteCampaignResponse$inboundSchema: z.ZodMiniType<
+  DeleteCampaignResponse,
+  unknown
+> = z.object({
+  success: types.literal(true),
+  creditsUsed: types.number(),
+  retryAfter: types.number(),
+});
+
+export function deleteCampaignResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteCampaignResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteCampaignResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteCampaignResponse' from JSON`,
+  );
+}
+
 /** @internal */
 export const UpdateCampaignStatus$outboundSchema: z.ZodMiniEnum<
   typeof UpdateCampaignStatus
@@ -3540,6 +3634,7 @@ export const UpdateCampaignCampaign$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.string(),
   name: types.string(),
+  slug: z.optional(z.nullable(types.string())),
   description: types.nullable(types.string()),
   context: types.nullable(types.string()),
   type: types.string(),
@@ -3590,47 +3685,6 @@ export function updateCampaignResponseFromJSON(
   );
 }
 
-/** @internal */
-export type DeleteCampaignRequest$Outbound = {
-  campaignId: string;
-};
-
-/** @internal */
-export const DeleteCampaignRequest$outboundSchema: z.ZodMiniType<
-  DeleteCampaignRequest$Outbound,
-  DeleteCampaignRequest
-> = z.object({
-  campaignId: z.string(),
-});
-
-export function deleteCampaignRequestToJSON(
-  deleteCampaignRequest: DeleteCampaignRequest,
-): string {
-  return JSON.stringify(
-    DeleteCampaignRequest$outboundSchema.parse(deleteCampaignRequest),
-  );
-}
-
-/** @internal */
-export const DeleteCampaignResponse$inboundSchema: z.ZodMiniType<
-  DeleteCampaignResponse,
-  unknown
-> = z.object({
-  success: types.literal(true),
-  creditsUsed: types.number(),
-  retryAfter: types.number(),
-});
-
-export function deleteCampaignResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<DeleteCampaignResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => DeleteCampaignResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'DeleteCampaignResponse' from JSON`,
-  );
-}
-
 /** @internal */
 export const CampaignStatusTransitionAction$outboundSchema: z.ZodMiniEnum<
   typeof CampaignStatusTransitionAction
@@ -3724,6 +3778,7 @@ export const CampaignStatusTransitionCampaign$inboundSchema: z.ZodMiniType<
 > = z.object({
   id: types.string(),
   name: types.string(),
+  slug: z.optional(z.nullable(types.string())),
   description: types.nullable(types.string()),
   context: types.nullable(types.string()),
   type: types.string(),