@homespot-sdk/core 0.0.359 → 0.0.361

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

@@ -322,7 +322,11 @@ export type OauthConnectionResponse = {
      */
     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
+     * Views and reach of a post. Facebook reports them only for Pages with 100 or more likes
+     */
+    canReadInsights: boolean;
+    /**
+     * The token is dead, or the grant lacks a scope the connect flow asks for (insights aside: without them canReadInsights is false and nothing else) — re-running the connect flow is what fixes it
      */
     reconnectRequired: boolean;
 };
@@ -478,6 +482,67 @@ export type SocialPostView = {
     createdBy: string;
     createdAt: Date;
 };
+export type MemberPeekResponse = {
+    memberId: string;
+    firstName: string;
+    lastName: string;
+    photo?: string;
+    phone?: string;
+    email: string;
+};
+export type SocialCommentAuthor = {
+    name?: string;
+    username?: string;
+};
+export type SocialCommentResponse = {
+    commentId: string;
+    /**
+     * Who wrote it, as far as Facebook / Instagram say; null on the agency's own comments, and when Meta does not say
+     */
+    author?: SocialCommentAuthor;
+    /**
+     * Null on a sticker or a photo on its own, and once the comment is REMOVED
+     */
+    text?: string;
+    /**
+     * When it was written; for a reply sent from HomeSpot, when it was sent
+     */
+    commentedAt: Date;
+    state: 'VISIBLE' | 'HIDDEN' | 'REMOVED';
+    /**
+     * Changed by its author after it was written
+     */
+    edited: boolean;
+    /**
+     * Written by the agency: shown as the agency's reply
+     */
+    own: boolean;
+    /**
+     * Own comments only
+     */
+    sentBy?: SocialCommentSender;
+    /**
+     * Own comments only: PENDING while HomeSpot gets it onto Facebook / Instagram, SENT once there, FAILED if Meta refused it
+     */
+    delivery?: 'PENDING' | 'SENT' | 'FAILED';
+    /**
+     * Why it FAILED; retrying sends it again as it is
+     */
+    failureReason?: 'COMMENT_DELETED' | 'RECONNECT_REQUIRED' | 'PERMISSION_MISSING' | 'RATE_LIMITED' | 'UNKNOWN';
+};
+export type SocialCommentSender = {
+    type: 'AGENT' | 'AI' | 'PAGE';
+    /**
+     * AGENT only; also once they have left the agency
+     */
+    member?: MemberPeekResponse;
+};
+export type ReplyToSocialCommentRequest = {
+    /**
+     * Posted exactly as written; how long it may be is the channel's rule
+     */
+    text: string;
+};
 export type CloseListingRequest = {
     withdrawExternal?: boolean;
 };
@@ -612,17 +677,13 @@ export type CommentView = {
     authorLastName: string;
     profilePictureUrl?: string;
     body: string;
+    mentionedMembers: Array<MemberPeekResponse>;
+    mentionedContacts: Array<ContactMentionView>;
     createdAt: Date;
     editedAt?: Date;
 };
