@homespot-sdk/core 1.0.1 → 1.0.3

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

@@ -229,6 +229,20 @@ export type RecolorStageRequest = {
 export type ReorderStagesRequest = {
     stageIds: Array<string>;
 };
+export type VideoRequest = {
+    title: string;
+    description?: string;
+    /**
+     * The video's object key in the guides bucket
+     */
+    videoKey: string;
+};
+export type OrderRequest = {
+    /**
+     * Every video's id, first shown first
+     */
+    ids: Array<string>;
+};
 export type AddressRequest = {
     country: string;
     city: string;
@@ -336,7 +350,7 @@ export type AttributionRequest = {
 };
 export type SubscribeRequest = {
     /**
-     * PLUS or PRO to check out right away, FREE to start on Free without the trial; absent to start on the trial only
+     * PLUS or PRO to check out right away (PRO starts with the trial: the card is verified, and charged when it ends); FREE or absent to start on Free only
      */
     plan?: 'FREE' | 'PLUS' | 'PRO' | 'ENTERPRISE';
     /**
@@ -803,6 +817,9 @@ export type AdminCheckoutResponse = {
     checkoutUrl?: string;
     subscriptionId?: string;
 };
+export type Created = {
+    id: string;
+};
 export type PositionTaskRequest = {
     targetStageId: string;
     /**
@@ -1154,9 +1171,13 @@ export type PlanResponse = {
      */
     canManage: boolean;
     /**
-     * Present only during the trial every new agency starts with
+     * Present only during the trial, while its own AI allowance applies: from the card's verification to the first charge
      */
     trial?: Trial;
+    /**
+     * Whether checking out the catalog's trial plan starts the trial: true until one of the agency's subscriptions has started
+     */
+    trialAvailable: boolean;
     /**
      * The subscription access comes from; absent on Free
      */
@@ -1488,6 +1509,9 @@ export type CatalogResponse = {
      * Enterprise's lowest monthly price; every deal is priced individually
      */
     enterpriseFromMonthly: Amount;
+    /**
+     * What an agency's first checkout of the plan starts with: Flitt verifies the card and charges when the trial ends
+     */
     trial: TrialOffer;
 };
 export type PlanOffer = {
@@ -1870,9 +1894,9 @@ export type NotificationFeed = {
 export type NotificationView = {
     id: string;
     seq: number;
-    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' | 'TRIAL_ENDING' | 'TRIAL_ENDED' | 'DISCOUNT_ENDING' | 'AI_MESSAGES_RUNNING_LOW' | 'AI_MESSAGES_USED_UP' | 'CHANNEL_REAUTH_REQUIRED' | 'CHANNEL_TAKEN_OVER' | 'SOCIAL_POST_FAILED' | 'SOCIAL_POST_COMMENTED';
+    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' | 'DISCOUNT_ENDING' | 'AI_MESSAGES_RUNNING_LOW' | 'AI_MESSAGES_USED_UP' | 'CHANNEL_REAUTH_REQUIRED' | 'CHANNEL_TAKEN_OVER' | 'SOCIAL_POST_FAILED' | 'SOCIAL_POST_COMMENTED';
     targetId?: string;
-    payload: AgentCommented | AiMessagesRunningLow | AiMessagesUsedUp | ChannelReauthRequired | ChannelTakenOver | ContactAssigned | DiscountEnding | ListingExpired | MemberMentioned | NewMessage | NewSeekerRating | SocialPostCommented | SocialPostFailed | SubscriptionEnding | SubscriptionExpired | SubscriptionPaymentFailed | SubscriptionPaymentReversed | TaskCommented | TrialEnded | TrialEnding;
+    payload: AgentCommented | AiMessagesRunningLow | AiMessagesUsedUp | ChannelReauthRequired | ChannelTakenOver | ContactAssigned | DiscountEnding | 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
      */
@@ -1946,13 +1970,6 @@ export type TaskCommented = {
 export type TaskId = {
     value?: string;
 };
-export type TrialEnded = {
-    kind: 'TRIAL_ENDED';
-};
-export type TrialEnding = {
-    endsAt?: Date;
-    kind: 'TRIAL_ENDING';
-};
 export type UnreadCount = {
     count: number;
 };
@@ -2157,6 +2174,23 @@ export type InboxResponse = {
     memberLastName?: string;
     memberPicture?: string;
 };
+export type GuideVideoView = {
+    id: string;
+    title: string;
+    description?: string;
+    /**
+     * Plays straight from the guides bucket
+     */
+    videoUrl: string;
+    /**
+     * When the user first played it; null if never
+     */
+    startedAt?: Date;
+    /**
+     * When the user first watched past 80% of it; null if not yet
+     */
+    finishedAt?: Date;
+};
 export type Image = {
     urls?: Array<string>;
     kind: 'IMAGE';
@@ -3527,6 +3561,49 @@ export type PutBoardByBoardIdRenameResponses = {
     204: void;
 };
 export type PutBoardByBoardIdRenameResponse = PutBoardByBoardIdRenameResponses[keyof PutBoardByBoardIdRenameResponses];
+export type DeleteApiAdminGuideVideosByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/guide-videos/{id}';
+};
+export type DeleteApiAdminGuideVideosByIdResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteApiAdminGuideVideosByIdResponse = DeleteApiAdminGuideVideosByIdResponses[keyof DeleteApiAdminGuideVideosByIdResponses];
+export type PutApiAdminGuideVideosByIdData = {
+    body: VideoRequest;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/guide-videos/{id}';
+};
+export type PutApiAdminGuideVideosByIdResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type PutApiAdminGuideVideosByIdResponse = PutApiAdminGuideVideosByIdResponses[keyof PutApiAdminGuideVideosByIdResponses];
+export type PutApiAdminGuideVideosOrderData = {
+    body: OrderRequest;
+    path?: never;
+    query?: never;
+    url: '/api/admin/guide-videos/order';
+};
+export type PutApiAdminGuideVideosOrderResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type PutApiAdminGuideVideosOrderResponse = PutApiAdminGuideVideosOrderResponses[keyof PutApiAdminGuideVideosOrderResponses];
 export type PutAgencySettingsInfoData = {
     body: UpdateAgencyInfoRequest;
     path?: never;
@@ -4383,6 +4460,36 @@ export type PostInternalPrincipleResponses = {
     200: AgencyPrincipalDto;
 };
 export type PostInternalPrincipleResponse = PostInternalPrincipleResponses[keyof PostInternalPrincipleResponses];
+export type PostGuideVideosByIdStartData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/guide-videos/{id}/start';
+};
+export type PostGuideVideosByIdStartResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type PostGuideVideosByIdStartResponse = PostGuideVideosByIdStartResponses[keyof PostGuideVideosByIdStartResponses];
+export type PostGuideVideosByIdFinishData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/guide-videos/{id}/finish';
+};
+export type PostGuideVideosByIdFinishResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type PostGuideVideosByIdFinishResponse = PostGuideVideosByIdFinishResponses[keyof PostGuideVideosByIdFinishResponses];
 export type PostConversationsByConversationIdReadData = {
     body?: never;
     path: {
@@ -4988,6 +5095,19 @@ export type PostApiAdminSubscriptionsCheckoutResponses = {
     201: AdminCheckoutResponse;
 };
 export type PostApiAdminSubscriptionsCheckoutResponse = PostApiAdminSubscriptionsCheckoutResponses[keyof PostApiAdminSubscriptionsCheckoutResponses];
+export type PostApiAdminGuideVideosData = {
+    body: VideoRequest;
+    path?: never;
+    query?: never;
+    url: '/api/admin/guide-videos';
+};
+export type PostApiAdminGuideVideosResponses = {
+    /**
+     * Created
+     */
+    201: Created;
+};
+export type PostApiAdminGuideVideosResponse = PostApiAdminGuideVideosResponses[keyof PostApiAdminGuideVideosResponses];
 export type PatchTaskByTaskIdPositionData = {
     body: PositionTaskRequest;
     path: {
@@ -5912,6 +6032,19 @@ export type GetInboxAgencyResponses = {
     200: CursorPageInboxResponse;
 };
 export type GetInboxAgencyResponse = GetInboxAgencyResponses[keyof GetInboxAgencyResponses];
+export type GetGuideVideosData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/guide-videos';
+};
+export type GetGuideVideosResponses = {
+    /**
+     * OK
+     */
+    200: Array<GuideVideoView>;
+};
+export type GetGuideVideosResponse = GetGuideVideosResponses[keyof GetGuideVideosResponses];
 export type GetConversationsByConversationIdUpdatesData = {
     body?: never;
     path: {