@joai/sdk 4.6.0 → 4.7.0

package/dist/index.d.mts

@@ -1898,6 +1898,88 @@ type AppointmentRequest = {
   configuration?: Configuration;
   createdAt: string;
 }; //#endregion
+//#region src/automation/types.d.ts
+type AutomationTriggerType = 'prop' | 'segment' | 'manual';
+type AutomationActionType = 'wait' | 'send_email' | 'halt';
+type AutomationSendMode = 'direct' | 'campaign';
+type AutomationEnrollmentStatus = 'active' | 'completed' | 'skipped';
+type AutomationSkipReason = 'pending_consent' | 'opted_out' | 'missing_channel' | 'automation_disabled' | 'already_completed';
+type AutomationTriggerConfig = {
+  propKey?: string;
+  propValue?: string | number | boolean;
+  segmentId?: string;
+};
+type AutomationActionConfig = {
+  delayMinutes?: number;
+  sendMode?: AutomationSendMode;
+  campaignId?: string;
+  subject?: string;
+  body?: string;
+  contentHtml?: boolean;
+  sentPropKey?: string;
+  [key: string]: unknown;
+};
+type AutomationAction = {
+  id: string;
+  position: number;
+  type: AutomationActionType;
+  config: AutomationActionConfig;
+};
+type Automation = {
+  id: string;
+  name: string;
+  triggerType: AutomationTriggerType;
+  triggerConfig: AutomationTriggerConfig;
+  enabled: boolean;
+  agent: AgentSimple | null;
+  actions?: AutomationAction[];
+  createdAt: string;
+  updatedAt: string;
+};
+type AutomationEnrollment = {
+  id: string;
+  automationId: string;
+  contactId: string | null;
+  contact?: {
+    id: string;
+    name: string | null;
+    email: string | null;
+  };
+  status: AutomationEnrollmentStatus;
+  currentPosition: number;
+  enteredAt: string | null;
+  eligibleAt: string | null;
+  sentAt: string | null;
+  completedAt: string | null;
+  skippedAt: string | null;
+  skipReason: AutomationSkipReason | null;
+  error: string | null;
+  createdAt: string;
+  updatedAt: string;
+};
+type AutomationActionInput = {
+  type: AutomationActionType;
+  config?: AutomationActionConfig;
+};
+type AutomationCreatePayload = {
+  name: string;
+  triggerType: AutomationTriggerType;
+  triggerConfig?: AutomationTriggerConfig;
+  actions?: AutomationActionInput[];
+  enabled?: boolean;
+  agentId?: string;
+};
+type AutomationUpdatePayload = {
+  name?: string;
+  triggerType?: AutomationTriggerType;
+  triggerConfig?: AutomationTriggerConfig;
+  enabled?: boolean;
+  agentId?: string | null;
+};
+type AutomationAudiencePreview = {
+  count: number;
+  sampleContactIds: string[];
+}; //#endregion
 //#region src/content/types.d.ts
 type ContentStatus = 'draft' | 'published' | 'archived';
 type ContentFieldType = 'text' | 'richText' | 'number' | 'boolean' | 'url' | 'image' | 'media' | 'list' | 'object' | 'reference';
@@ -4990,6 +5072,27 @@ declare class CampaignsResource {
   delete(id: string): Promise<IAppResponse<void>>;
 }
 //#endregion
+//#region src/resources/automations.d.ts
+declare class AutomationsResource {
+  private readonly http;
+  constructor(http: IHttpService);
+  list(): Promise<IAppResponse<Automation[]>>;
+  get(id: string): Promise<IAppResponse<Automation>>;
+  create(payload: AutomationCreatePayload): Promise<IAppResponse<Automation>>;
+  update(id: string, payload: AutomationUpdatePayload): Promise<IAppResponse<Automation>>;
+  setActions(id: string, actions: AutomationActionInput[]): Promise<IAppResponse<Automation>>;
+  delete(id: string): Promise<IAppResponse<void>>;
+  enrollments(id: string, params?: {
+    page?: number;
+    perPage?: number;
+  }): Promise<IAppResponse<AutomationEnrollment[]>>;
+  run(id: string, payload: {
+    contactId: string;
+  }): Promise<IAppResponse<AutomationEnrollment>>;
+  retryEnrollment(id: string, enrollmentId: string): Promise<IAppResponse<AutomationEnrollment>>;
+  previewAudience(id: string): Promise<IAppResponse<AutomationAudiencePreview>>;
+}
+//#endregion
 //#region src/resources/segments.d.ts
 declare class SegmentsResource {
   private readonly http;
@@ -5017,6 +5120,9 @@ declare class UpdatesResource {
     tags?: string;
     with?: UpdateRelation[];
     sort?: string;
+    limit?: number;
+    upcoming?: boolean;
+    past?: boolean;
   }): Promise<IAppResponse<Update[]>>;
   create(payload: UpdateCreatePayload): Promise<IAppResponse<Update>>;
   update(id: string, payload: UpdateUpdatePayload): Promise<IAppResponse<Update>>;
@@ -5322,6 +5428,7 @@ declare class JoAiClient {
   readonly teams: TeamsResource;
   readonly artifacts: ArtifactsResource;
   readonly campaigns: CampaignsResource;
+  readonly automations: AutomationsResource;
   readonly segments: SegmentsResource;
   readonly updates: UpdatesResource;
   readonly upgrades: UpgradesResource;
@@ -5401,4 +5508,4 @@ declare class DistributionResource {
   private fetchDistribution;
 }
 //#endregion
-export { AddressesResource, AgentsResource, AlertsResource, ApiTokensResource, AppointmentsResource, type AttachedMedia, type AuthConfirmCodeRequest, type AuthConfirmCodeResponse, type AuthNativeSessionResponse, type AuthPortalSessionResponse, AuthResource, type AuthSendCodeRequest, type BackendWarp, type BackendWarpBrand, BillingResource, BlueprintsResource, type CacheConfig, CachedHttpService, CampaignsResource, CardsResource, CartsResource, ChangelogResource, CharactersResource, CheckoutResource, CommerceResource, ContactsResource, ContentResource, ContractsResource, type CreateHookPayload, type CreateInboundHookPayload, type CreateInternalHookPayload, type CreateWarpLinkedHookPayload, type CreateWebHookPayload, DeskResource, DistributionResource, DocumentsResource, ElementsResource, EntitiesResource, FlowsResource, type FulfillmentLocationInput, FulfillmentsResource, GoalsResource, type GuestBuyer, type GuestCheckoutDraft, type GuestCommerceStorageOptions, type GuestOrderAccess, type Hook, type HookSample, type HookTrigger, type HookTriggerCondition, type HookTriggerInput, HooksResource, IngestionsResource, InquiriesResource, IntegrationsResource, IntentsResource, ItemsResource, JoAiClient, type JoAiClientConfig, KvResource, LinksResource, LoyaltyResource, McpResource, type MediaUploadType, MeetingsResource, MemoriesResource, MessagesResource, MetricsResource, MissionsResource, NotificationsResource, OfficeResource, type OpenPortalSessionOptions, type OpeningHoursEntry, type OpeningHoursFormatOptions, OrdersResource, PersonaResource, type PlaceCheckoutOrderRequest, type Product, type ProductVariation, ProductsResource, ProjectsResource, RemindersResource, ReturnsResource, SegmentsResource, ServicesResource, type ShippingRateInput, ShippingResource, type ShippingZoneInput, ShortcutsResource, SitesResource, SkillsResource, StatsResource, StoreResource, SubscriptionsResource, SwarmsResource, TagsResource, TasksResource, type TeamInviteInfo, TeamsResource, UpdatesResource, UpgradesResource, UsersResource, VoiceResource, WalletsResource, WarpsResource, type WebHookTriggerEvent, WorkspaceResource, completePortalSession, createClient, createGuestCommerceStorage, formatOpeningHours, getAuthFragmentToken, isAllowedRedirectUrl, isPortalCallbackUrl, openPortalSession, sanitizePortalCallbackUrl };
+export { AddressesResource, AgentsResource, AlertsResource, ApiTokensResource, AppointmentsResource, type AttachedMedia, type AuthConfirmCodeRequest, type AuthConfirmCodeResponse, type AuthNativeSessionResponse, type AuthPortalSessionResponse, AuthResource, type AuthSendCodeRequest, AutomationsResource, type BackendWarp, type BackendWarpBrand, BillingResource, BlueprintsResource, type CacheConfig, CachedHttpService, CampaignsResource, CardsResource, CartsResource, ChangelogResource, CharactersResource, CheckoutResource, CommerceResource, ContactsResource, ContentResource, ContractsResource, type CreateHookPayload, type CreateInboundHookPayload, type CreateInternalHookPayload, type CreateWarpLinkedHookPayload, type CreateWebHookPayload, DeskResource, DistributionResource, DocumentsResource, ElementsResource, EntitiesResource, FlowsResource, type FulfillmentLocationInput, FulfillmentsResource, GoalsResource, type GuestBuyer, type GuestCheckoutDraft, type GuestCommerceStorageOptions, type GuestOrderAccess, type Hook, type HookSample, type HookTrigger, type HookTriggerCondition, type HookTriggerInput, HooksResource, IngestionsResource, InquiriesResource, IntegrationsResource, IntentsResource, ItemsResource, JoAiClient, type JoAiClientConfig, KvResource, LinksResource, LoyaltyResource, McpResource, type MediaUploadType, MeetingsResource, MemoriesResource, MessagesResource, MetricsResource, MissionsResource, NotificationsResource, OfficeResource, type OpenPortalSessionOptions, type OpeningHoursEntry, type OpeningHoursFormatOptions, OrdersResource, PersonaResource, type PlaceCheckoutOrderRequest, type Product, type ProductVariation, ProductsResource, ProjectsResource, RemindersResource, ReturnsResource, SegmentsResource, ServicesResource, type ShippingRateInput, ShippingResource, type ShippingZoneInput, ShortcutsResource, SitesResource, SkillsResource, StatsResource, StoreResource, SubscriptionsResource, SwarmsResource, TagsResource, TasksResource, type TeamInviteInfo, TeamsResource, UpdatesResource, UpgradesResource, UsersResource, VoiceResource, WalletsResource, WarpsResource, type WebHookTriggerEvent, WorkspaceResource, completePortalSession, createClient, createGuestCommerceStorage, formatOpeningHours, getAuthFragmentToken, isAllowedRedirectUrl, isPortalCallbackUrl, openPortalSession, sanitizePortalCallbackUrl };

package/dist/index.mjs

@@ -2603,6 +2603,47 @@ const audiencePreviewQuery = (payload) => {
 	return query ? `?${query}` : "";
 };
 //#endregion
+//#region src/resources/automations.ts
+var AutomationsResource = class {
+	constructor(http) {
+		this.http = http;
+	}
+	list() {
+		return this.http.get("automations");
+	}
+	get(id) {
+		return this.http.get(`automations/${id}`);
+	}
+	create(payload) {
+		return this.http.post("automations", payload);
+	}
+	update(id, payload) {
+		return this.http.put(`automations/${id}`, payload);
+	}
+	setActions(id, actions) {
+		return this.http.put(`automations/${id}/actions`, { actions });
+	}
+	delete(id) {
+		return this.http.delete(`automations/${id}`);
+	}
+	enrollments(id, params) {
+		const search = new URLSearchParams();
+		if (params?.page) search.set("page", String(params.page));
+		if (params?.perPage) search.set("perPage", String(params.perPage));
+		const query = search.toString();
+		return this.http.get(`automations/${id}/enrollments${query ? `?${query}` : ""}`);
+	}
+	run(id, payload) {
+		return this.http.post(`automations/${id}/run`, payload);
+	}
+	retryEnrollment(id, enrollmentId) {
+		return this.http.post(`automations/${id}/enrollments/${enrollmentId}/retry`);
+	}
+	previewAudience(id) {
+		return this.http.get(`automations/${id}/audience-preview`);
+	}
+};
+//#endregion
 //#region src/resources/segments.ts
 var SegmentsResource = class {
 	constructor(http) {
@@ -2646,6 +2687,9 @@ var UpdatesResource = class {
 		if (params?.tags) query.set("tags", params.tags);
 		if (params?.with?.length) query.set("with", params.with.join(","));
 		if (params?.sort) query.set("sort", params.sort);
+		if (params?.limit != null) query.set("limit", String(params.limit));
+		if (params?.upcoming) query.set("filter[upcoming]", "1");
+		if (params?.past) query.set("filter[past]", "1");
 		const qs = query.toString();
 		return this.http.get(`updates${qs ? "?" + qs : ""}`);
 	}
@@ -3195,6 +3239,7 @@ var JoAiClient = class {
 		this.teams = new TeamsResource(this.http);
 		this.artifacts = new ArtifactsResource(this.http);
 		this.campaigns = new CampaignsResource(this.http);
+		this.automations = new AutomationsResource(this.http);
 		this.segments = new SegmentsResource(this.http);
 		this.updates = new UpdatesResource(this.http);
 		this.upgrades = new UpgradesResource(this.http);
@@ -3310,4 +3355,4 @@ var DistributionResource = class {
 	}
 };
 //#endregion
-export { AddressesResource, AgentsResource, AlertsResource, ApiTokensResource, AppointmentsResource, AuthResource, BillingResource, BlueprintsResource, CachedHttpService, CampaignsResource, CardsResource, CartsResource, ChangelogResource, CharactersResource, CheckoutResource, CommerceResource, ContactsResource, ContentResource, ContractsResource, DeskResource, DistributionResource, DocumentsResource, ElementsResource, EntitiesResource, FlowsResource, FulfillmentsResource, GoalsResource, HooksResource, IngestionsResource, InquiriesResource, IntegrationsResource, IntentsResource, ItemsResource, JoAiClient, KvResource, LinksResource, LoyaltyResource, McpResource, MeetingsResource, MemoriesResource, MessagesResource, MetricsResource, MissionsResource, NotificationsResource, OfficeResource, OrdersResource, PersonaResource, ProductsResource, ProjectsResource, RemindersResource, ReturnsResource, SegmentsResource, ServicesResource, ShippingResource, ShortcutsResource, SitesResource, SkillsResource, StatsResource, StoreResource, SubscriptionsResource, SwarmsResource, TagsResource, TasksResource, TeamsResource, UpdatesResource, UpgradesResource, UsersResource, VoiceResource, WalletsResource, WarpsResource, WorkspaceResource, completePortalSession, createClient, createGuestCommerceStorage, formatOpeningHours, getAuthFragmentToken, isAllowedRedirectUrl, isPortalCallbackUrl, openPortalSession, sanitizePortalCallbackUrl };
+export { AddressesResource, AgentsResource, AlertsResource, ApiTokensResource, AppointmentsResource, AuthResource, AutomationsResource, BillingResource, BlueprintsResource, CachedHttpService, CampaignsResource, CardsResource, CartsResource, ChangelogResource, CharactersResource, CheckoutResource, CommerceResource, ContactsResource, ContentResource, ContractsResource, DeskResource, DistributionResource, DocumentsResource, ElementsResource, EntitiesResource, FlowsResource, FulfillmentsResource, GoalsResource, HooksResource, IngestionsResource, InquiriesResource, IntegrationsResource, IntentsResource, ItemsResource, JoAiClient, KvResource, LinksResource, LoyaltyResource, McpResource, MeetingsResource, MemoriesResource, MessagesResource, MetricsResource, MissionsResource, NotificationsResource, OfficeResource, OrdersResource, PersonaResource, ProductsResource, ProjectsResource, RemindersResource, ReturnsResource, SegmentsResource, ServicesResource, ShippingResource, ShortcutsResource, SitesResource, SkillsResource, StatsResource, StoreResource, SubscriptionsResource, SwarmsResource, TagsResource, TasksResource, TeamsResource, UpdatesResource, UpgradesResource, UsersResource, VoiceResource, WalletsResource, WarpsResource, WorkspaceResource, completePortalSession, createClient, createGuestCommerceStorage, formatOpeningHours, getAuthFragmentToken, isAllowedRedirectUrl, isPortalCallbackUrl, openPortalSession, sanitizePortalCallbackUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joai/sdk",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "JoAi public API SDK — build with your AI agents",
   "license": "MIT",
   "type": "module",
@@ -38,7 +38,7 @@
     "@joai/warps": "*"
   },
   "devDependencies": {
-    "@joai/core": "^4.11.0",
+    "@joai/core": "^4.12.0",
     "tsdown": "^0.21.0",
     "typescript": "^5.9.3"
   }