@homespot-sdk/core 0.0.360 → 0.0.362

package/dist/rem/schemas.gen.js

@@ -1170,15 +1170,20 @@ export const OauthConnectionResponseSchema = {
             type: 'boolean',
             description: 'Like and comment counts on a post',
         },
+        canReadInsights: {
+            type: 'boolean',
+            description: 'Views and reach of a post. Facebook reports them only for Pages with 100 or more likes',
+        },
         reconnectRequired: {
             type: 'boolean',
-            description: 'The token is dead, or the grant lacks a scope the connect flow asks for — re-running the connect flow is what fixes it',
+            description: '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',
         },
     },
     required: [
         'agencyId',
         'canPublish',
         'canReadComments',
+        'canReadInsights',
         'canReadStats',
         'canReply',
         'createdAt',
@@ -1788,6 +1793,127 @@ export const SocialPostViewSchema = {
         'status',
     ],
 };
+export const MemberPeekResponseSchema = {
+    type: 'object',
+    properties: {
+        memberId: {
+            type: 'string',
+            format: 'uuid',
+        },
+        firstName: {
+            type: 'string',
+        },
+        lastName: {
+            type: 'string',
+        },
+        photo: {
+            type: 'string',
+        },
+        phone: {
+            type: 'string',
+        },
+        email: {
+            type: 'string',
+        },
+    },
+    required: ['email', 'firstName', 'lastName', 'memberId'],
+};
+export const SocialCommentAuthorSchema = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string',
+        },
+        username: {
+            type: 'string',
+        },
+    },
+};
+export const SocialCommentResponseSchema = {
+    type: 'object',
+    properties: {
+        commentId: {
+            type: 'string',
+            format: 'uuid',
+        },
+        parentCommentId: {
+            type: 'string',
+            format: 'uuid',
+            description: "The comment it is shown under: the thread's first comment, or on Facebook's third level the second-level reply it sits under — Facebook goes no deeper, and Instagram shows one level of replies. Null on a thread's first comment",
+        },
+        author: {
+            $ref: '#/components/schemas/SocialCommentAuthor',
+            description: "Who wrote it, as far as Facebook / Instagram say; null on the agency's own comments, and when Meta does not say",
+        },
+        text: {
+            type: 'string',
+            description: 'Null on a sticker or a photo on its own, and once the comment is REMOVED',
+        },
+        commentedAt: {
+            type: 'string',
+            format: 'date-time',
+            description: 'When it was written; for a reply sent from HomeSpot, when it was sent',
+        },
+        state: {
+            type: 'string',
+            enum: ['VISIBLE', 'HIDDEN', 'REMOVED'],
+        },
+        edited: {
+            type: 'boolean',
+            description: 'Changed by its author after it was written',
+        },
+        own: {
+            type: 'boolean',
+            description: "Written by the agency: shown as the agency's reply",
+        },
+        sentBy: {
+            $ref: '#/components/schemas/SocialCommentSender',
+            description: 'Own comments only',
+        },
+        delivery: {
+            type: 'string',
+            description: 'Own comments only: PENDING while HomeSpot gets it onto Facebook / Instagram, SENT once there, FAILED if Meta refused it',
+            enum: ['PENDING', 'SENT', 'FAILED'],
+        },
+        failureReason: {
+            type: 'string',
+            description: 'Why it FAILED; retrying sends it again as it is',
+            enum: [
+                'COMMENT_DELETED',
+                'RECONNECT_REQUIRED',
+                'PERMISSION_MISSING',
+                'RATE_LIMITED',
+                'UNKNOWN',
+            ],
+        },
+    },
+    required: ['commentId', 'commentedAt', 'edited', 'own', 'state'],
+};
+export const SocialCommentSenderSchema = {
+    type: 'object',
+    properties: {
+        type: {
+            type: 'string',
+            enum: ['AGENT', 'AI', 'PAGE'],
+        },
+        member: {
+            $ref: '#/components/schemas/MemberPeekResponse',
+            description: 'AGENT only; also once they have left the agency',
+        },
+    },
+    required: ['type'],
+};
+export const ReplyToSocialCommentRequestSchema = {
+    type: 'object',
+    properties: {
+        text: {
+            type: 'string',
+            description: "Posted exactly as written; how long it may be is the channel's rule",
+            minLength: 1,
+        },
+    },
+    required: ['text'],
+};
 export const CloseListingRequestSchema = {
     type: 'object',
     properties: {
@@ -2353,31 +2479,6 @@ export const CursorPageCommentViewSchema = {
         },
     },
 };
-export const MemberPeekResponseSchema = {
-    type: 'object',
-    properties: {
-        memberId: {
-            type: 'string',
-            format: 'uuid',
-        },
-        firstName: {
-            type: 'string',
-        },
-        lastName: {
-            type: 'string',
-        },
-        photo: {
-            type: 'string',
-        },
-        phone: {
-            type: 'string',
-        },
-        email: {
-            type: 'string',
-        },
-    },
-    required: ['email', 'firstName', 'lastName', 'memberId'],
-};
 export const ContactLinkSchema = {
     type: 'object',
     properties: {
@@ -4797,6 +4898,11 @@ export const PropertyListingResponseSchema = {
                 $ref: '#/components/schemas/SocialPostResponse',
             },
         },
+        unansweredComments: {
+            type: 'integer',
+            format: 'int32',
+            description: "Comment threads waiting for an answer from the agency, across the listing's posts",
+        },
         createdAt: {
             type: 'string',
             format: 'date-time',
@@ -4817,6 +4923,7 @@ export const PropertyListingResponseSchema = {
         'price',
         'publicId',
         'socialPosts',
+        'unansweredComments',
     ],
 };
 export const PropertyPageResponseSchema = {
@@ -4956,10 +5063,22 @@ export const SocialPostResponseSchema = {
         },
         stats: {
             $ref: '#/components/schemas/SocialPostStats',
-            description: "The post's public counts as last read from Facebook / Instagram; null until the first read",
+            description: "The post's numbers as last read from Facebook / Instagram; null until the first read",
+        },
+        unansweredComments: {
+            type: 'integer',
+            format: 'int32',
+            description: 'Comment threads under the post waiting for an answer from the agency; 0 unless PUBLISHED',
         },
     },
-    required: ['caption', 'channel', 'createdBy', 'postId', 'status'],
+    required: [
+        'caption',
+        'channel',
+        'createdBy',
+        'postId',
+        'status',
+        'unansweredComments',
+    ],
 };
 export const SocialPostStatsSchema = {
     type: 'object',
@@ -4967,22 +5086,34 @@ export const SocialPostStatsSchema = {
         likes: {
             type: 'integer',
             format: 'int32',
+            description: 'On Facebook all reactions, as Facebook shows them under the post',
         },
         comments: {
             type: 'integer',
             format: 'int32',
+            description: 'Replies included',
         },
         shares: {
             type: 'integer',
             format: 'int32',
         },
+        views: {
+            type: 'integer',
+            format: 'int32',
+            description: 'How many times the post was seen',
+        },
+        reach: {
+            type: 'integer',
+            format: 'int32',
+            description: 'How many people saw the post',
+        },
         fetchedAt: {
             type: 'string',
             format: 'date-time',
-            description: 'When the counts were read — show how old they are',
+            description: "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",
         },
     },
-    required: ['comments', 'fetchedAt', 'likes', 'shares'],
+    required: ['fetchedAt'],
 };
 export const ListingOwnerContactResponseSchema = {
     type: 'object',
@@ -5266,6 +5397,7 @@ export const NotificationContentSchema = {
             SUBSCRIPTION_PAYMENT_REVERSED: '#/components/schemas/SubscriptionPaymentReversed',
             CHANNEL_REAUTH_REQUIRED: '#/components/schemas/ChannelReauthRequired',
             SOCIAL_POST_FAILED: '#/components/schemas/SocialPostFailed',
+            SOCIAL_POST_COMMENTED: '#/components/schemas/SocialPostCommented',
         },
     },
     required: ['kind'],
@@ -5311,6 +5443,7 @@ export const NotificationViewSchema = {
                 'SUBSCRIPTION_PAYMENT_REVERSED',
                 'CHANNEL_REAUTH_REQUIRED',
                 'SOCIAL_POST_FAILED',
+                'SOCIAL_POST_COMMENTED',
             ],
         },
         targetId: {
@@ -5339,6 +5472,9 @@ export const NotificationViewSchema = {
                 {
                     $ref: '#/components/schemas/NewSeekerRating',
                 },
+                {
+                    $ref: '#/components/schemas/SocialPostCommented',
+                },
                 {
                     $ref: '#/components/schemas/SocialPostFailed',
                 },
@@ -5359,6 +5495,11 @@ export const NotificationViewSchema = {
                 },
             ],
         },