-export type CursorPageCommentView = {
-    items?: Array<CommentView>;
-    nextCursor?: string;
-    hasNext?: boolean;
-};
-export type ContactLink = {
+export type ContactMentionView = {
     contactId: number;
-    primary: boolean;
     personalDetails: ContactPersonalDetailsRestricted | ContactPersonalDetailsVisible;
     contactAssignedTo?: string;
 };
@@ -637,6 +698,17 @@ export type ContactPersonalDetailsVisible = {
     email?: string;
     status: 'VISIBLE';
 };
+export type CursorPageCommentView = {
+    items?: Array<CommentView>;
+    nextCursor?: string;
+    hasNext?: boolean;
+};
+export type ContactLink = {
+    contactId: number;
+    primary: boolean;
+    personalDetails: ContactPersonalDetailsRestricted | ContactPersonalDetailsVisible;
+    contactAssignedTo?: string;
+};
 export type InterestLink = {
     interestId: number;
     contactId: number;
@@ -658,14 +730,6 @@ export type LocationResponse = {
     id: number;
     names: Array<LangTextResponse>;
 };
-export type MemberPeekResponse = {
-    memberId: string;
-    firstName: string;
-    lastName: string;
-    photo?: string;
-    phone?: string;
-    email: string;
-};
 export type Participant = {
     memberId: string;
     firstName: string;
@@ -736,37 +800,42 @@ export type TodoItem = {
     completedAt?: Date;
     completedBy?: string;
 };
-export type ContactTaskResponse = {
+export type ContactTaskCardResponse = {
     taskId: string;
-    title: string;
-    boardId: string;
-    boardName: string;
     stageId: string;
     stageName: string;
-    outcome?: 'WON' | 'LOST';
+    title: string;
+    hasDescription: boolean;
+    commentCount: number;
+    contactCount: number;
+    priority: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
     value?: number;
+    commissionType?: 'NOT_SET' | 'FIXED' | 'PERCENTAGE' | 'MONTHS_OF_RENT';
+    commissionValue?: number;
+    ownerId?: string;
+    primaryContactId?: number;
+    primaryContact?: ContactPersonalDetailsRestricted | ContactPersonalDetailsVisible;
+    contactAssignedTo?: string;
+    primaryContent?: TaskContentInterest | TaskContentProperty;
+    participants: Array<string>;
+    rank: string;
+    stageEnteredAt: Date;
+    daysInStage: number;
+    openTodos: number;
+    totalTodos: number;
+    hasLeftoverOpenTodos: boolean;
+    expectedCloseDate?: Date;
+    outcome?: 'WON' | 'LOST';
+    lostReason?: 'NOT_WORKING_WITH_AGENTS' | 'NOT_RESPONDING' | 'ALREADY_SOLD' | 'COULD_NOT_NEGOTIATE_PRICE' | 'CHOSE_ANOTHER_AGENCY' | 'CHANGED_PLANS' | 'OUT_OF_BUDGET' | 'SPAM' | 'OTHER';
+    closedAt?: Date;
+    boardId: string;
+    boardName: string;
+    stageColor: string;
     primary: boolean;
 };
-export type BoardCardsResponse = {
-    boardId: string;
-    name: string;
-    kind?: 'OWNER' | 'SEEKER';
+export type ContactTasksResponse = {
     members: Array<MemberPeekResponse>;
-    columns: Array<Column>;
-};
-export type Column = {
-    stageId: string;
-    name: string;
-    color: string;
-    position: number;
-    totalTasks: number;
-    totalValue: number;
-    cards: CursorPageTaskCardResponse;
-};
-export type CursorPageTaskCardResponse = {
-    items?: Array<TaskCardResponse>;
-    nextCursor?: string;
-    hasNext?: boolean;
+    items: Array<ContactTaskCardResponse>;
 };
 export type TaskCardResponse = {
     taskId: string;
@@ -813,6 +882,27 @@ export type TaskContentProperty = Omit<TaskContent, 'type'> & {
     title?: string;
     type: 'PROPERTY';
 };
+export type BoardCardsResponse = {
+    boardId: string;
+    name: string;
+    kind?: 'OWNER' | 'SEEKER';
+    members: Array<MemberPeekResponse>;
+    columns: Array<Column>;
+};
+export type Column = {
+    stageId: string;
+    name: string;
+    color: string;
+    position: number;
+    totalTasks: number;
+    totalValue: number;
+    cards: CursorPageTaskCardResponse;
+};
+export type CursorPageTaskCardResponse = {
+    items?: Array<TaskCardResponse>;
+    nextCursor?: string;
+    hasNext?: boolean;
+};
 export type StageCardsResponse = {
     members: Array<MemberPeekResponse>;
     data: CursorPageTaskCardResponse;
@@ -1187,6 +1277,10 @@ export type PropertyListingResponse = {
      * Facebook / Instagram posts of this listing, newest first
      */
     socialPosts: Array<SocialPostResponse>;
+    /**
+     * Comment threads waiting for an answer from the agency, across the listing's posts
+     */
+    unansweredComments: number;
     createdAt: Date;
     closedAt?: Date;
 };
@@ -1232,16 +1326,34 @@ export type SocialPostResponse = {
     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
+     * The post's numbers as last read from Facebook / Instagram; null until the first read
      */
     stats?: SocialPostStats;
+    /**
+     * Comment threads under the post waiting for an answer from the agency; 0 unless PUBLISHED
+     */
+    unansweredComments: number;
 };
 export type SocialPostStats = {
-    likes: number;
-    comments: number;
-    shares: number;
     /**
-     * When the counts were read — show how old they are
+     * On Facebook all reactions, as Facebook shows them under the post
+     */
+    likes?: number;
+    /**
+     * Replies included
+     */
+    comments?: number;
+    shares?: number;
+    /**
+     * How many times the post was seen
+     */
+    views?: number;
+    /**
+     * How many people saw the post
+     */
+    reach?: number;
+    /**
+     * When the numbers were read — show how old they are. Likes and comments are read every 15 minutes on the post's first day, then less often; Meta updates views and reach about once a day
      */
     fetchedAt: Date;
 };
@@ -1298,6 +1410,15 @@ export type ListingExpired = {
 export type MemberId = {
     value?: string;
 };
+export type MemberMentioned = {
+    commentId?: CommentId;
+    contactId?: ContactId;
+    taskId?: TaskId;
+    authorId?: MemberId;
+    author?: string;
+    commentSnippet?: string;
+    kind: 'MEMBER_MENTIONED';
+};
 export type NewMessage = {
     contactId?: ContactId;
     conversationId?: ConversationId;
@@ -1324,15 +1445,34 @@ 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' | 'CHANNEL_REAUTH_REQUIRED' | 'SOCIAL_POST_FAILED';
+    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' | 'CHANNEL_REAUTH_REQUIRED' | 'SOCIAL_POST_FAILED' | 'SOCIAL_POST_COMMENTED';
     targetId?: string;
-    payload: AgentCommented | ChannelReauthRequired | ContactAssigned | ListingExpired | NewMessage | NewSeekerRating | SocialPostFailed | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented;
+    payload: AgentCommented | ChannelReauthRequired | ContactAssigned | ListingExpired | MemberMentioned | NewMessage | NewSeekerRating | SocialPostCommented | SocialPostFailed | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented;
+    /**
+     * 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
+     */
+    count: number;
     createdAt: Date;
     read: boolean;
 };
 export type PropertyId = {
     value?: number;
 };
+export type SocialCommentId = {
+    value?: string;
+};
+export type SocialPostCommented = {
+    postId?: SocialPostId;
+    commentId?: SocialCommentId;
+    contactId?: ContactId;
+    propertyId?: PropertyId;
+    listingId?: number;
+    propertyTitle?: string;
+    channel?: 'FACEBOOK' | 'INSTAGRAM';
+    author?: string;
+    commentSnippet?: string;
+    kind: 'SOCIAL_POST_COMMENTED';
+};
 export type SocialPostFailed = {
     postId?: SocialPostId;
     contactId?: ContactId;
@@ -1679,6 +1819,39 @@ export type ComposerPreview = {
      */
     access: 'ALLOWED' | 'NOT_CONNECTED' | 'RECONNECT_REQUIRED';
 };
+export type CursorPageSocialCommentThreadResponse = {
+    items?: Array<SocialCommentThreadResponse>;
+    nextCursor?: string;
+    hasNext?: boolean;
+};
+export type SocialCommentPost = {
+    postId: string;
+    channel: 'FACEBOOK' | 'INSTAGRAM';
+    /**
+     * PUBLISHED, or REMOVED once gone from Facebook / Instagram: its comments stay, and can no longer be answered
+     */
+    status: 'PUBLISHING' | 'PUBLISHED' | 'FAILED' | 'REMOVED';
+    permalink: string;
+    publishedAt: Date;
+};
+export type SocialCommentThreadResponse = {
+    /**
+     * The post the thread is under
+     */
+    post: SocialCommentPost;
+    /**
+     * The comment that started the thread
+     */
+    comment: SocialCommentResponse;
+    /**
+     * Oldest first, one level deep as Facebook and Instagram show it: a reply to a reply is listed here too
+     */
+    replies: Array<SocialCommentResponse>;
+    /**
+     * False while the thread's latest comment from someone else has no reply from the agency after it. Hidden and removed comments need no answer, and a FAILED reply is none
+     */
+    answered: boolean;
+};
 export type ContactGridResponse = {
     id: number;
     createdBy?: string;
@@ -1719,7 +1892,7 @@ export type Client360Response = {
     updatedAt: Date;
     interests: Array<ContactInterestResponse>;
     properties: Array<ContactPropertyResponse>;
-    tasks: Array<ContactTaskResponse>;
+    tasks: ContactTasksResponse;
 };
 export type CommunicationPreferenceResponse = {
     preferredContactMethod?: 'WHATSAPP' | 'VIBER' | 'PHONE_CALL';
@@ -3692,6 +3865,42 @@ export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSoci
     202: SocialPostView;
 };
 export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponse = PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponses[keyof PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsByPostIdRetryResponses];
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRetryData = {
+    body?: never;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+        commentId: string;
+    };
+    query?: never;
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-comments/{commentId}/retry';
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRetryResponses = {
+    /**
+     * Accepted
+     */
+    202: SocialCommentResponse;
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRetryResponse = PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRetryResponses[keyof PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRetryResponses];
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRepliesData = {
+    body: ReplyToSocialCommentRequest;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+        commentId: string;
+    };
+    query?: never;
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-comments/{commentId}/replies';
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRepliesResponses = {
+    /**
+     * Accepted
+     */
+    202: SocialCommentResponse;
+};
+export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRepliesResponse = PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRepliesResponses[keyof PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsByCommentIdRepliesResponses];
 export type PostContactsByContactIdPropertiesByPropertyIdListingsByListingIdResumeData = {
     body?: never;
     path: {
@@ -4140,7 +4349,7 @@ export type GetTaskByContactByContactIdResponses = {
     /**
      * OK
      */
-    200: Array<ContactTaskResponse>;
+    200: ContactTasksResponse;
 };
 export type GetTaskByContactByContactIdResponse = GetTaskByContactByContactIdResponses[keyof GetTaskByContactByContactIdResponses];
 export type GetTaskBoardByBoardIdData = {
@@ -5006,6 +5215,28 @@ export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocia
     200: ComposerPreview;
 };
 export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponse = GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponses[keyof GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialPostsPreviewResponses];
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsData = {
+    body?: never;
+    path: {
+        contactId: number;
+        propertyId: number;
+        listingId: number;
+    };
+    query?: {
+        postId?: string;
+        channel?: 'FACEBOOK' | 'INSTAGRAM';
+        cursor?: string;
+        limit?: number;
+    };
+    url: '/contacts/{contactId}/properties/{propertyId}/listings/{listingId}/social-comments';
+};
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsResponses = {
+    /**
+     * OK
+     */
+    200: CursorPageSocialCommentThreadResponse;
+};
+export type GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsResponse = GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsResponses[keyof GetContactsByContactIdPropertiesByPropertyIdListingsByListingIdSocialCommentsResponses];
 export type GetContactsByContactIdInterestsByInterestIdRecommendationsDecisionsData = {
     body?: never;
     path: {
@@ -5126,6 +5357,22 @@ export type GetContactGroupsResponses = {
     200: Array<GroupCount>;
 };
 export type GetContactGroupsResponse = GetContactGroupsResponses[keyof GetContactGroupsResponses];
+export type GetCommentsMentionsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        cursor?: string;
+        limit?: number;
+    };
+    url: '/comments/mentions';
+};
+export type GetCommentsMentionsResponses = {
+    /**
+     * OK
+     */
+    200: CursorPageCommentView;
+};
+export type GetCommentsMentionsResponse = GetCommentsMentionsResponses[keyof GetCommentsMentionsResponses];
 export type DeleteBoardByBoardIdData = {
     body?: never;
     path: {