@cavuno/board 1.21.0 → 1.22.0
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.
- package/dist/index.d.mts +437 -63
- package/dist/index.d.ts +437 -63
- package/dist/index.js +256 -1
- package/dist/index.mjs +256 -1
- package/package.json +1 -1
- package/skills/manifest.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -12,6 +12,42 @@ interface components {
|
|
|
12
12
|
*/
|
|
13
13
|
admin: string;
|
|
14
14
|
};
|
|
15
|
+
Alert: {
|
|
16
|
+
/** @description Job-alert preference ID — also the path key. */
|
|
17
|
+
id: string;
|
|
18
|
+
/** @enum {string} */
|
|
19
|
+
object: "alert";
|
|
20
|
+
label: string | null;
|
|
21
|
+
/** @enum {string} */
|
|
22
|
+
frequency: "daily" | "weekly";
|
|
23
|
+
isActive: boolean;
|
|
24
|
+
filters: {
|
|
25
|
+
jobFunctions: string[];
|
|
26
|
+
seniorityLevels: string[];
|
|
27
|
+
remoteOptions: string[];
|
|
28
|
+
placeIds: string[];
|
|
29
|
+
salaryMin: number | null;
|
|
30
|
+
salaryMax: number | null;
|
|
31
|
+
salaryCurrency: string | null;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Format: date-time
|
|
35
|
+
* @description When this alert last dispatched a digest, or null.
|
|
36
|
+
*/
|
|
37
|
+
lastSentAt: string | null;
|
|
38
|
+
};
|
|
39
|
+
AlertBody: {
|
|
40
|
+
label?: string;
|
|
41
|
+
/** @enum {string} */
|
|
42
|
+
frequency: "daily" | "weekly";
|
|
43
|
+
jobFunctions?: string[];
|
|
44
|
+
seniorityLevels?: string[];
|
|
45
|
+
remoteOptions?: string[];
|
|
46
|
+
placeIds?: string[];
|
|
47
|
+
salaryMin?: number | null;
|
|
48
|
+
salaryMax?: number | null;
|
|
49
|
+
salaryCurrency?: string | null;
|
|
50
|
+
};
|
|
15
51
|
ApiKey: {
|
|
16
52
|
/** @description Unique identifier for the object. */
|
|
17
53
|
id: string;
|
|
@@ -37,6 +73,40 @@ interface components {
|
|
|
37
73
|
/** @description Time at which the key expires, or `null` if the key has no expiry. Unix epoch in milliseconds. */
|
|
38
74
|
expiresAt: number | null;
|
|
39
75
|
};
|
|
76
|
+
Application: {
|
|
77
|
+
/** @description Application ID — the `:applicationId` path key. */
|
|
78
|
+
id: string;
|
|
79
|
+
/** @enum {string} */
|
|
80
|
+
object: "application";
|
|
81
|
+
/**
|
|
82
|
+
* @description Coarse candidate-facing status derived from the employer pipeline stage.
|
|
83
|
+
* @enum {string}
|
|
84
|
+
*/
|
|
85
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
86
|
+
/** Format: date-time */
|
|
87
|
+
appliedAt: string;
|
|
88
|
+
/** Format: date-time */
|
|
89
|
+
updatedAt: string;
|
|
90
|
+
coverNote: string | null;
|
|
91
|
+
candidateName: string | null;
|
|
92
|
+
candidateEmail: string | null;
|
|
93
|
+
candidateLocation: string | null;
|
|
94
|
+
candidateHeadline: string | null;
|
|
95
|
+
resumeFilename: string | null;
|
|
96
|
+
job: {
|
|
97
|
+
id: string;
|
|
98
|
+
title: string;
|
|
99
|
+
slug: string | null;
|
|
100
|
+
companySlug: string | null;
|
|
101
|
+
companyName: string | null;
|
|
102
|
+
} | null;
|
|
103
|
+
};
|
|
104
|
+
ApplyBody: {
|
|
105
|
+
name?: string;
|
|
106
|
+
/** Format: email */
|
|
107
|
+
email?: string;
|
|
108
|
+
coverNote?: string;
|
|
109
|
+
};
|
|
40
110
|
AuditLogEntry: {
|
|
41
111
|
/** @description Unique identifier for the object. */
|
|
42
112
|
id: string;
|
|
@@ -2558,6 +2628,26 @@ interface components {
|
|
|
2558
2628
|
*/
|
|
2559
2629
|
admin: string;
|
|
2560
2630
|
};
|
|
2631
|
+
Resume: {
|
|
2632
|
+
/** @enum {string} */
|
|
2633
|
+
object: "resume";
|
|
2634
|
+
/**
|
|
2635
|
+
* @description Async parse state; poll GET /me/resume until parsed or failed.
|
|
2636
|
+
* @enum {string|null}
|
|
2637
|
+
*/
|
|
2638
|
+
parseStatus: "parsing" | "parsed" | "failed" | null;
|
|
2639
|
+
parseFailureReason: string | null;
|
|
2640
|
+
/** Format: date-time */
|
|
2641
|
+
parsedAt: string | null;
|
|
2642
|
+
keepResumeOnFile: boolean | null;
|
|
2643
|
+
hasResumeOnFile: boolean;
|
|
2644
|
+
file: {
|
|
2645
|
+
/** @description Short-lived signed download URL. */
|
|
2646
|
+
url: string;
|
|
2647
|
+
contentType: string;
|
|
2648
|
+
sizeBytes: number;
|
|
2649
|
+
} | null;
|
|
2650
|
+
};
|
|
2561
2651
|
RevokeRequest: {
|
|
2562
2652
|
/** @description The access or refresh token to revoke. */
|
|
2563
2653
|
token: string;
|
|
@@ -3166,6 +3256,14 @@ interface components {
|
|
|
3166
3256
|
channel: "messageEmails" | "applicationEmails";
|
|
3167
3257
|
token: string;
|
|
3168
3258
|
};
|
|
3259
|
+
UpdateApplicationFactsBody: {
|
|
3260
|
+
candidateName?: string;
|
|
3261
|
+
/** Format: email */
|
|
3262
|
+
candidateEmail?: string;
|
|
3263
|
+
candidateHeadline?: string;
|
|
3264
|
+
candidateLocation?: string;
|
|
3265
|
+
coverNote?: string;
|
|
3266
|
+
};
|
|
3169
3267
|
UpdateAuthorBody: {
|
|
3170
3268
|
/** @description URL-friendly slug for the author. Auto-generated from `name` when omitted. */
|
|
3171
3269
|
slug?: string;
|
|
@@ -3421,6 +3519,9 @@ interface components {
|
|
|
3421
3519
|
/** @description Slug of the account's current plan. */
|
|
3422
3520
|
plan: string;
|
|
3423
3521
|
};
|
|
3522
|
+
VerifyEmailOtpBody: {
|
|
3523
|
+
code: string;
|
|
3524
|
+
};
|
|
3424
3525
|
};
|
|
3425
3526
|
responses: never;
|
|
3426
3527
|
parameters: never;
|
|
@@ -3431,67 +3532,6 @@ interface components {
|
|
|
3431
3532
|
|
|
3432
3533
|
type Schemas = components['schemas'];
|
|
3433
3534
|
|
|
3434
|
-
type SavedJob = Schemas['SavedJob'];
|
|
3435
|
-
type SavedJobsListQuery = {
|
|
3436
|
-
cursor?: string;
|
|
3437
|
-
/** 1–100. */
|
|
3438
|
-
limit?: number;
|
|
3439
|
-
};
|
|
3440
|
-
type SaveJobBody = Schemas['SaveJobBody'];
|
|
3441
|
-
/** The authenticated user's lean candidate profile singleton. */
|
|
3442
|
-
type CandidateProfile = Schemas['CandidateProfile'];
|
|
3443
|
-
/** Optional-field merge-patch body for `board.me.profile.update`. */
|
|
3444
|
-
type UpdateCandidateProfileBody = Schemas['UpdateCandidateProfileBody'];
|
|
3445
|
-
/** The result of `board.me.profile.handleAvailable(handle)`. */
|
|
3446
|
-
type HandleAvailability = Schemas['HandleAvailability'];
|
|
3447
|
-
type CandidateExperience = Schemas['CandidateExperience'];
|
|
3448
|
-
type CreateExperienceBody = Schemas['CreateExperienceBody'];
|
|
3449
|
-
type UpdateExperienceBody = Schemas['UpdateExperienceBody'];
|
|
3450
|
-
type CandidateEducation = Schemas['CandidateEducation'];
|
|
3451
|
-
type CreateEducationBody = Schemas['CreateEducationBody'];
|
|
3452
|
-
type UpdateEducationBody = Schemas['UpdateEducationBody'];
|
|
3453
|
-
type CandidateSkill = Schemas['CandidateSkill'];
|
|
3454
|
-
type UpdateSkillsBody = Schemas['UpdateSkillsBody'];
|
|
3455
|
-
type CandidateLanguage = Schemas['CandidateLanguage'];
|
|
3456
|
-
type UpdateLanguagesBody = Schemas['UpdateLanguagesBody'];
|
|
3457
|
-
/** The result of `board.me.profile.uploadAvatar(file)`. */
|
|
3458
|
-
type CandidateAvatar = Schemas['CandidateAvatar'];
|
|
3459
|
-
type NotificationPreference = Schemas['NotificationPreference'];
|
|
3460
|
-
type UpdateNotificationPreferenceBody = Schemas['UpdateNotificationPreferenceBody'];
|
|
3461
|
-
type UnsubscribeBody = Schemas['UnsubscribeBody'];
|
|
3462
|
-
type CreateCompanyBody = Schemas['CreateCompanyBody'];
|
|
3463
|
-
type UpdateEmployerCompanyBody = Schemas['UpdateEmployerCompanyBody'];
|
|
3464
|
-
type SendWorkEmailBody = Schemas['SendWorkEmailBody'];
|
|
3465
|
-
type ConfirmWorkEmailBody = Schemas['ConfirmWorkEmailBody'];
|
|
3466
|
-
/** Query for `board.me.companies.search`. */
|
|
3467
|
-
type EmployerCompanySearchQuery = {
|
|
3468
|
-
q: string;
|
|
3469
|
-
/** 1–50. */
|
|
3470
|
-
limit?: number;
|
|
3471
|
-
};
|
|
3472
|
-
type CreateEmployerJobBody = Schemas['EmployerCreateJobBody'];
|
|
3473
|
-
type UpdateEmployerJobBody = Schemas['EmployerUpdateJobBody'];
|
|
3474
|
-
/** Query for `board.me.companies.jobs.list`. */
|
|
3475
|
-
type EmployerJobsListQuery = {
|
|
3476
|
-
/** 1–200 (default 200). */
|
|
3477
|
-
limit?: number;
|
|
3478
|
-
};
|
|
3479
|
-
type MoveApplicantStageBody = Schemas['MoveApplicantStageBody'];
|
|
3480
|
-
type BulkMoveApplicantsBody = Schemas['BulkMoveApplicantsBody'];
|
|
3481
|
-
type BulkRejectApplicantsBody = Schemas['BulkRejectApplicantsBody'];
|
|
3482
|
-
type AddApplicantNoteBody = Schemas['AddApplicantNoteBody'];
|
|
3483
|
-
type CreatePipelineStageBody = Schemas['CreatePipelineStageBody'];
|
|
3484
|
-
type UpdatePipelineStageBody = Schemas['UpdatePipelineStageBody'];
|
|
3485
|
-
type ReorderPipelineStagesBody = Schemas['ReorderPipelineStagesBody'];
|
|
3486
|
-
/** Query for `board.me.companies.applicants.list`. */
|
|
3487
|
-
type EmployerPipelineQuery = {
|
|
3488
|
-
/** The job id whose pipeline to read. */
|
|
3489
|
-
job: string;
|
|
3490
|
-
/** Filter to a single stage (systemStage key, custom stage id, or `applied`). */
|
|
3491
|
-
stage?: string;
|
|
3492
|
-
};
|
|
3493
|
-
type EmployerCheckoutBody = Schemas['EmployerCheckoutBody'];
|
|
3494
|
-
|
|
3495
3535
|
/**
|
|
3496
3536
|
* Stripe-shaped success envelopes (`01-conventions.md` §5.1). The
|
|
3497
3537
|
* server MAY add top-level fields; consumers MUST ignore unknown
|
|
@@ -3705,7 +3745,7 @@ declare function isConflict(e: unknown): e is BoardApiError;
|
|
|
3705
3745
|
* constant because the package is platform-neutral and cannot read
|
|
3706
3746
|
* package.json at runtime.
|
|
3707
3747
|
*/
|
|
3708
|
-
declare const SDK_VERSION = "1.
|
|
3748
|
+
declare const SDK_VERSION = "1.22.0";
|
|
3709
3749
|
|
|
3710
3750
|
type BoardUser = Schemas['BoardUser'];
|
|
3711
3751
|
type BoardAuthSession = Schemas['BoardAuthSession'];
|
|
@@ -3891,6 +3931,111 @@ type PlansListQuery = {
|
|
|
3891
3931
|
type PlanListEnvelope = ListEnvelope<Plan>;
|
|
3892
3932
|
type SalesLedPlanListEnvelope = ListEnvelope<SalesLedPlan>;
|
|
3893
3933
|
|
|
3934
|
+
type SavedJob = Schemas['SavedJob'];
|
|
3935
|
+
type SavedJobsListQuery = {
|
|
3936
|
+
cursor?: string;
|
|
3937
|
+
/** 1–100. */
|
|
3938
|
+
limit?: number;
|
|
3939
|
+
};
|
|
3940
|
+
type SaveJobBody = Schemas['SaveJobBody'];
|
|
3941
|
+
/** The authenticated user's lean candidate profile singleton. */
|
|
3942
|
+
type CandidateProfile = Schemas['CandidateProfile'];
|
|
3943
|
+
/** Optional-field merge-patch body for `board.me.profile.update`. */
|
|
3944
|
+
type UpdateCandidateProfileBody = Schemas['UpdateCandidateProfileBody'];
|
|
3945
|
+
/** The result of `board.me.profile.handleAvailable(handle)`. */
|
|
3946
|
+
type HandleAvailability = Schemas['HandleAvailability'];
|
|
3947
|
+
type CandidateExperience = Schemas['CandidateExperience'];
|
|
3948
|
+
type CreateExperienceBody = Schemas['CreateExperienceBody'];
|
|
3949
|
+
type UpdateExperienceBody = Schemas['UpdateExperienceBody'];
|
|
3950
|
+
type CandidateEducation = Schemas['CandidateEducation'];
|
|
3951
|
+
type CreateEducationBody = Schemas['CreateEducationBody'];
|
|
3952
|
+
type UpdateEducationBody = Schemas['UpdateEducationBody'];
|
|
3953
|
+
type CandidateSkill = Schemas['CandidateSkill'];
|
|
3954
|
+
type UpdateSkillsBody = Schemas['UpdateSkillsBody'];
|
|
3955
|
+
type CandidateLanguage = Schemas['CandidateLanguage'];
|
|
3956
|
+
type UpdateLanguagesBody = Schemas['UpdateLanguagesBody'];
|
|
3957
|
+
/** The result of `board.me.profile.uploadAvatar(file)`. */
|
|
3958
|
+
type CandidateAvatar = Schemas['CandidateAvatar'];
|
|
3959
|
+
type NotificationPreference = Schemas['NotificationPreference'];
|
|
3960
|
+
type UpdateNotificationPreferenceBody = Schemas['UpdateNotificationPreferenceBody'];
|
|
3961
|
+
type UnsubscribeBody = Schemas['UnsubscribeBody'];
|
|
3962
|
+
/** One of the authenticated board user's job-alert preferences. */
|
|
3963
|
+
type Alert = Schemas['Alert'];
|
|
3964
|
+
/** Create/replace body for `board.me.alerts.create` / `board.me.alerts.update`. */
|
|
3965
|
+
type AlertBody = Schemas['AlertBody'];
|
|
3966
|
+
/** The candidate's own view of an application they submitted. */
|
|
3967
|
+
type Application = Schemas['Application'];
|
|
3968
|
+
/** Body for `board.jobs.apply` (name/email omitted when signed in). */
|
|
3969
|
+
type ApplyBody = Schemas['ApplyBody'];
|
|
3970
|
+
/** Merge-patch body for `board.me.applications.updateFacts`. */
|
|
3971
|
+
type UpdateApplicationFactsBody = Schemas['UpdateApplicationFactsBody'];
|
|
3972
|
+
/** Query for `board.me.applications.list`. */
|
|
3973
|
+
type ApplicationsListQuery = {
|
|
3974
|
+
cursor?: string;
|
|
3975
|
+
/** 1–100. */
|
|
3976
|
+
limit?: number;
|
|
3977
|
+
};
|
|
3978
|
+
/** The candidate's resume state (async parse status + stored file). */
|
|
3979
|
+
type Resume = Schemas['Resume'];
|
|
3980
|
+
/** Options for `board.me.resume.upload`. */
|
|
3981
|
+
type ResumeUploadOptions = {
|
|
3982
|
+
keepResumeOnFile?: boolean;
|
|
3983
|
+
importMode?: 'append_only' | 'replace_all';
|
|
3984
|
+
confirmReplaceAll?: boolean;
|
|
3985
|
+
};
|
|
3986
|
+
/** The caller's tie to a company, with a computed claim `status`. */
|
|
3987
|
+
type CompanyMembership = Schemas['CompanyMembership'];
|
|
3988
|
+
/** The full editable company (`board.me.companies.update` echoes this). */
|
|
3989
|
+
type EmployerCompany = Schemas['EmployerCompany'];
|
|
3990
|
+
/** A search hit from `board.me.companies.search`. */
|
|
3991
|
+
type ClaimableCompany = Schemas['ClaimableCompany'];
|
|
3992
|
+
type CreateCompanyBody = Schemas['CreateCompanyBody'];
|
|
3993
|
+
type UpdateEmployerCompanyBody = Schemas['UpdateEmployerCompanyBody'];
|
|
3994
|
+
type SendWorkEmailBody = Schemas['SendWorkEmailBody'];
|
|
3995
|
+
type ConfirmWorkEmailBody = Schemas['ConfirmWorkEmailBody'];
|
|
3996
|
+
/** Query for `board.me.companies.search`. */
|
|
3997
|
+
type EmployerCompanySearchQuery = {
|
|
3998
|
+
q: string;
|
|
3999
|
+
/** 1–50. */
|
|
4000
|
+
limit?: number;
|
|
4001
|
+
};
|
|
4002
|
+
/** Flat list-item shape from `board.me.companies.jobs.list`. */
|
|
4003
|
+
type EmployerJobSummary = Schemas['EmployerJobSummary'];
|
|
4004
|
+
/** The full job from `board.me.companies.jobs.retrieve` + every mutation echo. */
|
|
4005
|
+
type EmployerJob = Schemas['EmployerJob'];
|
|
4006
|
+
type CreateEmployerJobBody = Schemas['EmployerCreateJobBody'];
|
|
4007
|
+
type UpdateEmployerJobBody = Schemas['EmployerUpdateJobBody'];
|
|
4008
|
+
/** Query for `board.me.companies.jobs.list`. */
|
|
4009
|
+
type EmployerJobsListQuery = {
|
|
4010
|
+
/** 1–200 (default 200). */
|
|
4011
|
+
limit?: number;
|
|
4012
|
+
};
|
|
4013
|
+
/** A job's full applicant pipeline (job header + stage rail + applicants). */
|
|
4014
|
+
type EmployerPipeline = Schemas['EmployerPipeline'];
|
|
4015
|
+
/** One applicant on a job's pipeline, with its activity timeline. */
|
|
4016
|
+
type EmployerApplicant = Schemas['EmployerApplicant'];
|
|
4017
|
+
/** One row of a job's stage rail. */
|
|
4018
|
+
type EmployerPipelineStage = Schemas['EmployerPipelineStage'];
|
|
4019
|
+
type MoveApplicantStageBody = Schemas['MoveApplicantStageBody'];
|
|
4020
|
+
type BulkMoveApplicantsBody = Schemas['BulkMoveApplicantsBody'];
|
|
4021
|
+
type BulkRejectApplicantsBody = Schemas['BulkRejectApplicantsBody'];
|
|
4022
|
+
type AddApplicantNoteBody = Schemas['AddApplicantNoteBody'];
|
|
4023
|
+
type CreatePipelineStageBody = Schemas['CreatePipelineStageBody'];
|
|
4024
|
+
type UpdatePipelineStageBody = Schemas['UpdatePipelineStageBody'];
|
|
4025
|
+
type ReorderPipelineStagesBody = Schemas['ReorderPipelineStagesBody'];
|
|
4026
|
+
/** Query for `board.me.companies.applicants.list`. */
|
|
4027
|
+
type EmployerPipelineQuery = {
|
|
4028
|
+
/** The job id whose pipeline to read. */
|
|
4029
|
+
job: string;
|
|
4030
|
+
/** Filter to a single stage (systemStage key, custom stage id, or `applied`). */
|
|
4031
|
+
stage?: string;
|
|
4032
|
+
};
|
|
4033
|
+
/** A reusable billing option (active subscription / pre-purchased bundle slot). */
|
|
4034
|
+
type EmployerBillingOption = Schemas['EmployerBillingOption'];
|
|
4035
|
+
/** The result of `board.me.companies.jobs.checkout`. */
|
|
4036
|
+
type EmployerCheckout = Schemas['EmployerCheckout'];
|
|
4037
|
+
type EmployerCheckoutBody = Schemas['EmployerCheckoutBody'];
|
|
4038
|
+
|
|
3894
4039
|
type JobAlertFrequency = 'daily' | 'weekly';
|
|
3895
4040
|
type JobAlertRemoteOption = 'on_site' | 'hybrid' | 'remote';
|
|
3896
4041
|
/**
|
|
@@ -4232,6 +4377,68 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
|
|
|
4232
4377
|
};
|
|
4233
4378
|
description?: string | null;
|
|
4234
4379
|
}>>;
|
|
4380
|
+
apply(jobSlug: string, body?: ApplyBody, options?: FetchOptions): Promise<{
|
|
4381
|
+
id: string;
|
|
4382
|
+
object: "application";
|
|
4383
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
4384
|
+
appliedAt: string;
|
|
4385
|
+
updatedAt: string;
|
|
4386
|
+
coverNote: string | null;
|
|
4387
|
+
candidateName: string | null;
|
|
4388
|
+
candidateEmail: string | null;
|
|
4389
|
+
candidateLocation: string | null;
|
|
4390
|
+
candidateHeadline: string | null;
|
|
4391
|
+
resumeFilename: string | null;
|
|
4392
|
+
job: {
|
|
4393
|
+
id: string;
|
|
4394
|
+
title: string;
|
|
4395
|
+
slug: string | null;
|
|
4396
|
+
companySlug: string | null;
|
|
4397
|
+
companyName: string | null;
|
|
4398
|
+
} | null;
|
|
4399
|
+
}>;
|
|
4400
|
+
uploadApplicationResume(jobSlug: string, file: Blob, opts?: {
|
|
4401
|
+
applicationId?: string;
|
|
4402
|
+
}, options?: FetchOptions): Promise<{
|
|
4403
|
+
id: string;
|
|
4404
|
+
object: "application";
|
|
4405
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
4406
|
+
appliedAt: string;
|
|
4407
|
+
updatedAt: string;
|
|
4408
|
+
coverNote: string | null;
|
|
4409
|
+
candidateName: string | null;
|
|
4410
|
+
candidateEmail: string | null;
|
|
4411
|
+
candidateLocation: string | null;
|
|
4412
|
+
candidateHeadline: string | null;
|
|
4413
|
+
resumeFilename: string | null;
|
|
4414
|
+
job: {
|
|
4415
|
+
id: string;
|
|
4416
|
+
title: string;
|
|
4417
|
+
slug: string | null;
|
|
4418
|
+
companySlug: string | null;
|
|
4419
|
+
companyName: string | null;
|
|
4420
|
+
} | null;
|
|
4421
|
+
}>;
|
|
4422
|
+
myApplication(jobSlug: string, options?: FetchOptions): Promise<{
|
|
4423
|
+
id: string;
|
|
4424
|
+
object: "application";
|
|
4425
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
4426
|
+
appliedAt: string;
|
|
4427
|
+
updatedAt: string;
|
|
4428
|
+
coverNote: string | null;
|
|
4429
|
+
candidateName: string | null;
|
|
4430
|
+
candidateEmail: string | null;
|
|
4431
|
+
candidateLocation: string | null;
|
|
4432
|
+
candidateHeadline: string | null;
|
|
4433
|
+
resumeFilename: string | null;
|
|
4434
|
+
job: {
|
|
4435
|
+
id: string;
|
|
4436
|
+
title: string;
|
|
4437
|
+
slug: string | null;
|
|
4438
|
+
companySlug: string | null;
|
|
4439
|
+
companyName: string | null;
|
|
4440
|
+
} | null;
|
|
4441
|
+
}>;
|
|
4235
4442
|
};
|
|
4236
4443
|
embed: {
|
|
4237
4444
|
jobs(query?: EmbedJobsQuery, options?: FetchOptions): Promise<ListEnvelope<{
|
|
@@ -4593,6 +4800,10 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
|
|
|
4593
4800
|
}>;
|
|
4594
4801
|
logout(body?: LogoutBody, options?: FetchOptions): Promise<void>;
|
|
4595
4802
|
verifyEmail(body: VerifyEmailBody, options?: FetchOptions): Promise<void>;
|
|
4803
|
+
verifyEmailWithCode(body: {
|
|
4804
|
+
code: string;
|
|
4805
|
+
}, options?: FetchOptions): Promise<void>;
|
|
4806
|
+
resendVerification(options?: FetchOptions): Promise<void>;
|
|
4596
4807
|
forgotPassword(body: ForgotPasswordBody, options?: FetchOptions): Promise<void>;
|
|
4597
4808
|
resetPassword(body: ResetPasswordBody, options?: FetchOptions): Promise<void>;
|
|
4598
4809
|
requestMagicLink(body: RequestMagicLinkBody, options?: FetchOptions): Promise<void>;
|
|
@@ -5186,6 +5397,169 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
|
|
|
5186
5397
|
reorder(slug: string, body: ReorderPipelineStagesBody, options?: FetchOptions): Promise<void>;
|
|
5187
5398
|
};
|
|
5188
5399
|
};
|
|
5400
|
+
alerts: {
|
|
5401
|
+
list(options?: FetchOptions): Promise<ListEnvelope<{
|
|
5402
|
+
id: string;
|
|
5403
|
+
object: "alert";
|
|
5404
|
+
label: string | null;
|
|
5405
|
+
frequency: "daily" | "weekly";
|
|
5406
|
+
isActive: boolean;
|
|
5407
|
+
filters: {
|
|
5408
|
+
jobFunctions: string[];
|
|
5409
|
+
seniorityLevels: string[];
|
|
5410
|
+
remoteOptions: string[];
|
|
5411
|
+
placeIds: string[];
|
|
5412
|
+
salaryMin: number | null;
|
|
5413
|
+
salaryMax: number | null;
|
|
5414
|
+
salaryCurrency: string | null;
|
|
5415
|
+
};
|
|
5416
|
+
lastSentAt: string | null;
|
|
5417
|
+
}>>;
|
|
5418
|
+
create(body: AlertBody, options?: FetchOptions): Promise<{
|
|
5419
|
+
id: string;
|
|
5420
|
+
object: "alert";
|
|
5421
|
+
label: string | null;
|
|
5422
|
+
frequency: "daily" | "weekly";
|
|
5423
|
+
isActive: boolean;
|
|
5424
|
+
filters: {
|
|
5425
|
+
jobFunctions: string[];
|
|
5426
|
+
seniorityLevels: string[];
|
|
5427
|
+
remoteOptions: string[];
|
|
5428
|
+
placeIds: string[];
|
|
5429
|
+
salaryMin: number | null;
|
|
5430
|
+
salaryMax: number | null;
|
|
5431
|
+
salaryCurrency: string | null;
|
|
5432
|
+
};
|
|
5433
|
+
lastSentAt: string | null;
|
|
5434
|
+
}>;
|
|
5435
|
+
retrieve(alertId: string, options?: FetchOptions): Promise<{
|
|
5436
|
+
id: string;
|
|
5437
|
+
object: "alert";
|
|
5438
|
+
label: string | null;
|
|
5439
|
+
frequency: "daily" | "weekly";
|
|
5440
|
+
isActive: boolean;
|
|
5441
|
+
filters: {
|
|
5442
|
+
jobFunctions: string[];
|
|
5443
|
+
seniorityLevels: string[];
|
|
5444
|
+
remoteOptions: string[];
|
|
5445
|
+
placeIds: string[];
|
|
5446
|
+
salaryMin: number | null;
|
|
5447
|
+
salaryMax: number | null;
|
|
5448
|
+
salaryCurrency: string | null;
|
|
5449
|
+
};
|
|
5450
|
+
lastSentAt: string | null;
|
|
5451
|
+
}>;
|
|
5452
|
+
update(alertId: string, body: AlertBody, options?: FetchOptions): Promise<{
|
|
5453
|
+
id: string;
|
|
5454
|
+
object: "alert";
|
|
5455
|
+
label: string | null;
|
|
5456
|
+
frequency: "daily" | "weekly";
|
|
5457
|
+
isActive: boolean;
|
|
5458
|
+
filters: {
|
|
5459
|
+
jobFunctions: string[];
|
|
5460
|
+
seniorityLevels: string[];
|
|
5461
|
+
remoteOptions: string[];
|
|
5462
|
+
placeIds: string[];
|
|
5463
|
+
salaryMin: number | null;
|
|
5464
|
+
salaryMax: number | null;
|
|
5465
|
+
salaryCurrency: string | null;
|
|
5466
|
+
};
|
|
5467
|
+
lastSentAt: string | null;
|
|
5468
|
+
}>;
|
|
5469
|
+
remove(alertId: string, options?: FetchOptions): Promise<void>;
|
|
5470
|
+
};
|
|
5471
|
+
applications: {
|
|
5472
|
+
list(query?: ApplicationsListQuery, options?: FetchOptions): Promise<ListEnvelope<{
|
|
5473
|
+
id: string;
|
|
5474
|
+
object: "application";
|
|
5475
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
5476
|
+
appliedAt: string;
|
|
5477
|
+
updatedAt: string;
|
|
5478
|
+
coverNote: string | null;
|
|
5479
|
+
candidateName: string | null;
|
|
5480
|
+
candidateEmail: string | null;
|
|
5481
|
+
candidateLocation: string | null;
|
|
5482
|
+
candidateHeadline: string | null;
|
|
5483
|
+
resumeFilename: string | null;
|
|
5484
|
+
job: {
|
|
5485
|
+
id: string;
|
|
5486
|
+
title: string;
|
|
5487
|
+
slug: string | null;
|
|
5488
|
+
companySlug: string | null;
|
|
5489
|
+
companyName: string | null;
|
|
5490
|
+
} | null;
|
|
5491
|
+
}>>;
|
|
5492
|
+
retrieve(applicationId: string, options?: FetchOptions): Promise<{
|
|
5493
|
+
id: string;
|
|
5494
|
+
object: "application";
|
|
5495
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
5496
|
+
appliedAt: string;
|
|
5497
|
+
updatedAt: string;
|
|
5498
|
+
coverNote: string | null;
|
|
5499
|
+
candidateName: string | null;
|
|
5500
|
+
candidateEmail: string | null;
|
|
5501
|
+
candidateLocation: string | null;
|
|
5502
|
+
candidateHeadline: string | null;
|
|
5503
|
+
resumeFilename: string | null;
|
|
5504
|
+
job: {
|
|
5505
|
+
id: string;
|
|
5506
|
+
title: string;
|
|
5507
|
+
slug: string | null;
|
|
5508
|
+
companySlug: string | null;
|
|
5509
|
+
companyName: string | null;
|
|
5510
|
+
} | null;
|
|
5511
|
+
}>;
|
|
5512
|
+
updateFacts(applicationId: string, body: UpdateApplicationFactsBody, options?: FetchOptions): Promise<{
|
|
5513
|
+
id: string;
|
|
5514
|
+
object: "application";
|
|
5515
|
+
status: "applied" | "interviewing" | "negotiation" | "hired" | "archived";
|
|
5516
|
+
appliedAt: string;
|
|
5517
|
+
updatedAt: string;
|
|
5518
|
+
coverNote: string | null;
|
|
5519
|
+
candidateName: string | null;
|
|
5520
|
+
candidateEmail: string | null;
|
|
5521
|
+
candidateLocation: string | null;
|
|
5522
|
+
candidateHeadline: string | null;
|
|
5523
|
+
resumeFilename: string | null;
|
|
5524
|
+
job: {
|
|
5525
|
+
id: string;
|
|
5526
|
+
title: string;
|
|
5527
|
+
slug: string | null;
|
|
5528
|
+
companySlug: string | null;
|
|
5529
|
+
companyName: string | null;
|
|
5530
|
+
} | null;
|
|
5531
|
+
}>;
|
|
5532
|
+
withdraw(applicationId: string, options?: FetchOptions): Promise<void>;
|
|
5533
|
+
};
|
|
5534
|
+
resume: {
|
|
5535
|
+
upload(file: Blob, opts?: ResumeUploadOptions, options?: FetchOptions): Promise<{
|
|
5536
|
+
object: "resume";
|
|
5537
|
+
parseStatus: "parsing" | "parsed" | "failed" | null;
|
|
5538
|
+
parseFailureReason: string | null;
|
|
5539
|
+
parsedAt: string | null;
|
|
5540
|
+
keepResumeOnFile: boolean | null;
|
|
5541
|
+
hasResumeOnFile: boolean;
|
|
5542
|
+
file: {
|
|
5543
|
+
url: string;
|
|
5544
|
+
contentType: string;
|
|
5545
|
+
sizeBytes: number;
|
|
5546
|
+
} | null;
|
|
5547
|
+
}>;
|
|
5548
|
+
retrieve(options?: FetchOptions): Promise<{
|
|
5549
|
+
object: "resume";
|
|
5550
|
+
parseStatus: "parsing" | "parsed" | "failed" | null;
|
|
5551
|
+
parseFailureReason: string | null;
|
|
5552
|
+
parsedAt: string | null;
|
|
5553
|
+
keepResumeOnFile: boolean | null;
|
|
5554
|
+
hasResumeOnFile: boolean;
|
|
5555
|
+
file: {
|
|
5556
|
+
url: string;
|
|
5557
|
+
contentType: string;
|
|
5558
|
+
sizeBytes: number;
|
|
5559
|
+
} | null;
|
|
5560
|
+
}>;
|
|
5561
|
+
delete(options?: FetchOptions): Promise<void>;
|
|
5562
|
+
};
|
|
5189
5563
|
savedJobs: {
|
|
5190
5564
|
list(query?: SavedJobsListQuery, options?: FetchOptions): Promise<ListEnvelope<{
|
|
5191
5565
|
id: string;
|
|
@@ -5902,4 +6276,4 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
|
|
|
5902
6276
|
};
|
|
5903
6277
|
type BoardSdk = ReturnType<typeof createBoardClient>;
|
|
5904
6278
|
|
|
5905
|
-
export { ACCESS_TOKEN_KEY, 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 CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanySalary, type CompanySimilarQuery, type ConsumeMagicLinkBody, type CreateBoardClientOptions, type CreateEducationBody, type CreateExperienceBody, type CreateJobPostingInput, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, 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 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 RequestMagicLinkBody, type ResetPasswordBody, 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 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 UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
|
|
6279
|
+
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 };
|