@epilot/targeting-client
Version:
JavaScript client library for the epilot Targeting API
1,519 lines (1,517 loc) • 68.2 kB
TypeScript
/* eslint-disable */
import type {
OpenAPIClient,
Parameters,
UnknownParamsObject,
OperationResponse,
AxiosRequestConfig,
} from 'openapi-client-axios';
declare namespace Components {
namespace Parameters {
export type CampaignIdPathParam = /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
Schemas.BaseUUID /* uuid */;
export type RecipientIdPathParam = /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
Schemas.BaseUUID /* uuid */;
}
export interface PathParameters {
CampaignIdPathParam?: Parameters.CampaignIdPathParam;
RecipientIdPathParam?: Parameters.RecipientIdPathParam;
}
namespace Responses {
export type CampaignPortalsResponse = {
portal: {
/**
* The origin of the portal
*/
origin?: string;
/**
* The domain of the portal
*/
domain?: string;
/**
* The name of the portal
*/
name?: string;
};
widgets: {
/**
* The ID of the widget
*/
id: string;
headline?: {
/**
* The headline in English
*/
en?: string;
/**
* The headline in German
*/
de?: string;
};
}[];
}[];
export interface CampaignResponse {
campaign?: Schemas.Campaign;
}
export type ClientErrorResponse = /**
* Describes the structure of a client error response, which can be one of several types:
* 1. `MessageError`: Contains a 'message' field for general descriptive errors.
* 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
* 3. `StatusedError`: Contains 'error' and 'status' fields.
* The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
*
*/
Schemas.ClientError;
export type JobStatusResponse = Schemas.JobStatus;
export interface MatchCampaignsResponse {
/**
* Number of matching campaigns.
*/
hits?: number;
/**
* List of matching campaigns.
*/
results?: {
campaign: Schemas.Campaign;
}[];
}
export interface MatchTargetsResponse {
/**
* Number of matching targets.
*/
hits?: number;
/**
* List of matching targets.
*/
results?: {
target: Schemas.Target;
}[];
}
export type RecipientResponse = Schemas.Recipient;
export interface RecipientsResponse {
results?: Schemas.Recipient[];
/**
* Cursor for next page of results
*/
next?: string | null;
/**
* Total number of recipients
*/
total?: number;
}
export interface RetriggerAutomationsResponse {
/**
* A confirmation message indicating the request was received and processed
*/
message: string;
/**
* List of retriggering results
*/
results: Schemas.RetriggerAutomationsResult[];
}
export type ServerErrorResponse = Schemas.ServerError;
}
namespace Schemas {
export interface AutomationRecipientPayload {
automation_status: AutomationStatus;
automation_execution_id: string;
}
export type AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
/**
* Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
*/
export interface BaseEntityAcl {
[name: string]: any;
view?: string[];
edit?: string[];
delete?: string[];
}
/**
* The user / organization owning this entity.
*
* Note: Owner implicitly has access to the entity regardless of ACLs.
*
*/
export interface BaseEntityOwner {
/**
* example:
* 123
*/
org_id: string;
/**
* example:
* 123
*/
user_id?: string;
}
export interface BaseError {
/**
* example:
* 404
*/
status: number;
/**
* example:
* Entity not found
*/
message: string;
}
/**
* example:
* xHcOoJCa07eysJ1GaQeSb
*/
export type BaseNanoID = string;
export interface BaseRecipientPayload {
entity_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema: string;
}
export interface BaseRelation {
$relation?: {
entity_id?: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
_tags?: BaseTags;
}[];
}
export interface BaseSystemFields {
/**
* Organization Id the entity belongs to
*/
_org?: string;
_owners?: /**
* The user / organization owning this entity.
*
* Note: Owner implicitly has access to the entity regardless of ACLs.
*
*/
BaseEntityOwner[];
_schema?: string;
_title?: string;
_tags?: BaseTags;
_created_at?: string; // date-time
_updated_at?: string; // date-time
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
}
export interface BaseSystemFieldsRequired {
}
export interface BaseSystemId {
_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
}
export type BaseTags = string[] | null;
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
export type BaseUUID = string; // uuid
export interface Campaign {
/**
* Organization Id the entity belongs to
*/
_org?: string;
_owners?: /**
* The user / organization owning this entity.
*
* Note: Owner implicitly has access to the entity regardless of ACLs.
*
*/
BaseEntityOwner[];
_schema?: string;
_title?: string;
_tags?: BaseTags;
_created_at?: string; // date-time
_updated_at?: string; // date-time
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
id?: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
name?: string;
goal?: string;
status?: CampaignStatus;
start_date?: string; // date
end_date?: string; // date
flow_id?: string;
job_id?: string;
target?: BaseRelation;
}
export type CampaignStatus = "draft" | "activating" | "active" | "inactive";
/**
* Describes the structure of a client error response, which can be one of several types:
* 1. `MessageError`: Contains a 'message' field for general descriptive errors.
* 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
* 3. `StatusedError`: Contains 'error' and 'status' fields.
* The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
*
*/
export type ClientError = /**
* Describes the structure of a client error response, which can be one of several types:
* 1. `MessageError`: Contains a 'message' field for general descriptive errors.
* 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
* 3. `StatusedError`: Contains 'error' and 'status' fields.
* The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
*
*/
{
/**
* A descriptive error message.
* example:
* The provided input was invalid.
*/
message: string;
} | {
/**
* A specific machine-readable error code indicating a known error condition.
* example:
* CAMPAIGN_NOT_FOUND
*/
code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS";
} | {
/**
* A descriptive error message.
* example:
* An unexpected error occurred during processing.
*/
error: string;
/**
* An explicit status code in the body, often mirroring the HTTP status but provided for programmatic access.
* example:
* 400
*/
status: number;
};
export type CreateRecipientPayload = {
entity_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema: string;
automation_status: AutomationStatus;
automation_execution_id: string;
} | {
entity_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema: string;
portal_status: PortalStatus;
portal_state?: {
[name: string]: any;
};
} | {
entity_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema: string;
automation_status: AutomationStatus;
automation_execution_id: string;
portal_status: PortalStatus;
portal_state?: {
[name: string]: any;
};
};
export interface ExecutionSummaryItem {
execution_id?: string;
execution_status?: string;
}
export interface JobStatus {
/**
* The status of the automation job
*/
status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report";
execution_summary?: ExecutionSummaryItem[];
}
export interface MatchCampaignParams {
/**
* List of entities (e.g. Contacts or Contracts) that should be part of the campaign target.
*/
entity_refs: {
entity_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema: string;
}[];
/**
* List of campaign IDs to check.
* example:
* [
* "b8c01433-5556-4e2b-aad4-6f5348d1df84"
* ]
*/
campaign_ids: [
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?
];
}
export interface MatchTargetParams {
/**
* List of entities (e.g. Contacts or Contracts) that should be part of the targets.
*/
entity_refs: {
entity_id: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema: string;
}[];
/**
* List of target IDs to check.
* example:
* [
* "b8c01433-5556-4e2b-aad4-6f5348d1df84"
* ]
*/
target_ids: [
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?,
/**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */?
];
}
export interface PortalRecipientPayload {
portal_status: PortalStatus;
portal_state?: {
[name: string]: any;
};
}
export type PortalStatus = "sent" | "seen" | "dismissed" | "clicked";
export interface Recipient {
entity_id?: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
entity_schema?: string;
title?: string;
automation_status?: AutomationStatus;
automation_execution_id?: string;
portal_status?: PortalStatus;
portal_status_updated_at?: string; // date-time
portal_state?: {
[name: string]: any;
};
updated_at?: string; // date-time
}
export interface RetriggerAutomationsRequest {
/**
* List of recipient IDs to retrigger automations for
*/
recipient_ids: string /* uuid */[];
}
export interface RetriggerAutomationsResult {
/**
* The ID of the recipient
*/
recipient_id: string; // uuid
/**
* The result of the retriggering operation
*/
result: "success" | "failure" | "not_found" | "invalid_status";
/**
* The ID of the new automation execution (if successful)
*/
execution_id?: string;
/**
* The error message if the operation failed
*/
error?: string;
}
export type ServerError = BaseError;
export interface Target {
/**
* Organization Id the entity belongs to
*/
_org?: string;
_owners?: /**
* The user / organization owning this entity.
*
* Note: Owner implicitly has access to the entity regardless of ACLs.
*
*/
BaseEntityOwner[];
_schema?: string;
_title?: string;
_tags?: BaseTags;
_created_at?: string; // date-time
_updated_at?: string; // date-time
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
id?: /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
BaseUUID /* uuid */;
name?: string;
description?: string;
entity_schema?: string;
entity_filters?: {
[name: string]: any;
};
}
export interface UpdatePortalStatusRequest {
status: PortalStatus;
}
export interface UpdateRecipientPayload {
automation_status?: AutomationStatus;
automation_execution_id?: string;
portal_status?: PortalStatus;
portal_state?: {
[name: string]: any;
};
}
}
}
declare namespace Paths {
namespace ChangeCampaignStatus {
namespace Parameters {
export type CampaignId = /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
Components.Schemas.BaseUUID /* uuid */;
}
export interface PathParameters {
campaign_id: Parameters.CampaignId;
}
namespace Responses {
export type $200 = Components.Responses.CampaignResponse;
export type $400 = Components.Responses.ClientErrorResponse;
export type $500 = Components.Responses.ServerErrorResponse;
}
}
namespace CreateRecipient {
namespace Parameters {
export type CampaignId = /**
* example:
* b8c01433-5556-4e2b-aad4-6f5348d1df84
*/
Components.Schemas.BaseUUID /* uuid */;
}
export interface PathParameters {
campaign_id: Parameters.CampaignId;
}
export type RequestBody = Components.Schemas.CreateRecipientPayload;
namespace Responses {
export type $201 = Components.Responses.RecipientResponse;
export type $400 = Components.Responses.ClientErrorResponse;
export type $500 = Components.Responses.ServerErrorResponse;
}
}
namespace GetCampaignJobStatus {
na