@homespot-sdk/core 0.0.303 → 0.0.305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -107,25 +107,27 @@ export type LocationTargetRequest = {
107
107
  export type CommentBodyRequest = {
108
108
  body: string;
109
109
  };
110
- export type ContactStatusRequest = {
111
- status: 'NEW' | 'ON_HOLD' | 'COLD' | 'WARM' | 'HOT' | 'WAITING_PAYMENT' | 'LOST' | 'CLOSED';
112
- };
113
- export type ReprioritizeClientRequest = {
114
- priority: 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW';
115
- };
116
- export type RecordLostContactRequest = {
117
- reason: 'NOT_WORKING_WITH_AGENTS' | 'NOT_RESPONDING' | 'ALREADY_SOLD' | 'COULD_NOT_NEGOTIATE_PRICE' | 'CHOSE_ANOTHER_AGENCY' | 'CHANGED_PLANS' | 'OUT_OF_BUDGET' | 'SPAM' | 'OTHER';
118
- };
119
- export type UpdateContactPreferencesRequest = {
120
- contactMethods: Array<'WHATSAPP' | 'VIBER' | 'PHONE_CALL'>;
121
- favoriteContactMethod?: 'WHATSAPP' | 'VIBER' | 'PHONE_CALL';
110
+ export type PhoneNumberRequest = {
111
+ phoneNumber: string;
122
112
  };
123
- export type ContactInfoRequest = {
113
+ export type UpdateContactDetailsRequest = {
114
+ title?: string;
115
+ nullifyTitle?: boolean;
124
116
  firstName?: string;
117
+ nullifyFirstName?: boolean;
125
118
  lastName?: string;
119
+ nullifyLastName?: boolean;
126
120
  gender?: 'MALE' | 'FEMALE' | 'UNKNOWN';
127
121
  email?: string;
128
- phone: string;
122
+ nullifyEmail?: boolean;
123
+ contactMethods?: Array<'WHATSAPP' | 'VIBER' | 'PHONE_CALL'>;
124
+ favoriteContactMethod?: 'WHATSAPP' | 'VIBER' | 'PHONE_CALL';
125
+ nullifyFavoriteContactMethod?: boolean;
126
+ status?: 'NEW' | 'ON_HOLD' | 'COLD' | 'WARM' | 'HOT' | 'WAITING_PAYMENT' | 'LOST' | 'CLOSED';
127
+ priority?: 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW';
128
+ };
129
+ export type RecordLostContactRequest = {
130
+ reason: 'NOT_WORKING_WITH_AGENTS' | 'NOT_RESPONDING' | 'ALREADY_SOLD' | 'COULD_NOT_NEGOTIATE_PRICE' | 'CHOSE_ANOTHER_AGENCY' | 'CHANGED_PLANS' | 'OUT_OF_BUDGET' | 'SPAM' | 'OTHER';
129
131
  };
130
132
  export type ReassignMemberRequest = {
131
133
  memberId: string;
@@ -183,6 +185,22 @@ export type RateRecommendationItemRequest = {
183
185
  decision: 'MAYBE' | 'DISLIKE' | 'LIKE' | 'VISIT';
184
186
  note?: string;
185
187
  };
188
+ export type SendMessageRequest = {
189
+ text: string;
190
+ };
191
+ export type ProblemDetail = {
192
+ type?: string;
193
+ title?: string;
194
+ status?: number;
195
+ detail?: string;
196
+ instance?: string;
197
+ properties?: {
198
+ [key: string]: unknown;
199
+ };
200
+ };
201
+ export type SendMessageResponse = {
202
+ messageId?: string;
203
+ };
186
204
  export type AttendeeRequest = {
187
205
  role: 'ORGANIZER' | 'MEMBER' | 'OWNER' | 'CLIENT' | 'OTHER';
188
206
  memberId?: string;
@@ -255,8 +273,19 @@ export type InterestId = {
255
273
  export type IdResponseUuid = {
256
274
  id: string;
257
275
  };
276
+ export type ContactInfoRequest = {
277
+ firstName?: string;
278
+ lastName?: string;
279
+ gender?: 'MALE' | 'FEMALE' | 'UNKNOWN';
280
+ email?: string;
281
+ };
282
+ export type ContactTitleRequest = {
283
+ title?: string;
284
+ };
258
285
  export type OnboardClientRequest = {
286
+ title: ContactTitleRequest;
259
287
  contactInfo: ContactInfoRequest;
288
+ phoneNumber: string;
260
289
  contactMethods: Array<'WHATSAPP' | 'VIBER' | 'PHONE_CALL'>;
261
290
  favoriteContactMethod?: 'WHATSAPP' | 'VIBER' | 'PHONE_CALL';
262
291
  priority?: 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW';
@@ -588,6 +617,57 @@ export type PagedModelInvitationViewResponse = {
588
617
  content?: Array<InvitationViewResponse>;
589
618
  page?: PageMetadata;
590
619
  };
620
+ export type CursorPageInboxResponse = {
621
+ items?: Array<InboxResponse>;
622
+ nextCursor?: string;
623
+ hasNext?: boolean;
624
+ };
625
+ export type InboxResponse = {
626
+ conversationId?: string;
627
+ lastMessageAt?: Date;
628
+ unreadCount?: number;
629
+ lastMessagePreview?: string;
630
+ direction?: 'INBOUND' | 'OUTBOUND';
631
+ channelType?: 'FACEBOOK' | 'INSTAGRAM' | 'WHATSAPP';
632
+ contactId?: number;
633
+ isReachable?: boolean;
634
+ contactFirstName?: string;
635
+ contactLastName?: string;
636
+ managedBy?: string;
637
+ memberFirstName?: string;
638
+ memberLastName?: string;
639
+ memberPicture?: string;
640
+ };
641
+ export type CursorPageMessageView = {
642
+ items?: Array<MessageView>;
643
+ nextCursor?: string;
644
+ hasNext?: boolean;
645
+ };
646
+ export type MessageContent = {
647
+ '@type': string;
648
+ };
649
+ export type MessageView = {
650
+ id?: string;
651
+ direction?: 'INBOUND' | 'OUTBOUND';
652
+ content?: Text | Unsupported;
653
+ status?: 'RECEIVED' | 'PENDING' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED';
654
+ sentAt?: Date;
655
+ deliveredAt?: Date;
656
+ readAt?: Date;
657
+ failureReason?: string;
658
+ sentByMemberId?: string;
659
+ sentByFirstName?: string;
660
+ sentByLastName?: string;
661
+ sentByPicture?: string;
662
+ };
663
+ export type Text = Omit<MessageContent, '@type'> & {
664
+ body?: string;
665
+ '@type': 'Text';
666
+ };
667
+ export type Unsupported = Omit<MessageContent, '@type'> & {
668
+ kind?: string;
669
+ '@type': 'Unsupported';
670
+ };
591
671
  export type ConstantInterestResponse = {
592
672
  id: number;
593
673
  propertyTypes: Array<'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'>;
@@ -614,6 +694,7 @@ export type CommentView = {
614
694
  authorId: string;
615
695
  authorFirstName: string;
616
696
  authorLastName: string;
697
+ sentByPicture?: string;
617
698
  body: string;
618
699
  createdAt: Date;
619
700
  editedAt?: Date;
@@ -626,6 +707,7 @@ export type ContactGridResponse = {
626
707
  id: number;
627
708
  createdBy?: string;
628
709
  assignedTo?: AssignedToResponse;
710
+ title?: string;
629
711
  status: 'NEW' | 'ON_HOLD' | 'COLD' | 'WARM' | 'HOT' | 'WAITING_PAYMENT' | 'LOST' | 'CLOSED';
630
712
  priority?: 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW';
631
713
  contactName?: string;
@@ -643,11 +725,6 @@ export type PagedModelContactGridResponse = {
643
725
  content?: Array<ContactGridResponse>;
644
726
  page?: PageMetadata;
645
727
  };
646
- export type ActiveBoostResponse = {
647
- tier: 'VIP' | 'VIP_PLUS' | 'SUPER_VIP';
648
- activatedAt: Date;
649
- expiresAt: Date;
650
- };
651
728
  export type AgreementResponse = {
652
729
  agreement: 'EXCLUSIVE' | 'NON_EXCLUSIVE';
653
730
  expiryDate?: Date;
@@ -664,6 +741,7 @@ export type Client360Response = {
664
741
  contactUserId?: string;
665
742
  createdBy: string;
666
743
  assignedMember?: AssignedMember;
744
+ contactTitle?: string;
667
745
  contactInfo: ContactInfoResponse;
668
746
  source: SourceResponse;
669
747
  communicationPreference?: CommunicationPreferenceResponse;
@@ -675,10 +753,6 @@ export type Client360Response = {
675
753
  interests: Array<ConstantInterestResponse>;
676
754
  properties: Array<ContactPropertyResponse>;
677
755
  };
678
- export type ColoredListingResponse = {
679
- activatedAt: Date;
680
- expiresAt: Date;
681
- };
682
756
  export type CommunicationPreferenceResponse = {
683
757
  preferredContactMethod?: 'WHATSAPP' | 'VIBER' | 'PHONE_CALL';
684
758
  contactMethods: Array<'WHATSAPP' | 'VIBER' | 'PHONE_CALL'>;
@@ -690,14 +764,6 @@ export type ContactInfoResponse = {
690
764
  phoneNumber: string;
691
765
  email?: string;
692
766
  };
693
- export type ContactListingsResponse = {
694
- publicId: number;
695
- listingId: string;
696
- listingType: 'SALE' | 'RENT' | 'DAILY_RENT' | 'PLEDGE';
697
- price: number;
698
- deal?: DealResponse;
699
- platformListings: Array<PlatformListingResponse>;
700
- };
701
767
  export type ContactPropertyResponse = {
702
768
  publicId: number;
703
769
  propertyId: string;
@@ -705,23 +771,7 @@ export type ContactPropertyResponse = {
705
771
  state: 'IN_REGISTRATION' | 'UNLISTED' | 'LISTED_INTERNALLY' | 'LISTED' | 'CLOSED';
706
772
  details?: PropertyDetailsResponse;
707
773
  agreement: AgreementResponse;
708
- listings: Array<ContactListingsResponse>;
709
- };
710
- export type DealResponse = {
711
- type: 'FIXED_SALE' | 'FIXED_RENT' | 'PERCENTAGE' | 'MONTHS_OF_RENT';
712
- rate?: number;
713
- fixedAmount?: number;
714
- months?: number;
715
- commission: number;
716
- };
717
- export type PlatformListingResponse = {
718
- platformId: number;
719
- platformType: 'SS' | 'MY_HOME';
720
- uploadDate: Date;
721
- expiryDate: Date;
722
- renewedDate?: Date;
723
- boost?: ActiveBoostResponse;
724
- coloredListing?: ColoredListingResponse;
774
+ listings: Array<'SALE' | 'RENT' | 'DAILY_RENT' | 'PLEDGE'>;
725
775
  };
726
776
  export type PropertyDetailsResponse = {
727
777
  title: string;
@@ -1158,36 +1208,36 @@ export type PutContactsByContactIdCommentsByCommentIdResponses = {
1158
1208
  */
1159
1209
  200: unknown;
1160
1210
  };
1161
- export type PutContactByContactIdUpdateStatusData = {
1162
- body: ContactStatusRequest;
1211
+ export type PutContactByContactIdUpdatePhoneNumberData = {
1212
+ body: PhoneNumberRequest;
1163
1213
  path: {
1164
1214
  contactId: number;
1165
1215
  };
1166
1216
  query?: never;
1167
- url: '/contact/{contactId}/update-status';
1217
+ url: '/contact/{contactId}/update-phone-number';
1168
1218
  };
1169
- export type PutContactByContactIdUpdateStatusResponses = {
1219
+ export type PutContactByContactIdUpdatePhoneNumberResponses = {
1170
1220
  /**
1171
1221
  * No Content
1172
1222
  */
1173
1223
  204: void;
1174
1224
  };
1175
- export type PutContactByContactIdUpdateStatusResponse = PutContactByContactIdUpdateStatusResponses[keyof PutContactByContactIdUpdateStatusResponses];
1176
- export type PutContactByContactIdPriorityData = {
1177
- body: ReprioritizeClientRequest;
1225
+ export type PutContactByContactIdUpdatePhoneNumberResponse = PutContactByContactIdUpdatePhoneNumberResponses[keyof PutContactByContactIdUpdatePhoneNumberResponses];
1226
+ export type PutContactByContactIdUpdateContactDetailsData = {
1227
+ body: UpdateContactDetailsRequest;
1178
1228
  path: {
1179
1229
  contactId: number;
1180
1230
  };
1181
1231
  query?: never;
1182
- url: '/contact/{contactId}/priority';
1232
+ url: '/contact/{contactId}/update-contact-details';
1183
1233
  };
1184
- export type PutContactByContactIdPriorityResponses = {
1234
+ export type PutContactByContactIdUpdateContactDetailsResponses = {
1185
1235
  /**
1186
1236
  * No Content
1187
1237
  */
1188
1238
  204: void;
1189
1239
  };
1190
- export type PutContactByContactIdPriorityResponse = PutContactByContactIdPriorityResponses[keyof PutContactByContactIdPriorityResponses];
1240
+ export type PutContactByContactIdUpdateContactDetailsResponse = PutContactByContactIdUpdateContactDetailsResponses[keyof PutContactByContactIdUpdateContactDetailsResponses];
1191
1241
  export type PutContactByContactIdLostData = {
1192
1242
  body: RecordLostContactRequest;
1193
1243
  path: {
@@ -1203,36 +1253,6 @@ export type PutContactByContactIdLostResponses = {
1203
1253
  204: void;
1204
1254
  };
1205
1255
  export type PutContactByContactIdLostResponse = PutContactByContactIdLostResponses[keyof PutContactByContactIdLostResponses];
1206
- export type PutContactByContactIdContactPreferencesData = {
1207
- body: UpdateContactPreferencesRequest;
1208
- path: {
1209
- contactId: number;
1210
- };
1211
- query?: never;
1212
- url: '/contact/{contactId}/contact-preferences';
1213
- };
1214
- export type PutContactByContactIdContactPreferencesResponses = {
1215
- /**
1216
- * No Content
1217
- */
1218
- 204: void;
1219
- };
1220
- export type PutContactByContactIdContactPreferencesResponse = PutContactByContactIdContactPreferencesResponses[keyof PutContactByContactIdContactPreferencesResponses];
1221
- export type PutContactByContactIdContactInfoData = {
1222
- body: ContactInfoRequest;
1223
- path: {
1224
- contactId: number;
1225
- };
1226
- query?: never;
1227
- url: '/contact/{contactId}/contact-info';
1228
- };
1229
- export type PutContactByContactIdContactInfoResponses = {
1230
- /**
1231
- * No Content
1232
- */
1233
- 204: void;
1234
- };
1235
- export type PutContactByContactIdContactInfoResponse = PutContactByContactIdContactInfoResponses[keyof PutContactByContactIdContactInfoResponses];
1236
1256
  export type PutContactByContactIdCloseData = {
1237
1257
  body?: never;
1238
1258
  path: {
@@ -1508,6 +1528,32 @@ export type PostPublicRecomendationsByRecommendationsIdItemsByItemIdRateResponse
1508
1528
  204: void;
1509
1529
  };
1510
1530
  export type PostPublicRecomendationsByRecommendationsIdItemsByItemIdRateResponse = PostPublicRecomendationsByRecommendationsIdItemsByItemIdRateResponses[keyof PostPublicRecomendationsByRecommendationsIdItemsByItemIdRateResponses];
1531
+ export type PostMessagingConversationsByConversationIdMessagesData = {
1532
+ body: SendMessageRequest;
1533
+ path: {
1534
+ conversationId: string;
1535
+ };
1536
+ query?: never;
1537
+ url: '/messaging/conversations/{conversationId}/messages';
1538
+ };
1539
+ export type PostMessagingConversationsByConversationIdMessagesErrors = {
1540
+ /**
1541
+ * Channel needs re-authorization
1542
+ */
1543
+ 409: ProblemDetail;
1544
+ /**
1545
+ * Free-form messaging window closed
1546
+ */
1547
+ 422: ProblemDetail;
1548
+ };
1549
+ export type PostMessagingConversationsByConversationIdMessagesError = PostMessagingConversationsByConversationIdMessagesErrors[keyof PostMessagingConversationsByConversationIdMessagesErrors];
1550
+ export type PostMessagingConversationsByConversationIdMessagesResponses = {
1551
+ /**
1552
+ * Message persisted and sent
1553
+ */
1554
+ 201: SendMessageResponse;
1555
+ };
1556
+ export type PostMessagingConversationsByConversationIdMessagesResponse = PostMessagingConversationsByConversationIdMessagesResponses[keyof PostMessagingConversationsByConversationIdMessagesResponses];
1511
1557
  export type PostMemberPresignedUrlsData = {
1512
1558
  body: PhotoRequest;
1513
1559
  path?: never;
@@ -2408,6 +2454,58 @@ export type GetListingGroupsResponses = {
2408
2454
  200: Array<GroupCount>;
2409
2455
  };
2410
2456
  export type GetListingGroupsResponse = GetListingGroupsResponses[keyof GetListingGroupsResponses];
2457
+ export type GetInboxData = {
2458
+ body?: never;
2459
+ path?: never;
2460
+ query?: {
2461
+ status?: 'OPEN' | 'RESOLVED';
2462
+ cursor?: string;
2463
+ limit?: number;
2464
+ };
2465
+ url: '/inbox';
2466
+ };
2467
+ export type GetInboxResponses = {
2468
+ /**
2469
+ * OK
2470
+ */
2471
+ 200: CursorPageInboxResponse;
2472
+ };
2473
+ export type GetInboxResponse = GetInboxResponses[keyof GetInboxResponses];
2474
+ export type GetInboxAgencyData = {
2475
+ body?: never;
2476
+ path?: never;
2477
+ query?: {
2478
+ status?: 'OPEN' | 'RESOLVED';
2479
+ cursor?: string;
2480
+ limit?: number;
2481
+ };
2482
+ url: '/inbox/agency';
2483
+ };
2484
+ export type GetInboxAgencyResponses = {
2485
+ /**
2486
+ * OK
2487
+ */
2488
+ 200: CursorPageInboxResponse;
2489
+ };
2490
+ export type GetInboxAgencyResponse = GetInboxAgencyResponses[keyof GetInboxAgencyResponses];
2491
+ export type GetConversationsByConversationIdMessagesData = {
2492
+ body?: never;
2493
+ path: {
2494
+ conversationId: string;
2495
+ };
2496
+ query?: {
2497
+ cursor?: string;
2498
+ limit?: number;
2499
+ };
2500
+ url: '/conversations/{conversationId}/messages';
2501
+ };
2502
+ export type GetConversationsByConversationIdMessagesResponses = {
2503
+ /**
2504
+ * OK
2505
+ */
2506
+ 200: CursorPageMessageView;
2507
+ };
2508
+ export type GetConversationsByConversationIdMessagesResponse = GetConversationsByConversationIdMessagesResponses[keyof GetConversationsByConversationIdMessagesResponses];
2411
2509
  export type GetContactsByContactIdRecommendationsByRecommendationsIdData = {
2412
2510
  body?: never;
2413
2511
  path: {