@cavuno/board 1.22.0 → 1.23.0

package/dist/index.d.mts

@@ -169,6 +169,30 @@ interface components {
                 resourceId: string;
             })[];
         };
+        Block: {
+            /** @enum {string} */
+            object: "block";
+            /** @enum {boolean} */
+            blocked: true;
+        };
+        BlockStatus: {
+            /** @enum {string} */
+            object: "block_status";
+            blocked: boolean;
+        };
+        BlockUserBody: {
+            boardUserId: string;
+        };
+        BlockedUser: {
+            id: string;
+            /** @enum {string} */
+            object: "blocked_user";
+            boardUserId: string;
+            displayName: string;
+            avatarUrl: string | null;
+            /** Format: date-time */
+            createdAt: string;
+        };
         BlogAuthor: {
             /** @description Unique identifier for the object. Use this value as the `{id}` path parameter for the author endpoints (e.g. `GET /v1/blog/authors/{id}`). */
             id: string;
@@ -718,6 +742,43 @@ interface components {
         ConfirmWorkEmailBody: {
             token: string;
         };
+        Conversation: {
+            id: string;
+            /** @enum {string} */
+            object: "conversation";
+            /** Format: date-time */
+            lastMessageAt: string;
+            lastMessageSnippet: string;
+            lastMessageAuthorBoardUserId: string;
+            /** Format: date-time */
+            archivedAt: string | null;
+            hasUnread: boolean;
+            counterparty: components["schemas"]["ConversationCounterparty"];
+        };
+        ConversationArchive: {
+            /** @enum {string} */
+            object: "conversation_archive";
+            /** Format: date-time */
+            archivedAt: string | null;
+        };
+        ConversationCounterparty: {
+            boardUserId: string;
+            displayName: string;
+            avatarUrl: string | null;
+            companyName: string | null;
+            handle: string | null;
+            companySlug: string | null;
+        };
+        ConversationDetail: components["schemas"]["Conversation"] & {
+            /** @enum {string} */
+            viewerRole: "employer" | "candidate";
+            viewerLastReadMessageId: string | null;
+        };
+        ConversationRef: {
+            /** @enum {string} */
+            object: "conversation_ref";
+            conversationId: string | null;
+        };
         CreateAuthorBody: {
             /** @description URL-friendly slug for the author. Auto-generated from `name` when omitted. */
             slug?: string;
@@ -1072,6 +1133,9 @@ interface components {
             /** @description Space-separated list of scopes the client may request. */
             scope: string;
         };
+        EditMessageBody: {
+            body: string;
+        };
         EmployerApplicant: {
             id: string;
             /** @enum {string} */
@@ -1970,6 +2034,35 @@ interface components {
              */
             purpose: "board_logo" | "board_hero" | "account_avatar" | "company_logo" | "blog_image";
         };
+        Message: {
+            id: string;
+            /** @enum {string} */
+            object: "message";
+            conversationId: string;
+            authorBoardUserId: string;
+            recipientBoardUserId: string;
+            body: string;
+            author: components["schemas"]["MessageAuthor"];
+            /** Format: date-time */
+            sentAt: string;
+            /** Format: date-time */
+            editedAt: string | null;
+            /** Format: date-time */
+            deletedAt: string | null;
+            /** Format: date-time */
+            readAt: string | null;
+        };
+        MessageAuthor: {
+            displayName: string;
+            avatarUrl: string | null;
+            companyName: string | null;
+        };
+        ModerationReport: {
+            /** @enum {string} */
+            object: "moderation_report";
+            id: string;
+            blocked: boolean;
+        };
         MoveApplicantStageBody: {
             /** @description The target stage id. */
             stageId: string;
@@ -2587,6 +2680,12 @@ interface components {
              */
             expiresAt?: string | null;
         };
+        ReadReceipt: {
+            /** @enum {string} */
+            object: "read_receipt";
+            /** Format: date-time */
+            markedAt: string;
+        };
         RedirectResolution: {
             /** @enum {string} */
             object: "redirect_resolution";
@@ -2616,6 +2715,14 @@ interface components {
             /** @description Every stage id of the job, in the new order. */
             orderedStageIds: string[];
         };
+        ReplyBody: {
+            body: string;
+        };
+        ReportBody: {
+            /** @enum {string} */
+            reason: "spam" | "harassment" | "misrepresentation" | "other";
+            freeText?: string;
+        };
         ResourceLinks: {
             /**
              * Format: uri
@@ -2987,6 +3094,14 @@ interface components {
             boardMedianMax: number | null;
             currency: string;
         };
+        StartAboutApplicationBody: {
+            applicationId: string;
+            body: string;
+        };
+        StartConversationBody: {
+            candidateBoardUserId: string;
+            body: string;
+        };
         TalentDirectoryEntry: {
             /** @enum {string} */
             object: "talent_directory_entry";
@@ -3250,6 +3365,11 @@ interface components {
             /** @description Space-separated list of scopes granted on the issued token. */
             scope: string;
         };
+        UnreadCount: {
+            /** @enum {string} */
+            object: "unread_count";
+            count: number;
+        };
         UnsubscribeBody: {
             boardUserId: string;
             /** @enum {string} */
@@ -3745,7 +3865,7 @@ declare function isConflict(e: unknown): e is BoardApiError;
  * constant because the package is platform-neutral and cannot read
  * package.json at runtime.
  */
-declare const SDK_VERSION = "1.22.0";
+declare const SDK_VERSION = "1.23.0";
 
 type BoardUser = Schemas['BoardUser'];
 type BoardAuthSession = Schemas['BoardAuthSession'];
@@ -3959,6 +4079,22 @@ type CandidateAvatar = Schemas['CandidateAvatar'];
 type NotificationPreference = Schemas['NotificationPreference'];
 type UpdateNotificationPreferenceBody = Schemas['UpdateNotificationPreferenceBody'];
 type UnsubscribeBody = Schemas['UnsubscribeBody'];
+/** One inbox row — the counterparty identity is live-resolved. */
+type Conversation = Schemas['Conversation'];
+/** A conversation header — adds the viewer's role + last-read pointer. */
+type ConversationDetail = Schemas['ConversationDetail'];
+/** One message in a thread. `body` is `''` when unsent (tombstoned). */
+type Message = Schemas['Message'];
+/** The distinct-unread-thread count for the inbox badge. */
+type UnreadCount = Schemas['UnreadCount'];
+/** Query for `board.me.conversations.list`. */
+type ConversationsListQuery = {
+    /** `true` for the archived view; omit/false for the main inbox. */
+    archived?: boolean;
+    cursor?: string;
+    /** 1–100. */
+    limit?: number;
+};
 /** One of the authenticated board user's job-alert preferences. */
 type Alert = Schemas['Alert'];
 /** Create/replace body for `board.me.alerts.create` / `board.me.alerts.update`. */
@@ -3975,6 +4111,42 @@ type ApplicationsListQuery = {
     /** 1–100. */
     limit?: number;
 };
+/** Query for `board.me.conversations.listMessages`. */
+type ThreadMessagesQuery = {
+    cursor?: string;
+    /** 1–200. */
+    limit?: number;
+};
+/** Body for `board.me.conversations.start` (cold-initiate a candidate). */
+type StartConversationBody = Schemas['StartConversationBody'];
+/** Body for `board.me.conversations.startAboutApplication` (message an applicant). */
+type StartAboutApplicationBody = Schemas['StartAboutApplicationBody'];
+/** Body for `board.me.conversations.reply`. */
+type ReplyBody = Schemas['ReplyBody'];
+/** The result of `board.me.conversations.markRead`. */
+type ReadReceipt = Schemas['ReadReceipt'];
+/** The result of `board.me.conversations.{archive,unarchive}`. */
+type ConversationArchive = Schemas['ConversationArchive'];
+/** Body for `board.me.messages.edit`. */
+type EditMessageBody = Schemas['EditMessageBody'];
+/** Body for `board.me.messages.report`. */
+type ReportBody = Schemas['ReportBody'];
+/** The result of `board.me.messages.report` (with the auto-block outcome). */
+type ModerationReport = Schemas['ModerationReport'];
+/** One blocked user from `board.me.blocks.list`. */
+type BlockedUser = Schemas['BlockedUser'];
+/** Body for `board.me.blocks.create`. */
+type BlockUserBody = Schemas['BlockUserBody'];
+/** The result of `board.me.blocks.create`. */
+type Block = Schemas['Block'];
+/** The result of `board.me.blocks.status`. */
+type BlockStatus = Schemas['BlockStatus'];
+/** The result of `board.me.conversations.findExisting`. */
+type ConversationRef = Schemas['ConversationRef'];
+/** Query for `board.me.conversations.findExisting`. */
+type FindExistingConversationQuery = {
+    candidateBoardUserId: string;
+};
 /** The candidate's resume state (async parse status + stored file). */
 type Resume = Schemas['Resume'];
 /** Options for `board.me.resume.upload`. */
@@ -5577,6 +5749,155 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
             }>;
             unsave(jobId: string, query?: Record<string, never>, options?: FetchOptions): Promise<void>;
         };
+        conversations: {
+            list(query?: ConversationsListQuery, options?: FetchOptions): Promise<ListEnvelope<{
+                id: string;
+                object: "conversation";
+                lastMessageAt: string;
+                lastMessageSnippet: string;
+                lastMessageAuthorBoardUserId: string;
+                archivedAt: string | null;
+                hasUnread: boolean;
+                counterparty: components["schemas"]["ConversationCounterparty"];
+            }>>;
+            unreadCount(options?: FetchOptions): Promise<{
+                object: "unread_count";
+                count: number;
+            }>;
+            retrieve(id: string, options?: FetchOptions): Promise<{
+                id: string;
+                object: "conversation";
+                lastMessageAt: string;
+                lastMessageSnippet: string;
+                lastMessageAuthorBoardUserId: string;
+                archivedAt: string | null;
+                hasUnread: boolean;
+                counterparty: components["schemas"]["ConversationCounterparty"];
+            } & {
+                viewerRole: "employer" | "candidate";
+                viewerLastReadMessageId: string | null;
+            }>;
+            listMessages(id: string, query?: ThreadMessagesQuery, options?: FetchOptions): Promise<ListEnvelope<{
+                id: string;
+                object: "message";
+                conversationId: string;
+                authorBoardUserId: string;
+                recipientBoardUserId: string;
+                body: string;
+                author: components["schemas"]["MessageAuthor"];
+                sentAt: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                readAt: string | null;
+            }>>;
+            start(body: StartConversationBody, options?: FetchOptions): Promise<{
+                id: string;
+                object: "message";
+                conversationId: string;
+                authorBoardUserId: string;
+                recipientBoardUserId: string;
+                body: string;
+                author: components["schemas"]["MessageAuthor"];
+                sentAt: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                readAt: string | null;
+            }>;
+            startAboutApplication(body: StartAboutApplicationBody, options?: FetchOptions): Promise<{
+                id: string;
+                object: "message";
+                conversationId: string;
+                authorBoardUserId: string;
+                recipientBoardUserId: string;
+                body: string;
+                author: components["schemas"]["MessageAuthor"];
+                sentAt: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                readAt: string | null;
+            }>;
+            reply(id: string, body: ReplyBody, options?: FetchOptions): Promise<{
+                id: string;
+                object: "message";
+                conversationId: string;
+                authorBoardUserId: string;
+                recipientBoardUserId: string;
+                body: string;
+                author: components["schemas"]["MessageAuthor"];
+                sentAt: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                readAt: string | null;
+            }>;
+            markRead(id: string, options?: FetchOptions): Promise<{
+                object: "read_receipt";
+                markedAt: string;
+            }>;
+            archive(id: string, options?: FetchOptions): Promise<{
+                object: "conversation_archive";
+                archivedAt: string | null;
+            }>;
+            unarchive(id: string, options?: FetchOptions): Promise<{
+                object: "conversation_archive";
+                archivedAt: string | null;
+            }>;
+            findExisting(query: FindExistingConversationQuery, options?: FetchOptions): Promise<{
+                object: "conversation_ref";
+                conversationId: string | null;
+            }>;
+        };
+        blocks: {
+            list(options?: FetchOptions): Promise<ListEnvelope<{
+                id: string;
+                object: "blocked_user";
+                boardUserId: string;
+                displayName: string;
+                avatarUrl: string | null;
+                createdAt: string;
+            }>>;
+            create(body: BlockUserBody, options?: FetchOptions): Promise<{
+                object: "block";
+                blocked: true;
+            }>;
+            remove(boardUserId: string, options?: FetchOptions): Promise<void>;
+            status(boardUserId: string, options?: FetchOptions): Promise<{
+                object: "block_status";
+                blocked: boolean;
+            }>;
+        };
+        messages: {
+            edit(id: string, body: EditMessageBody, options?: FetchOptions): Promise<{
+                id: string;
+                object: "message";
+                conversationId: string;
+                authorBoardUserId: string;
+                recipientBoardUserId: string;
+                body: string;
+                author: components["schemas"]["MessageAuthor"];
+                sentAt: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                readAt: string | null;
+            }>;
+            unsend(id: string, options?: FetchOptions): Promise<{
+                id: string;
+                object: "message";
+                conversationId: string;
+                authorBoardUserId: string;
+                recipientBoardUserId: string;
+                body: string;
+                author: components["schemas"]["MessageAuthor"];
+                sentAt: string;
+                editedAt: string | null;
+                deletedAt: string | null;
+                readAt: string | null;
+            }>;
+            report(id: string, body: ReportBody, options?: FetchOptions): Promise<{
+                object: "moderation_report";
+                id: string;
+                blocked: boolean;
+            }>;
+        };
     };
     password: {
         verify(password: string, options?: FetchOptions): Promise<BoardAccessGrant>;
@@ -6276,4 +6597,4 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type AddApplicantNoteBody, type Alert, type AlertBody, type Application, type ApplicationsListQuery, type ApplyBody, type Awaitable, BOARD_ACCESS_GRANT_KEY, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type BulkMoveApplicantsBody, type BulkRejectApplicantsBody, type CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type ClaimableCompany, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanyMembership, type CompanySalary, type CompanySimilarQuery, type ConfirmWorkEmailBody, type ConsumeMagicLinkBody, type CreateBoardClientOptions, type CreateCompanyBody, type CreateEducationBody, type CreateEmployerJobBody, type CreateExperienceBody, type CreateJobPostingInput, type CreatePipelineStageBody, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmployerApplicant, type EmployerBillingOption, type EmployerCheckout, type EmployerCheckoutBody, type EmployerCompany, type EmployerCompanySearchQuery, type EmployerJob, type EmployerJobSummary, type EmployerJobsListQuery, type EmployerPipeline, type EmployerPipelineQuery, type EmployerPipelineStage, type EmploymentType, type FetchOptions, type ForgotPasswordBody, type HandleAvailability, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobPostingBillingCheck, type JobPostingBillingOptions, type JobPostingBillingVerification, type JobPostingLogoResult, type JobPostingPlan, type JobPostingResult, type JobPostingSubscriptionEntitlements, type JobSort, type JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type LocationSkillsIndex, type LocationTitlesIndex, type Logger, type LoginBody, type LogoutBody, type MoveApplicantStageBody, type NotificationPreference, type OAuthAuthorizationQuery, type OAuthAuthorizationUrl, type OAuthExchangeBody, type OAuthProvider, type OfficeLocation, type PlacesListQuery, type Plan, type PlanListEnvelope, type PlansListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicCompanyDetail, type PublicJob, type PublicJobCard, type PublicLegalPage, type PublicPlace, REFRESH_TOKEN_KEY, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ReorderPipelineStagesBody, type RequestMagicLinkBody, type ResetPasswordBody, type Resume, type ResumeUploadOptions, SDK_VERSION, type SalaryCompany, type SalaryDetailQuery, type SalaryLocation, type SalarySkill, type SalaryTitle, type SalesLedPlan, type SalesLedPlanListEnvelope, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type SendWorkEmailBody, type Seniority, type SkillLocationSalary, type SkillLocationsIndex, type SkillSalaryDetail, type StorageMode, type StorefrontPagination, type TalentDirectoryEntry, type TalentDirectoryListEnvelope, type TalentDirectoryQuery, type TalentProfile, type TaxonomyGeo, type TaxonomyResolution, type TitleLocationSalary, type TitleLocationsIndex, type TitleSalaryDetail, type UnsubscribeBody, type UpdateApplicationFactsBody, type UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateEmployerCompanyBody, type UpdateEmployerJobBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdatePipelineStageBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type AddApplicantNoteBody, type Alert, type AlertBody, type Application, type ApplicationsListQuery, type ApplyBody, type Awaitable, BOARD_ACCESS_GRANT_KEY, type Block, type BlockStatus, type BlockUserBody, type BlockedUser, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type BulkMoveApplicantsBody, type BulkRejectApplicantsBody, type CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type ClaimableCompany, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanyMembership, type CompanySalary, type CompanySimilarQuery, type ConfirmWorkEmailBody, type ConsumeMagicLinkBody, type Conversation, type ConversationArchive, type ConversationDetail, type ConversationRef, type ConversationsListQuery, type CreateBoardClientOptions, type CreateCompanyBody, type CreateEducationBody, type CreateEmployerJobBody, type CreateExperienceBody, type CreateJobPostingInput, type CreatePipelineStageBody, type CustomStorage, type EditMessageBody, type EducationRequirement, type EmbedJobsQuery, type EmployerApplicant, type EmployerBillingOption, type EmployerCheckout, type EmployerCheckoutBody, type EmployerCompany, type EmployerCompanySearchQuery, type EmployerJob, type EmployerJobSummary, type EmployerJobsListQuery, type EmployerPipeline, type EmployerPipelineQuery, type EmployerPipelineStage, type EmploymentType, type FetchOptions, type FindExistingConversationQuery, type ForgotPasswordBody, type HandleAvailability, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobPostingBillingCheck, type JobPostingBillingOptions, type JobPostingBillingVerification, type JobPostingLogoResult, type JobPostingPlan, type JobPostingResult, type JobPostingSubscriptionEntitlements, type JobSort, type JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type LocationSkillsIndex, type LocationTitlesIndex, type Logger, type LoginBody, type LogoutBody, type Message, type ModerationReport, type MoveApplicantStageBody, type NotificationPreference, type OAuthAuthorizationQuery, type OAuthAuthorizationUrl, type OAuthExchangeBody, type OAuthProvider, type OfficeLocation, type PlacesListQuery, type Plan, type PlanListEnvelope, type PlansListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicCompanyDetail, type PublicJob, type PublicJobCard, type PublicLegalPage, type PublicPlace, REFRESH_TOKEN_KEY, type ReadReceipt, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ReorderPipelineStagesBody, type ReplyBody, type ReportBody, type RequestMagicLinkBody, type ResetPasswordBody, type Resume, type ResumeUploadOptions, SDK_VERSION, type SalaryCompany, type SalaryDetailQuery, type SalaryLocation, type SalarySkill, type SalaryTitle, type SalesLedPlan, type SalesLedPlanListEnvelope, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type SendWorkEmailBody, type Seniority, type SkillLocationSalary, type SkillLocationsIndex, type SkillSalaryDetail, type StartAboutApplicationBody, type StartConversationBody, type StorageMode, type StorefrontPagination, type TalentDirectoryEntry, type TalentDirectoryListEnvelope, type TalentDirectoryQuery, type TalentProfile, type TaxonomyGeo, type TaxonomyResolution, type ThreadMessagesQuery, type TitleLocationSalary, type TitleLocationsIndex, type TitleSalaryDetail, type UnreadCount, type UnsubscribeBody, type UpdateApplicationFactsBody, type UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateEmployerCompanyBody, type UpdateEmployerJobBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdatePipelineStageBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };