@opens/gateways 1.15.0 → 1.15.1

package/dist/customer-service/contracts/index.d.mts

@@ -103,6 +103,22 @@ interface AnnouncementButton {
     /** Whether the URL should open in a new browser tab. */
     new_tab: boolean;
 }
+/** Appearance configuration for an announcement. */
+interface AnnouncementAppearance {
+    /**
+     * Target DOM selector where the announcement should be anchored.
+     * Defaults to '#announcements' if omitted.
+     */
+    targetElement?: string;
+    /**
+     * Position of the announcement inside the target element.
+     * - 'top': rendered inside the target element at the very top (prepended).
+     * - 'bottom': rendered inside the target element at the bottom (appended).
+     * Note: The announcement is always rendered INSIDE the target element, not outside.
+     * Defaults to 'top'.
+     */
+    position?: 'top' | 'bottom';
+}
 /** Payload rendered by the announcement widget. */
 interface AnnouncementPayload {
     /** Main announcement message. */
@@ -111,6 +127,8 @@ interface AnnouncementPayload {
     visual_status: AnnouncementVisualStatus;
     /** Optional action buttons (up to 3). */
     buttons?: AnnouncementButton[];
+    /** Optional appearance configuration for DOM anchoring. */
+    appearance?: AnnouncementAppearance;
 }
 /** URL targeting rule for an announcement. */
 interface AnnouncementTargetingRuleUrl {
@@ -244,11 +262,10 @@ interface UpdateAnnouncementStatusRequest {
 }
 /** Query parameters for the active announcements widget endpoint. */
 interface ActiveAnnouncementQuery {
-    /** Widget context (e.g. current page URL). */
-    environment?: {
-        /** Current page URL used for URL targeting rules. */
-        url?: string;
-    };
+    /** Current page URL used for URL targeting rules. */
+    url?: string;
+    /** User profile slug used for profile targeting rules. */
+    profile?: string;
 }
 /** Slim announcement payload returned by the active endpoint (widget). */
 interface ActiveAnnouncement {
@@ -260,4 +277,4 @@ interface ActiveAnnouncement {
     payload: AnnouncementPayload;
 }
 
-export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
+export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };

package/dist/customer-service/contracts/index.d.ts

@@ -103,6 +103,22 @@ interface AnnouncementButton {
     /** Whether the URL should open in a new browser tab. */
     new_tab: boolean;
 }
+/** Appearance configuration for an announcement. */
+interface AnnouncementAppearance {
+    /**
+     * Target DOM selector where the announcement should be anchored.
+     * Defaults to '#announcements' if omitted.
+     */
+    targetElement?: string;
+    /**
+     * Position of the announcement inside the target element.
+     * - 'top': rendered inside the target element at the very top (prepended).
+     * - 'bottom': rendered inside the target element at the bottom (appended).
+     * Note: The announcement is always rendered INSIDE the target element, not outside.
+     * Defaults to 'top'.
+     */
+    position?: 'top' | 'bottom';
+}
 /** Payload rendered by the announcement widget. */
 interface AnnouncementPayload {
     /** Main announcement message. */
@@ -111,6 +127,8 @@ interface AnnouncementPayload {
     visual_status: AnnouncementVisualStatus;
     /** Optional action buttons (up to 3). */
     buttons?: AnnouncementButton[];
+    /** Optional appearance configuration for DOM anchoring. */
+    appearance?: AnnouncementAppearance;
 }
 /** URL targeting rule for an announcement. */
 interface AnnouncementTargetingRuleUrl {
@@ -244,11 +262,10 @@ interface UpdateAnnouncementStatusRequest {
 }
 /** Query parameters for the active announcements widget endpoint. */
 interface ActiveAnnouncementQuery {
-    /** Widget context (e.g. current page URL). */
-    environment?: {
-        /** Current page URL used for URL targeting rules. */
-        url?: string;
-    };
+    /** Current page URL used for URL targeting rules. */
+    url?: string;
+    /** User profile slug used for profile targeting rules. */
+    profile?: string;
 }
 /** Slim announcement payload returned by the active endpoint (widget). */
 interface ActiveAnnouncement {
@@ -260,4 +277,4 @@ interface ActiveAnnouncement {
     payload: AnnouncementPayload;
 }
 
-export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
+export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
-export { AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
+export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
 import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
 export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
 import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.mjs';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
-export { AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
+export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
 import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
 export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
 import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.js';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.15.0",
+  "version": "1.15.1",
   "description": "A simple package to help with some common tasks",
   "name": "@opens/gateways",
   "private": false,
@@ -59,4 +59,4 @@
   "dependencies": {
     "axios": "^1.18.0"
   }
-}
+}