@homespot-sdk/core 0.0.358 → 0.0.359

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

@@ -314,6 +314,17 @@ export type OauthConnectionResponse = {
     createdAt: Date;
     updatedAt: Date;
     revokedAt?: Date;
+    canPublish: boolean;
+    canReadComments: boolean;
+    canReply: boolean;
+    /**
+     * Like and comment counts on a post
+     */
+    canReadStats: boolean;
+    /**
+     * The token is dead, or the grant lacks a scope the connect flow asks for — re-running the connect flow is what fixes it
+     */
+    reconnectRequired: boolean;
 };
 export type AttendeeRequest = {
     role: 'ORGANIZER' | 'MEMBER' | 'OWNER' | 'CLIENT' | 'OTHER';
@@ -415,6 +426,58 @@ export type Percentage = Omit<AddDealRequest, 'type'> & {
     commission?: number;
     type: 'PERCENTAGE';
 };
+export type FocusRequest = {
+    x: number;
+    y: number;
+};
+export type Photo = {
+    photoId: number;
+    mode?: 'AUTO' | 'CROP' | 'FIT';
+    focus?: FocusRequest;
+};
+export type PublishSocialPostRequest = {
+    channel: 'FACEBOOK' | 'INSTAGRAM';
+    caption: string;
+    /**
+     * Instagram only; defaults to LANDSCAPE
+     */
+    ratio?: 'LANDSCAPE' | 'SQUARE' | 'PORTRAIT';
+    /**
+     * In post order
+     */
+    photos: Array<Photo>;
+    templateId?: string;
+};
+export type FocusView = {
+    x: number;
+    y: number;
+};
+export type PhotoView = {
+    photoId: number;
+    mode: 'AUTO' | 'CROP' | 'FIT';
+    focus: FocusView;
+};
+export type SocialPostView = {
+    id: string;
+    channel: 'FACEBOOK' | 'INSTAGRAM';
+    status: 'PUBLISHING' | 'PUBLISHED' | 'FAILED' | 'REMOVED';
+    caption: string;
+    /**
+     * Instagram only
+     */
+    ratio?: 'LANDSCAPE' | 'SQUARE' | 'PORTRAIT';
+    photos: Array<PhotoView>;
+    templateId?: string;
+    failureReason?: 'RECONNECT_REQUIRED' | 'PERMISSION_MISSING' | 'PAGE_PUBLISHING_AUTHORIZATION' | 'RATE_LIMITED' | 'BAD_MEDIA' | 'UNCONFIRMED' | 'UNKNOWN';
+    failureDetail?: string;
+    /**
+     * The post on Facebook / Instagram, once published
+     */
+    permalink?: string;
+    publishedAt?: Date;
+    createdBy: string;
+    createdAt: Date;
+};
 export type CloseListingRequest = {
     withdrawExternal?: boolean;
 };
@@ -435,6 +498,10 @@ export type OnboardClientRequest = {
 export type IdResponseLong = {
     id: number;
 };
+export type ExternalListingWithdrawRequest = {
+    platform: 'SS' | 'MY_HOME';
+    listingId: number;
+};
 export type ExternalListingPublishRequest = {
     platform: 'SS' | 'MY_HOME';
     listingId: number;
@@ -1082,10 +1149,11 @@ export type DealResponse = {
 export type PlatformListingResponse = {
     platformId?: number;
     platformType: 'SS' | 'MY_HOME';
-    status: 'PENDING' | 'SYNDICATED' | 'FAILED' | 'EXPIRED';
+    status: 'PENDING' | 'SYNDICATED' | 'FAILED' | 'EXPIRED' | 'WITHDRAWING' | 'WITHDRAWN';
     listedAt?: Date;
     expiresAt?: Date;
     renewedAt?: Date;
+    failureReason?: string;
     boost?: BoostResponse;
     coloredListing?: ColoredListingResponse;
 };
@@ -1109,12 +1177,16 @@ export type PropertyListingResponse = {
     marketplaceStatus: 'ACTIVE' | 'PAUSED' | 'EXPIRED';
     crmState: 'OPEN' | 'CLOSED';
     /**
-     * True while an external-portal placement or boost is in flight — poll the property page until false. Creating the Homespot listing itself is synchronous, so it never sets this.
+     * True while an external-portal placement, a boost or a social post is in flight — poll the property page until false. Creating the Homespot listing itself is synchronous, so it never sets this.
      */
     isProcessing: boolean;
     price: number;
     deal?: Fixed | MonthsOfRent | Percentage;
     platformListings: Array<PlatformListingResponse>;
+    /**
+     * Facebook / Instagram posts of this listing, newest first
+     */
+    socialPosts: Array<SocialPostResponse>;
     createdAt: Date;
     closedAt?: Date;
 };
@@ -1134,6 +1206,45 @@ export type PropertyPageResponse = {
     updatedAt: Date;
     closeReason?: PropertyCloseReasonResponse;
 };
+export type SocialPostResponse = {
+    /**
+     * For retrying a failed post, or reading it in full
+     */
+    postId: string;
+    channel: 'FACEBOOK' | 'INSTAGRAM';
+    status: 'PUBLISHING' | 'PUBLISHED' | 'FAILED' | 'REMOVED';
+    /**
+     * Exactly as published
+     */
+    caption: string;
+    /**
+     * The post's first photo, as uploaded to the gallery (not the Instagram crop)
+     */
+    thumbnailUrl?: string;
+    /**
+     * The post on Facebook / Instagram, once published
+     */
+    permalink?: string;
+    publishedAt?: Date;
+    /**
+     * The member who created the post, also after they left the agency
+     */
+    createdBy: MemberPeekResponse;
+    failureReason?: 'RECONNECT_REQUIRED' | 'PERMISSION_MISSING' | 'PAGE_PUBLISHING_AUTHORIZATION' | 'RATE_LIMITED' | 'BAD_MEDIA' | 'UNCONFIRMED' | 'UNKNOWN';
+    /**
+     * The post's public counts as last read from Facebook / Instagram; null until the first read
+     */
+    stats?: SocialPostStats;
+};
+export type SocialPostStats = {
+    likes: number;
+    comments: number;
+    shares: number;
+    /**
+     * When the counts were read — show how old they are
+     */
+    fetchedAt: Date;
+};
 export type ListingOwnerContactResponse = {
     contactId: number;
     personalDetails: ContactPersonalDetailsRestricted | ContactPersonalDetailsVisible;
@@ -1146,9 +1257,18 @@ export type AgentCommented = {
     commentSnippet?: string;
     kind: 'AGENT_COMMENTED';
 };
+export type ChannelReauthRequired = {
+    connectionId?: ConnectionId;
+    channelType?: 'FACEBOOK' | 'INSTAGRAM' | 'WHATSAPP' | 'TIKTOK';
+    displayName?: string;
+    kind: 'CHANNEL_REAUTH_REQUIRED';
+};
 export type CommentId = {
     value?: string;
 };
+export type ConnectionId = {
+    value?: string;
+};
 export type ContactAssigned = {
     contactId?: ContactId;
     contactName?: string;
@@ -1204,15 +1324,28 @@ export type NotificationFeed = {
 export type NotificationView = {
     id: string;
     seq: number;
-    type: 'AGENT_COMMENTED' | 'TASK_COMMENTED' | 'EXTERNAL_LISTING_EXPIRED' | 'LISTING_EXPIRED' | 'NEW_SEEKER_RATING' | 'NEW_MESSAGE' | 'CONTACT_ASSIGNED' | 'SUBSCRIPTION_PAYMENT_FAILED' | 'SUBSCRIPTION_ENDING' | 'SUBSCRIPTION_EXPIRED' | 'SUBSCRIPTION_PAYMENT_REVERSED';
+    type: 'AGENT_COMMENTED' | 'TASK_COMMENTED' | 'EXTERNAL_LISTING_EXPIRED' | 'LISTING_EXPIRED' | 'NEW_SEEKER_RATING' | 'NEW_MESSAGE' | 'CONTACT_ASSIGNED' | 'SUBSCRIPTION_PAYMENT_FAILED' | 'SUBSCRIPTION_ENDING' | 'SUBSCRIPTION_EXPIRED' | 'SUBSCRIPTION_PAYMENT_REVERSED' | 'CHANNEL_REAUTH_REQUIRED' | 'SOCIAL_POST_FAILED';
     targetId?: string;
-    payload: AgentCommented | ContactAssigned | ListingExpired | NewMessage | NewSeekerRating | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented;
+    payload: AgentCommented | ChannelReauthRequired | ContactAssigned | ListingExpired | NewMessage | NewSeekerRating | SocialPostFailed | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented;
     createdAt: Date;
     read: boolean;
 };
 export type PropertyId = {
     value?: number;
 };
+export type SocialPostFailed = {
+    postId?: SocialPostId;
+    contactId?: ContactId;
+    propertyId?: PropertyId;
+    listingId?: number;
+    propertyTitle?: string;
+    channel?: 'FACEBOOK' | 'INSTAGRAM';
+    reason?: 'RECONNECT_REQUIRED' | 'PERMISSION_MISSING' | 'PAGE_PUBLISHING_AUTHORIZATION' | 'RATE_LIMITED' | 'BAD_MEDIA' | 'UNCONFIRMED' | 'UNKNOWN';
+    kind: 'SOCIAL_POST_FAILED';
+};
+export type SocialPostId = {
+    value?: string;
+};
 export type SubscriptionEnding = {
     subscriptionId?: SubscriptionId;
     status?: 'PENDING' | 'TRIALING' | 'ACTIVE' | 'PAST_DUE' | 'CANCELLED' | 'EXPIRED' | 'SUPERSEDED';
@@ -1346,6 +1479,10 @@ export type ListingGridResponse = {
     commissionType?: 'NOT_SET' | 'FIXED' | 'PERCENTAGE' | 'MONTHS_OF_RENT';
     commission?: number;
     platforms: Array<PlatformView>;
+    /**
+     * Where the listing is posted on Facebook / Instagram: the latest published post per channel
+     */
+    socialPosts: Array<SocialPostLink>;
     createdAt: Date;
     updatedAt: Date;
 };
@@ -1360,6 +1497,13 @@ export type PlatformView = {
     tier?: 'VIP' | 'VIP_PLUS' | 'SUPER_VIP';
     boostExpiresAt?: Date;
 };
+export type SocialPostLink = {
+    channel: 'FACEBOOK' | 'INSTAGRAM';
+    /**
+     * Opens the post on Facebook / Instagram
+     */
+    permalink: string;
+};
 export type GroupCount = {
     groupKey: string;
     label: string;
@@ -1484,6 +1628,57 @@ export type CursorPageMessageView = {
     nextCursor?: string;
     hasNext?: boolean;
 };
+export type ComposerLimits = {
+    maxPhotos: number;
+    /**
+     * In Unicode code points: an emoji counts once, as [...text].length counts in JavaScript (text.length counts it twice)
+     */
+    maxCaptionLength: number;
+};
+export type ComposerPhoto = {
+    /**
+     * What the publish request sends
+     */
+    photoId: number;
+    url: string;
+    /**
+     * As the photo is shown, in pixels
+     */
+    width: number;
+    /**
+     * As the photo is shown, in pixels
+     */
+    height: number;
+    selectedByDefault: boolean;
+};
+export type ComposerPreview = {
+    channel: 'FACEBOOK' | 'INSTAGRAM';
+    /**
+     * The built-in Georgian template filled in from the listing; a line with nothing to fill it is left out
+     */
+    caption: string;
+    /**
+     * The template the text came from, sent back on publish; null for the built-in one
+     */
+    templateId?: string;
+    limits: ComposerLimits;
+    /**
+     * The shapes the agent can pick; empty on Facebook, which keeps each photo's own
+     */
+    ratios: Array<'LANDSCAPE' | 'SQUARE' | 'PORTRAIT'>;
+    /**
+     * Instagram only
+     */
+    defaultRatio?: 'LANDSCAPE' | 'SQUARE' | 'PORTRAIT';
+    /**
+     * The whole gallery, in gallery order
+     */
+    photos: Array<ComposerPhoto>;
+    /**
+     * Whether the agency can post to the channel now; publishing refuses anything but ALLOWED
+     */
+    access: 'ALLOWED' | 'NOT_CONNECTED' | 'RECONNECT_REQUIRED';
+};
 export type ContactGridResponse = {
     id: number;
     createdBy?: string;
@@ -3462,6 +3657,41 @@ export type PostContactsByContactIdPropertiesByPropertyIdListingsResponses = {
     201: IdResponseUuid;
 };
 export type PostContactsByContactIdPropertiesByPropertyIdListingsResponse = PostContactsByContactIdPropertiesByPropertyIdListingsResponses[keyof PostContactsByContactIdPropertiesByPropertyIdListingsResponses];
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsData = {
+    body: PublishSocialPostRequest;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+    };
+    query?: never;
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-posts';
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsResponses = {
+    /**
+     * Accepted
+     */
+    202: SocialPostView;
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsResponse = PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsResponses[keyof PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsResponses];
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryData = {
+    body?: never;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+        postId: string;
+    };
+    query?: never;
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-posts/{postId}/retry';
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponses = {
+    /**
+     * Accepted
+     */
+    202: SocialPostView;
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponse = PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponses[keyof PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponses];
 export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdResumeData = {
     body?: never;
     path: {
@@ -3712,6 +3942,21 @@ export type PostContactResponses = {
     201: IdResponseLong;
 };
 export type PostContactResponse = PostContactResponses[keyof PostContactResponses];
+export type PostContactByContactIdPropertyByPropertyIdExternalListingWithdrawData = {
+    body: ExternalListingWithdrawRequest;
+    path: {
+        contactId: number;
+        propertyId: number;
+    };
+    query?: never;
+    url: '/contact/{contactId}/property/{propertyId}/external-listing/withdraw';
+};
+export type PostContactByContactIdPropertyByPropertyIdExternalListingWithdrawResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
 export type PostContactByContactIdPropertyByPropertyIdExternalListingPublishData = {
     body: ExternalListingPublishRequest;
     path: {
@@ -4472,6 +4717,7 @@ export type GetListingData = {
         platforms?: Array<'SS' | 'MY_HOME'>;
         platformExpiresFrom?: Date;
         platformExpiresTo?: Date;
+        socialChannels?: Array<'FACEBOOK' | 'INSTAGRAM'>;
         boostTiers?: Array<string>;
         boostExpiresFrom?: Date;
         boostExpiresTo?: Date;
@@ -4538,6 +4784,7 @@ export type GetListingGroupsData = {
         platforms?: Array<'SS' | 'MY_HOME'>;
         platformExpiresFrom?: Date;
         platformExpiresTo?: Date;
+        socialChannels?: Array<'FACEBOOK' | 'INSTAGRAM'>;
         boostTiers?: Array<string>;
         boostExpiresFrom?: Date;
         boostExpiresTo?: Date;
@@ -4722,6 +4969,43 @@ export type GetConversationsByConversationIdUpdatesResponses = {
     200: ThreadUpdates;
 };
 export type GetConversationsByConversationIdUpdatesResponse = GetConversationsByConversationIdUpdatesResponses[keyof GetConversationsByConversationIdUpdatesResponses];
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdData = {
+    body?: never;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+        postId: string;
+    };
+    query?: never;
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-posts/{postId}';
+};
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdResponses = {
+    /**
+     * OK
+     */
+    200: SocialPostView;
+};
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdResponse = GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdResponses[keyof GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdResponses];
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewData = {
+    body?: never;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+    };
+    query: {
+        channel: 'FACEBOOK' | 'INSTAGRAM';
+    };
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-posts/preview';
+};
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponses = {
+    /**
+     * OK
+     */
+    200: ComposerPreview;
+};
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponse = GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponses[keyof GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponses];
 export type GetContactsByContactIdInterestsByInterestIdRecommendationsDecisionsData = {
     body?: never;
     path: {