+        count: {
+            type: 'integer',
+            format: 'int32',
+            description: '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',
+        },
         createdAt: {
             type: 'string',
             format: 'date-time',
@@ -5367,7 +5508,7 @@ export const NotificationViewSchema = {
             type: 'boolean',
         },
     },
-    required: ['createdAt', 'id', 'payload', 'read', 'seq', 'type'],
+    required: ['count', 'createdAt', 'id', 'payload', 'read', 'seq', 'type'],
 };
 export const PropertyIdSchema = {
     type: 'object',
@@ -5378,6 +5519,53 @@ export const PropertyIdSchema = {
         },
     },
 };
+export const SocialCommentIdSchema = {
+    type: 'object',
+    properties: {
+        value: {
+            type: 'string',
+            format: 'uuid',
+        },
+    },
+};
+export const SocialPostCommentedSchema = {
+    properties: {
+        postId: {
+            $ref: '#/components/schemas/SocialPostId',
+        },
+        commentId: {
+            $ref: '#/components/schemas/SocialCommentId',
+        },
+        contactId: {
+            $ref: '#/components/schemas/ContactId',
+        },
+        propertyId: {
+            $ref: '#/components/schemas/PropertyId',
+        },
+        listingId: {
+            type: 'integer',
+            format: 'int64',
+        },
+        propertyTitle: {
+            type: 'string',
+        },
+        channel: {
+            type: 'string',
+            enum: ['FACEBOOK', 'INSTAGRAM'],
+        },
+        author: {
+            type: 'string',
+        },
+        commentSnippet: {
+            type: 'string',
+        },
+        kind: {
+            type: 'string',
+            enum: ['SOCIAL_POST_COMMENTED'],
+        },
+    },
+    required: ['kind'],
+};
 export const SocialPostFailedSchema = {
     properties: {
         postId: {
@@ -6593,6 +6781,74 @@ export const ComposerPreviewSchema = {
     },
     required: ['access', 'caption', 'channel', 'limits', 'photos', 'ratios'],
 };
+export const CursorPageSocialCommentThreadResponseSchema = {
+    type: 'object',
+    properties: {
+        items: {
+            type: 'array',
+            items: {
+                $ref: '#/components/schemas/SocialCommentThreadResponse',
+            },
+        },
+        nextCursor: {
+            type: 'string',
+        },
+        hasNext: {
+            type: 'boolean',
+        },
+    },
+};
+export const SocialCommentPostSchema = {
+    type: 'object',
+    properties: {
+        postId: {
+            type: 'string',
+            format: 'uuid',
+        },
+        channel: {
+            type: 'string',
+            enum: ['FACEBOOK', 'INSTAGRAM'],
+        },
+        status: {
+            type: 'string',
+            description: 'PUBLISHED, or REMOVED once gone from Facebook / Instagram: its comments stay, and can no longer be answered',
+            enum: ['PUBLISHING', 'PUBLISHED', 'FAILED', 'REMOVED'],
+        },
+        permalink: {
+            type: 'string',
+        },
+        publishedAt: {
+            type: 'string',
+            format: 'date-time',
+        },
+    },
+    required: ['channel', 'permalink', 'postId', 'publishedAt', 'status'],
+};
+export const SocialCommentThreadResponseSchema = {
+    type: 'object',
+    properties: {
+        post: {
+            $ref: '#/components/schemas/SocialCommentPost',
+            description: 'The post the thread is under',
+        },
+        comment: {
+            $ref: '#/components/schemas/SocialCommentResponse',
+            description: 'The comment that started the thread',
+        },
+        replies: {
+            type: 'array',
+            description: "All of the thread's replies, oldest first; each one's parentCommentId says which comment it is shown under (Facebook shows two levels of replies, Instagram one)",
+            items: {
+                $ref: '#/components/schemas/SocialCommentResponse',
+            },
+        },
+        answered: {
+            type: 'boolean',
+            description: "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",
+        },
+    },
+    required: ['answered', 'comment', 'post', 'replies'],
+};
 export const ContactGridResponseSchema = {
     type: 'object',
     properties: {