@homespot-sdk/core 0.0.366 → 0.0.368

package/dist/rem/types.gen.d.ts

@@ -581,13 +581,17 @@ export type PublishSocialPostRequest = {
     channel: 'FACEBOOK' | 'INSTAGRAM';
     caption: string;
     /**
-     * Instagram only; defaults to LANDSCAPE
+     * PHOTOS (the default) or VIDEO: the property's video, which takes no photos and no ratio
+     */
+    media?: 'PHOTOS' | 'VIDEO';
+    /**
+     * Instagram photo posts only; defaults to LANDSCAPE
      */
     ratio?: 'LANDSCAPE' | 'SQUARE' | 'PORTRAIT';
     /**
-     * In post order
+     * In post order; none for a video post
      */
-    photos: Array<Photo>;
+    photos?: Array<Photo>;
 };
 export type FocusView = {
     x: number;
@@ -602,11 +606,15 @@ export type SocialPostView = {
     id: string;
     channel: 'FACEBOOK' | 'INSTAGRAM';
     status: 'PUBLISHING' | 'PUBLISHED' | 'FAILED' | 'REMOVED';
+    media: 'PHOTOS' | 'VIDEO';
     caption: string;
     /**
-     * Instagram only
+     * Instagram photo posts only
      */
     ratio?: 'LANDSCAPE' | 'SQUARE' | 'PORTRAIT';
+    /**
+     * Empty for a video post
+     */
     photos: Array<PhotoView>;
     failureReason?: 'RECONNECT_REQUIRED' | 'PERMISSION_MISSING' | 'PAGE_PUBLISHING_AUTHORIZATION' | 'RATE_LIMITED' | 'BAD_MEDIA' | 'UNCONFIRMED' | 'UNKNOWN';
     failureDetail?: string;
@@ -751,7 +759,7 @@ export type AdminCheckoutRequest = {
      * AI messages the agency shares each month; 0 means no AI
      */
     aiMessages: number;
-    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING'>;
+    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING' | 'UNBRANDED_POSTS'>;
     /**
      * Free-trial days; 0 charges immediately
      */
@@ -788,7 +796,7 @@ export type OrganizationSummaryViewResponse = {
     profilePictureUrl?: string;
     roleName: string;
     permissions: Array<'MANAGE_AGENCY' | 'MANAGE_ROLE' | 'MANAGE_MEMBER' | 'CREATE_DELETE_MEMBER' | 'CREATE_CONTACT' | 'DELETE_CONTACT' | 'MANAGE_CONTACT' | 'MANAGE_ANY_CONTACT' | 'ASSIGN_CONTACT' | 'MANAGE_BOARD' | 'MANAGE_DEAL' | 'DELETE_DEAL'>;
-    status: 'NEW' | 'ACTIVE' | 'PAYMENT_FAILED' | 'INACTIVE' | 'SUSPENDED';
+    status: 'NEW' | 'ACTIVE' | 'SUSPENDED';
     phone: string;
     isPhoneVerified: boolean;
     /**
@@ -1071,7 +1079,7 @@ export type SubscriptionResponse = {
      * AI messages the agency shares each month; 0 means no AI
      */
     aiMessages: number;
-    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING'>;
+    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING' | 'UNBRANDED_POSTS'>;
     trialDays: number;
     status: 'PENDING' | 'TRIALING' | 'ACTIVE' | 'PAST_DUE' | 'CANCELLED' | 'EXPIRED' | 'SUPERSEDED';
     /**
@@ -1127,7 +1135,7 @@ export type PlanResponse = {
     activeListings: Usage;
     aiMessages: AiMessages;
     boards: Usage;
-    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING'>;
+    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING' | 'UNBRANDED_POSTS'>;
 };
 export type Trial = {
     endsAt: Date;
@@ -1462,7 +1470,7 @@ export type PlanOffer = {
      * A month's AI messages, shared by the whole agency
      */
     aiMessages: number;
-    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING'>;
+    features: Array<'SOCIAL_POSTS' | 'AGENCY_BRANDING' | 'UNBRANDED_POSTS'>;
 };
 export type TrialOffer = {
     days: number;
@@ -1502,7 +1510,7 @@ export type AgencySummaryResponse = {
     subdomain: string;
     phone: string;
     establishedYear?: number;
-    status: 'NEW' | 'ACTIVE' | 'PAYMENT_FAILED' | 'INACTIVE' | 'SUSPENDED';
+    status: 'NEW' | 'ACTIVE' | 'SUSPENDED';
     logo?: string;
     theme?: number;
 };
@@ -1636,12 +1644,35 @@ export type PropertyPageResponse = {
     type: 'HOUSE' | 'TOWN_HOUSE' | 'COUNTRY_HOUSE' | 'VILLA' | 'COTTAGE' | 'APARTMENT' | 'DUPLEX' | 'TRIPLEX' | 'SEMI_BASEMENT' | 'ATTIC' | 'AGRICULTURAL_LAND' | 'RESIDENTIAL_LAND' | 'HOTEL_ROOM' | 'MOTEL_ROOM' | 'CO_LIVING_SPACE' | 'OFFICE' | 'COMMERCIAL_SPACE' | 'CO_WORKING_SPACE' | 'WAREHOUSE' | 'GARAGE';
     state: 'IN_REGISTRATION' | 'UNLISTED' | 'LISTED_INTERNALLY' | 'LISTED' | 'CLOSED';
     details?: PropertyDetailsResponse;
+    /**
+     * The property's video; null when it has none
+     */
+    video?: PropertyVideoResponse;
     agreement: AgreementResponse;
     listings: Array<PropertyListingResponse>;
     createdAt: Date;
     updatedAt: Date;
     closeReason?: PropertyCloseReasonResponse;
 };
+export type PropertyVideoResponse = {
+    /**
+     * An MP4 with its index first: a player can start before it has the file
+     */
+    url: string;
+    /**
+     * A JPEG frame from the video, to show before it plays
+     */
+    posterUrl: string;
+    durationMs: number;
+    /**
+     * As the video is shown, after the phone's rotation
+     */
+    width: number;
+    /**
+     * As the video is shown, after the phone's rotation
+     */
+    height: number;
+};
 export type SocialPostResponse = {
     /**
      * For retrying a failed post, or reading it in full
@@ -1649,12 +1680,13 @@ export type SocialPostResponse = {
     postId: string;
     channel: 'FACEBOOK' | 'INSTAGRAM';
     status: 'PUBLISHING' | 'PUBLISHED' | 'FAILED' | 'REMOVED';
+    media: 'PHOTOS' | 'VIDEO';
     /**
      * Exactly as published
      */
     caption: string;
     /**
-     * The post's first photo, as uploaded to the gallery (not the Instagram crop)
+     * The post's first photo, as uploaded to the gallery (not the Instagram crop), or the poster of its video
      */
     thumbnailUrl?: string;
     /**
@@ -1727,6 +1759,12 @@ export type ChannelReauthRequired = {
     displayName?: string;
     kind: 'CHANNEL_REAUTH_REQUIRED';
 };
+export type ChannelTakenOver = {
+    connectionId?: ConnectionId;
+    channelType?: 'FACEBOOK' | 'INSTAGRAM' | 'WHATSAPP' | 'TIKTOK';
+    displayName?: string;
+    kind: 'CHANNEL_TAKEN_OVER';
+};
 export type CommentId = {
     value?: string;
 };
@@ -1802,9 +1840,9 @@ export type NotificationFeed = {
 export type NotificationView = {
     id: string;
     seq: number;
-    type: 'AGENT_COMMENTED' | 'TASK_COMMENTED' | 'MEMBER_MENTIONED' | 'EXTERNAL_LISTING_EXPIRED' | 'LISTING_EXPIRED' | 'NEW_SEEKER_RATING' | 'NEW_MESSAGE' | 'CONTACT_ASSIGNED' | 'SUBSCRIPTION_PAYMENT_FAILED' | 'SUBSCRIPTION_ENDING' | 'SUBSCRIPTION_EXPIRED' | 'SUBSCRIPTION_PAYMENT_REVERSED' | 'TRIAL_ENDING' | 'TRIAL_ENDED' | 'DISCOUNT_ENDING' | 'AI_MESSAGES_RUNNING_LOW' | 'AI_MESSAGES_USED_UP' | 'CHANNEL_REAUTH_REQUIRED' | 'SOCIAL_POST_FAILED' | 'SOCIAL_POST_COMMENTED';
+    type: 'AGENT_COMMENTED' | 'TASK_COMMENTED' | 'MEMBER_MENTIONED' | 'EXTERNAL_LISTING_EXPIRED' | 'LISTING_EXPIRED' | 'NEW_SEEKER_RATING' | 'NEW_MESSAGE' | 'CONTACT_ASSIGNED' | 'SUBSCRIPTION_PAYMENT_FAILED' | 'SUBSCRIPTION_ENDING' | 'SUBSCRIPTION_EXPIRED' | 'SUBSCRIPTION_PAYMENT_REVERSED' | 'TRIAL_ENDING' | 'TRIAL_ENDED' | 'DISCOUNT_ENDING' | 'AI_MESSAGES_RUNNING_LOW' | 'AI_MESSAGES_USED_UP' | 'CHANNEL_REAUTH_REQUIRED' | 'CHANNEL_TAKEN_OVER' | 'SOCIAL_POST_FAILED' | 'SOCIAL_POST_COMMENTED';
     targetId?: string;
-    payload: AgentCommented | AiMessagesRunningLow | AiMessagesUsedUp | ChannelReauthRequired | ContactAssigned | DiscountEnding | ListingExpired | MemberMentioned | NewMessage | NewSeekerRating | SocialPostCommented | SocialPostFailed | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented | TrialEnded | TrialEnding;
+    payload: AgentCommented | AiMessagesRunningLow | AiMessagesUsedUp | ChannelReauthRequired | ChannelTakenOver | ContactAssigned | DiscountEnding | ListingExpired | MemberMentioned | NewMessage | NewSeekerRating | SocialPostCommented | SocialPostFailed | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented | TrialEnded | TrialEnding;
     /**
      * How many times this came while unread; the payload is the latest. For SOCIAL_POST_COMMENTED: the new comments on the post since its notification was last read. Starts again at 1 once read
      */
@@ -2138,7 +2176,7 @@ export type CursorPageMessageView = {
 export type ComposerLimits = {
     maxPhotos: number;
     /**
-     * In Unicode code points: an emoji counts once, as [...text].length counts in JavaScript (text.length counts it twice)
+     * Of the agent's text, with room left for the credit when there is one. In Unicode code points: an emoji counts once, as [...text].length counts in JavaScript (text.length counts it twice)
      */
     maxCaptionLength: number;
     /**
@@ -2172,6 +2210,10 @@ export type ComposerPreview = {
      * The agency's text for the property's group (HomeSpot's until it writes one), filled in from the listing; a line with a fact the listing lacks is left out
      */
     caption: string;
+    /**
+     * HomeSpot's line, which publishing adds under the text on a plan without UNBRANDED_POSTS (Free and Plus): show it under the text box, where the agent can't edit it, and don't send it with the caption. Null on a plan that can take it out (Pro): there it is in the caption, as text
+     */
+    credit?: string;
     /**
      * The property group whose template the caption came from: the one an Edit template opens
      */
@@ -2193,11 +2235,35 @@ export type ComposerPreview = {
      * The whole gallery, in gallery order
      */
     photos: Array<ComposerPhoto>;
+    /**
+     * The property's video, which a post may show instead of photos; null when it has none
+     */
+    video?: ComposerVideo;
     /**
      * Whether the agency can post to the channel now; publishing refuses anything but ALLOWED
      */
     access: 'ALLOWED' | 'NOT_CONNECTED' | 'RECONNECT_REQUIRED';
 };
+export type ComposerVideo = {
+    url: string;
+    /**
+     * A frame of the video: Instagram's cover for the Reel
+     */
+    posterUrl: string;
+    durationMs: number;
+    /**
+     * As the video is shown, in pixels
+     */
+    width: number;
+    /**
+     * As the video is shown, in pixels
+     */
+    height: number;
+    /**
+     * A copy that Instagram takes is being made to replace a 4K, slow-motion or very high-bitrate video, for a few minutes after the upload. Until it is done the video cannot be posted (409 video-processing); ask for the preview again to see when it is
+     */
+    transcoding: boolean;
+};
 export type LeftOutFact = {
     /**
      * As the template writes it, e.g. property.bedrooms
@@ -5279,7 +5345,7 @@ export type GetPublicAgencyData = {
     body?: never;
     path?: never;
     query?: {
-        status?: 'NEW' | 'ACTIVE' | 'PAYMENT_FAILED' | 'INACTIVE' | 'SUSPENDED';
+        status?: 'NEW' | 'ACTIVE' | 'SUSPENDED';
         /**
          * Zero-based page index (0..N)
          */