@homespot-sdk/core 0.0.364 → 0.0.366

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

@@ -85,6 +85,31 @@ export type SetTaskCommissionRequest = {
 export type RenameTodoRequest = {
     title: string;
 };
+export type SaveSocialPostTemplateRequest = {
+    /**
+     * Lines with {{key}} placeholders
+     */
+    text: string;
+    /**
+     * The version the text was read at; null while the group had HomeSpot's text
+     */
+    version?: number;
+};
+export type PostTemplateView = {
+    group: 'HOUSE_GROUP' | 'APARTMENT_GROUP' | 'HOSPITALITY_GROUP' | 'LAND_GROUP' | 'BUSINESS_GROUP' | 'STORAGE_GROUP';
+    /**
+     * Lines with {{key}} placeholders
+     */
+    text: string;
+    /**
+     * False while the group has HomeSpot's text
+     */
+    customized: boolean;
+    /**
+     * Sent back when saving; null while the group has HomeSpot's text
+     */
+    version?: number;
+};
 export type RolesRequest = {
     name: string;
     description: string;
@@ -165,6 +190,26 @@ export type UpdateContactDetailsRequest = {
     favoriteContactMethod?: 'WHATSAPP' | 'VIBER' | 'PHONE_CALL';
     nullifyFavoriteContactMethod?: boolean;
 };
+export type ExternalListingManualSaveRequest = {
+    listingId: number;
+    /**
+     * Which portal the listing is on; needed for a bare number, and a link has to agree with it
+     */
+    platform?: 'SS' | 'MY_HOME';
+    /**
+     * The listing's link on ss.ge or myhome.ge, or its number
+     */
+    portalListing: string;
+    listedAt?: Date;
+    /**
+     * When the agent last renewed it on the portal; today, to mark it renewed
+     */
+    renewedAt?: Date;
+    /**
+     * When the portal says it ends; left out, 30 days after renewedAt or else listedAt
+     */
+    expiresAt?: Date;
+};
 export type ReassignMemberRequest = {
     memberId: string;
 };
@@ -543,7 +588,6 @@ export type PublishSocialPostRequest = {
      * In post order
      */
     photos: Array<Photo>;
-    templateId?: string;
 };
 export type FocusView = {
     x: number;
@@ -564,7 +608,6 @@ export type SocialPostView = {
      */
     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;
     /**
@@ -674,10 +717,6 @@ export type ExternalListingBoostRequest = {
     tier: 'VIP' | 'VIP_PLUS' | 'SUPER_VIP';
     numberOfDays: number;
 };
-export type OnboardFromSourceRequest = {
-    sourceLink: string;
-    phone: string;
-};
 export type CreateBoardRequest = {
     kind?: 'OWNER' | 'SEEKER';
     name: string;
@@ -1203,6 +1242,43 @@ export type ContactAcquisitionResponse = {
     series: Array<ChannelSeries>;
     total: number;
 };
+export type PostTemplates = {
+    /**
+     * One per property group
+     */
+    templates: Array<PostTemplateView>;
+    /**
+     * What a text can hold as {{key}}, with the groups each fact applies to
+     */
+    facts: Array<TemplateFact>;
+    limits: TemplateLimits;
+};
+export type TemplateFact = {
+    /**
+     * Written in a text as {{key}}
+     */
+    key: string;
+    /**
+     * In Georgian
+     */
+    label: string;
+    /**
+     * A value as a listing fills it in, in Georgian
+     */
+    example: string;
+    groups: Array<'HOUSE_GROUP' | 'APARTMENT_GROUP' | 'HOSPITALITY_GROUP' | 'LAND_GROUP' | 'BUSINESS_GROUP' | 'STORAGE_GROUP'>;
+};
+export type TemplateLimits = {
+    /**
+     * In code points, as the composer counts
+     */
+    maxLength: number;
+    maxHashtags: number;
+    /**
+     * @ tags
+     */
+    maxTags: number;
+};
 export type PageMetadata = {
     size?: number;
     number?: number;
@@ -1501,13 +1577,17 @@ export type DealResponse = {
 export type PlatformListingResponse = {
     platformId?: number;
     platformType: 'SS' | 'MY_HOME';
-    status: 'PENDING' | 'SYNDICATED' | 'FAILED' | 'EXPIRED' | 'WITHDRAWING' | 'WITHDRAWN';
+    status: 'PENDING' | 'SYNDICATED' | 'FAILED' | 'EXPIRED' | 'WITHDRAWING' | 'WITHDRAWN' | 'MANUAL';
     listedAt?: Date;
     expiresAt?: Date;
     renewedAt?: Date;
     failureReason?: string;
     boost?: BoostResponse;
     coloredListing?: ColoredListingResponse;
+    /**
+     * Opens the listing on the portal, once the portal gave it a number
+     */
+    url?: string;
 };
 export type PropertyCloseReasonResponse = {
     closedAt: Date;
@@ -1899,21 +1979,12 @@ export type ListingGridResponse = {
     agreementExpiresAt?: Date;
     propertyState: 'IN_REGISTRATION' | 'UNLISTED' | 'LISTED_INTERNALLY' | 'LISTED' | 'CLOSED';
     listingType?: 'SALE' | 'RENT' | 'DAILY_RENT' | 'PLEDGE';
-    /**
-     * Whether the agency still works the listing; null for a property without one
-     */
     listingState?: 'OPEN' | 'CLOSED';
-    /**
-     * The listing on HomeSpot's own marketplace; null for a property without one
-     */
     marketplaceStatus?: 'ACTIVE' | 'PAUSED' | 'EXPIRED';
     price?: number;
     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;
@@ -1925,19 +1996,14 @@ export type PagedModelListingGridResponse = {
 export type PlatformView = {
     platformId?: number;
     platform?: 'SS' | 'MY_HOME';
-    /**
-     * PENDING until the portal answers; SYNDICATED while live
-     */
-    status: 'PENDING' | 'SYNDICATED' | 'FAILED' | 'EXPIRED' | 'WITHDRAWING' | 'WITHDRAWN';
+    status: 'PENDING' | 'SYNDICATED' | 'FAILED' | 'EXPIRED' | 'WITHDRAWING' | 'WITHDRAWN' | 'MANUAL';
     expiresAt?: Date;
     tier?: 'VIP' | 'VIP_PLUS' | 'SUPER_VIP';
     boostExpiresAt?: Date;
+    url?: string;
 };
 export type SocialPostLink = {
     channel: 'FACEBOOK' | 'INSTAGRAM';
-    /**
-     * Opens the post on Facebook / Instagram
-     */
     permalink: string;
 };
 export type GroupCount = {
@@ -2075,6 +2141,14 @@ export type ComposerLimits = {
      * In Unicode code points: an emoji counts once, as [...text].length counts in JavaScript (text.length counts it twice)
      */
     maxCaptionLength: number;
+    /**
+     * Null where the channel caps none (Facebook)
+     */
+    maxHashtags?: number;
+    /**
+     * @ tags; null where the channel caps none (Facebook)
+     */
+    maxTags?: number;
 };
 export type ComposerPhoto = {
     /**
@@ -2095,13 +2169,17 @@ export type ComposerPhoto = {
 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
+     * 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;
     /**
-     * The template the text came from, sent back on publish; null for the built-in one
+     * The property group whose template the caption came from: the one an Edit template opens
+     */
+    group: 'HOUSE_GROUP' | 'APARTMENT_GROUP' | 'HOSPITALITY_GROUP' | 'LAND_GROUP' | 'BUSINESS_GROUP' | 'STORAGE_GROUP';
+    /**
+     * The facts whose lines were left out because the listing doesn't have them; the agent can fill them in on the property
      */
-    templateId?: string;
+    leftOut: Array<LeftOutFact>;
     limits: ComposerLimits;
     /**
      * The shapes the agent can pick; empty on Facebook, which keeps each photo's own
@@ -2120,6 +2198,16 @@ export type ComposerPreview = {
      */
     access: 'ALLOWED' | 'NOT_CONNECTED' | 'RECONNECT_REQUIRED';
 };
+export type LeftOutFact = {
+    /**
+     * As the template writes it, e.g. property.bedrooms
+     */
+    key: string;
+    /**
+     * In Georgian
+     */
+    label: string;
+};
 export type CursorPageSocialCommentThreadResponse = {
     items?: Array<SocialCommentThreadResponse>;
     nextCursor?: string;
@@ -2335,6 +2423,10 @@ export type MemberCurationView = {
     profilePictureUrl?: string;
     isFeatured?: boolean;
 };
+export type ExternalListingManualRemoveRequest = {
+    listingId: number;
+    platform: 'SS' | 'MY_HOME';
+};
 export type PutWhitelabelWebsiteData = {
     body: WebsiteRequest;
     path?: never;
@@ -2771,6 +2863,42 @@ export type PutTaskTodoByTodoIdCompleteResponses = {
     204: void;
 };
 export type PutTaskTodoByTodoIdCompleteResponse = PutTaskTodoByTodoIdCompleteResponses[keyof PutTaskTodoByTodoIdCompleteResponses];
+export type DeleteSocialPostTemplatesByGroupData = {
+    body?: never;
+    path: {
+        group: 'HOUSE_GROUP' | 'APARTMENT_GROUP' | 'HOSPITALITY_GROUP' | 'LAND_GROUP' | 'BUSINESS_GROUP' | 'STORAGE_GROUP';
+    };
+    query?: never;
+    url: '/social-post-templates/{group}';
+};
+export type DeleteSocialPostTemplatesByGroupResponses = {
+    /**
+     * OK
+     */
+    200: PostTemplateView;
+};
+export type DeleteSocialPostTemplatesByGroupResponse = DeleteSocialPostTemplatesByGroupResponses[keyof DeleteSocialPostTemplatesByGroupResponses];
+export type PutSocialPostTemplatesByGroupData = {
+    body: SaveSocialPostTemplateRequest;
+    path: {
+        group: 'HOUSE_GROUP' | 'APARTMENT_GROUP' | 'HOSPITALITY_GROUP' | 'LAND_GROUP' | 'BUSINESS_GROUP' | 'STORAGE_GROUP';
+    };
+    query?: never;
+    url: '/social-post-templates/{group}';
+};
+export type PutSocialPostTemplatesByGroupErrors = {
+    /**
+     * The group's text was saved or reset since it was read
+     */
+    409: unknown;
+};
+export type PutSocialPostTemplatesByGroupResponses = {
+    /**
+     * OK
+     */
+    200: PostTemplateView;
+};
+export type PutSocialPostTemplatesByGroupResponse = PutSocialPostTemplatesByGroupResponses[keyof PutSocialPostTemplatesByGroupResponses];
 export type DeleteRolesByRoleIdData = {
     body?: never;
     path: {
@@ -3144,6 +3272,36 @@ export type PutContactByContactIdUpdateContactDetailsResponses = {
     204: void;
 };
 export type PutContactByContactIdUpdateContactDetailsResponse = PutContactByContactIdUpdateContactDetailsResponses[keyof PutContactByContactIdUpdateContactDetailsResponses];
+export type DeleteContactByContactIdPropertyByPropertyIdExternalListingManualData = {
+    body: ExternalListingManualRemoveRequest;
+    path: {
+        contactId: number;
+        propertyId: number;
+    };
+    query?: never;
+    url: '/contact/{contactId}/property/{propertyId}/external-listing/manual';
+};
+export type DeleteContactByContactIdPropertyByPropertyIdExternalListingManualResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
+export type PutContactByContactIdPropertyByPropertyIdExternalListingManualData = {
+    body: ExternalListingManualSaveRequest;
+    path: {
+        contactId: number;
+        propertyId: number;
+    };
+    query?: never;
+    url: '/contact/{contactId}/property/{propertyId}/external-listing/manual';
+};
+export type PutContactByContactIdPropertyByPropertyIdExternalListingManualResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
 export type PutContactByContactIdAssignmentData = {
     body: ReassignMemberRequest;
     path: {
@@ -4658,19 +4816,6 @@ export type PostContactByContactIdPropertyByPropertyIdExternalListingBoostRespon
      */
     200: unknown;
 };
-export type PostContactSourceData = {
-    body: OnboardFromSourceRequest;
-    path?: never;
-    query?: never;
-    url: '/contact/source';
-};
-export type PostContactSourceResponses = {
-    /**
-     * Created
-     */
-    201: IdResponseLong;
-};
-export type PostContactSourceResponse = PostContactSourceResponses[keyof PostContactSourceResponses];
 export type GetBoardData = {
     body?: never;
     path?: never;
@@ -4942,6 +5087,19 @@ export type GetStatsContactsAcquisitionResponses = {
     200: ContactAcquisitionResponse;
 };
 export type GetStatsContactsAcquisitionResponse = GetStatsContactsAcquisitionResponses[keyof GetStatsContactsAcquisitionResponses];
+export type GetSocialPostTemplatesData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/social-post-templates';
+};
+export type GetSocialPostTemplatesResponses = {
+    /**
+     * OK
+     */
+    200: PostTemplates;
+};
+export type GetSocialPostTemplatesResponse = GetSocialPostTemplatesResponses[keyof GetSocialPostTemplatesResponses];
 export type GetPublicTelegramPropertyFormsByFormIdOwnersData = {
     body?: never;
     headers?: {