@cavuno/board 1.8.0 → 1.9.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 +441 -2
- package/dist/index.d.ts +441 -2
- package/dist/index.js +33 -2
- package/dist/index.mjs +33 -2
- package/package.json +1 -1
- package/skills/manifest.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -887,6 +887,87 @@ interface components {
|
|
|
887
887
|
address: string | null;
|
|
888
888
|
} | null;
|
|
889
889
|
};
|
|
890
|
+
LocationSalaryDetail: {
|
|
891
|
+
/** @enum {string} */
|
|
892
|
+
object: "location_salary_detail";
|
|
893
|
+
/** @description Immutable English source place slug — the salary-stats key. */
|
|
894
|
+
sourceSlug: string;
|
|
895
|
+
/** @description Board-language canonical URL slug — the starter 308 target. */
|
|
896
|
+
canonicalSlug: string;
|
|
897
|
+
placeName: string;
|
|
898
|
+
placeId: string;
|
|
899
|
+
adminLevel: string;
|
|
900
|
+
countryCode: string;
|
|
901
|
+
overallSalary: {
|
|
902
|
+
avgMin: number;
|
|
903
|
+
avgMax: number;
|
|
904
|
+
medianMin: number;
|
|
905
|
+
medianMax: number;
|
|
906
|
+
p25Min: number;
|
|
907
|
+
p75Max: number;
|
|
908
|
+
jobCount: number;
|
|
909
|
+
} | null;
|
|
910
|
+
childLocations: {
|
|
911
|
+
placeName: string;
|
|
912
|
+
placeSlug: string;
|
|
913
|
+
countryCode: string;
|
|
914
|
+
avgSalaryMin: number;
|
|
915
|
+
avgSalaryMax: number;
|
|
916
|
+
medianSalaryMin: number;
|
|
917
|
+
medianSalaryMax: number;
|
|
918
|
+
p25SalaryMin: number;
|
|
919
|
+
p75SalaryMax: number;
|
|
920
|
+
jobCount: number;
|
|
921
|
+
currency: string;
|
|
922
|
+
}[];
|
|
923
|
+
childLocationsByRegion: {
|
|
924
|
+
regionName: string;
|
|
925
|
+
regionSlug: string;
|
|
926
|
+
cities: {
|
|
927
|
+
placeName: string;
|
|
928
|
+
placeSlug: string;
|
|
929
|
+
countryCode: string;
|
|
930
|
+
avgSalaryMin: number;
|
|
931
|
+
avgSalaryMax: number;
|
|
932
|
+
medianSalaryMin: number;
|
|
933
|
+
medianSalaryMax: number;
|
|
934
|
+
p25SalaryMin: number;
|
|
935
|
+
p75SalaryMax: number;
|
|
936
|
+
jobCount: number;
|
|
937
|
+
currency: string;
|
|
938
|
+
}[];
|
|
939
|
+
}[];
|
|
940
|
+
topCategories: {
|
|
941
|
+
avgSalaryMin: number;
|
|
942
|
+
avgSalaryMax: number;
|
|
943
|
+
jobCount: number;
|
|
944
|
+
categorySlug: string;
|
|
945
|
+
categoryName: string;
|
|
946
|
+
}[];
|
|
947
|
+
topSkills: {
|
|
948
|
+
avgSalaryMin: number;
|
|
949
|
+
avgSalaryMax: number;
|
|
950
|
+
jobCount: number;
|
|
951
|
+
skillSlug: string;
|
|
952
|
+
skillName: string;
|
|
953
|
+
}[];
|
|
954
|
+
siblingLocations: {
|
|
955
|
+
placeName: string;
|
|
956
|
+
placeSlug: string;
|
|
957
|
+
countryCode: string;
|
|
958
|
+
avgSalaryMin: number;
|
|
959
|
+
avgSalaryMax: number;
|
|
960
|
+
medianSalaryMin: number;
|
|
961
|
+
medianSalaryMax: number;
|
|
962
|
+
p25SalaryMin: number;
|
|
963
|
+
p75SalaryMax: number;
|
|
964
|
+
jobCount: number;
|
|
965
|
+
currency: string;
|
|
966
|
+
}[];
|
|
967
|
+
boardOverallAvgMin: number | null;
|
|
968
|
+
boardOverallAvgMax: number | null;
|
|
969
|
+
currency: string;
|
|
970
|
+
};
|
|
890
971
|
MediaGet: components["schemas"]["MediaUpload"] & {
|
|
891
972
|
/** @description Time at which the file was uploaded. ISO 8601 datetime. */
|
|
892
973
|
uploadedAt: string;
|
|
@@ -1654,6 +1735,69 @@ interface components {
|
|
|
1654
1735
|
/** @description Stripe billing-portal configuration ID used for self-serve plan management. Pass `null` to clear. */
|
|
1655
1736
|
jobAccessStripePortalConfigId?: string | unknown | unknown;
|
|
1656
1737
|
};
|
|
1738
|
+
SkillSalaryDetail: {
|
|
1739
|
+
/** @enum {string} */
|
|
1740
|
+
object: "skill_salary_detail";
|
|
1741
|
+
/** @description Immutable English source slug — the salary-stats key. */
|
|
1742
|
+
sourceSlug: string;
|
|
1743
|
+
/** @description Board-language canonical URL slug — the starter 308 target. */
|
|
1744
|
+
canonicalSlug: string;
|
|
1745
|
+
skillName: string;
|
|
1746
|
+
overallSalary: {
|
|
1747
|
+
avgMin: number;
|
|
1748
|
+
avgMax: number;
|
|
1749
|
+
medianMin: number;
|
|
1750
|
+
medianMax: number;
|
|
1751
|
+
p25Min: number;
|
|
1752
|
+
p75Max: number;
|
|
1753
|
+
jobCount: number;
|
|
1754
|
+
} | null;
|
|
1755
|
+
bySeniority: {
|
|
1756
|
+
seniority: string;
|
|
1757
|
+
avgSalaryMin: number;
|
|
1758
|
+
avgSalaryMax: number;
|
|
1759
|
+
jobCount: number;
|
|
1760
|
+
boardAvgMin: number | null;
|
|
1761
|
+
boardAvgMax: number | null;
|
|
1762
|
+
diffPercent: number | null;
|
|
1763
|
+
}[];
|
|
1764
|
+
topCompanies: {
|
|
1765
|
+
avgSalaryMin: number;
|
|
1766
|
+
avgSalaryMax: number;
|
|
1767
|
+
jobCount: number;
|
|
1768
|
+
companySlug: string;
|
|
1769
|
+
companyName: string;
|
|
1770
|
+
logoPath: string | null;
|
|
1771
|
+
}[];
|
|
1772
|
+
topLocations: {
|
|
1773
|
+
avgSalaryMin: number;
|
|
1774
|
+
avgSalaryMax: number;
|
|
1775
|
+
jobCount: number;
|
|
1776
|
+
placeName: string;
|
|
1777
|
+
placeSlug: string;
|
|
1778
|
+
countryCode: string;
|
|
1779
|
+
}[];
|
|
1780
|
+
topTitles: {
|
|
1781
|
+
avgSalaryMin: number;
|
|
1782
|
+
avgSalaryMax: number;
|
|
1783
|
+
jobCount: number;
|
|
1784
|
+
categorySlug: string;
|
|
1785
|
+
categoryName: string;
|
|
1786
|
+
}[];
|
|
1787
|
+
relatedSkills: {
|
|
1788
|
+
avgSalaryMin: number;
|
|
1789
|
+
avgSalaryMax: number;
|
|
1790
|
+
jobCount: number;
|
|
1791
|
+
skillSlug: string;
|
|
1792
|
+
skillName: string;
|
|
1793
|
+
}[];
|
|
1794
|
+
totalLocationCount: number;
|
|
1795
|
+
boardOverallAvgMin: number | null;
|
|
1796
|
+
boardOverallAvgMax: number | null;
|
|
1797
|
+
boardMedianMin: number | null;
|
|
1798
|
+
boardMedianMax: number | null;
|
|
1799
|
+
currency: string;
|
|
1800
|
+
};
|
|
1657
1801
|
/** @description Geo for place resolutions; `null` for category/skill. */
|
|
1658
1802
|
TaxonomyGeo: {
|
|
1659
1803
|
lat: number | null;
|
|
@@ -1665,6 +1809,75 @@ interface components {
|
|
|
1665
1809
|
locality: string | null;
|
|
1666
1810
|
placeType: string | null;
|
|
1667
1811
|
} | null;
|
|
1812
|
+
TitleSalaryDetail: {
|
|
1813
|
+
/** @enum {string} */
|
|
1814
|
+
object: "title_salary_detail";
|
|
1815
|
+
/** @description Immutable English source slug — the salary-stats key. */
|
|
1816
|
+
sourceSlug: string;
|
|
1817
|
+
/** @description Board-language canonical URL slug — the starter 308 target. */
|
|
1818
|
+
canonicalSlug: string;
|
|
1819
|
+
categoryName: string;
|
|
1820
|
+
overallSalary: {
|
|
1821
|
+
avgMin: number;
|
|
1822
|
+
avgMax: number;
|
|
1823
|
+
p25Min: number;
|
|
1824
|
+
p75Max: number;
|
|
1825
|
+
jobCount: number;
|
|
1826
|
+
} | null;
|
|
1827
|
+
bySeniority: {
|
|
1828
|
+
seniority: string;
|
|
1829
|
+
avgSalaryMin: number;
|
|
1830
|
+
avgSalaryMax: number;
|
|
1831
|
+
jobCount: number;
|
|
1832
|
+
boardAvgMin: number | null;
|
|
1833
|
+
boardAvgMax: number | null;
|
|
1834
|
+
boardMedianMin: number | null;
|
|
1835
|
+
boardMedianMax: number | null;
|
|
1836
|
+
boardP25Min: number | null;
|
|
1837
|
+
boardP75Min: number | null;
|
|
1838
|
+
boardP25Max: number | null;
|
|
1839
|
+
boardP75Max: number | null;
|
|
1840
|
+
diffPercent: number | null;
|
|
1841
|
+
}[];
|
|
1842
|
+
topCompanies: {
|
|
1843
|
+
avgSalaryMin: number;
|
|
1844
|
+
avgSalaryMax: number;
|
|
1845
|
+
jobCount: number;
|
|
1846
|
+
companySlug: string;
|
|
1847
|
+
companyName: string;
|
|
1848
|
+
logoPath: string | null;
|
|
1849
|
+
}[];
|
|
1850
|
+
topLocations: {
|
|
1851
|
+
avgSalaryMin: number;
|
|
1852
|
+
avgSalaryMax: number;
|
|
1853
|
+
jobCount: number;
|
|
1854
|
+
placeName: string;
|
|
1855
|
+
placeSlug: string;
|
|
1856
|
+
countryCode: string;
|
|
1857
|
+
}[];
|
|
1858
|
+
topSkills: {
|
|
1859
|
+
avgSalaryMin: number;
|
|
1860
|
+
avgSalaryMax: number;
|
|
1861
|
+
jobCount: number;
|
|
1862
|
+
skillSlug: string;
|
|
1863
|
+
skillName: string;
|
|
1864
|
+
}[];
|
|
1865
|
+
relatedTitles: {
|
|
1866
|
+
avgSalaryMin: number;
|
|
1867
|
+
avgSalaryMax: number;
|
|
1868
|
+
jobCount: number;
|
|
1869
|
+
categorySlug: string;
|
|
1870
|
+
categoryName: string;
|
|
1871
|
+
}[];
|
|
1872
|
+
totalLocationCount: number;
|
|
1873
|
+
boardOverallAvgMin: number | null;
|
|
1874
|
+
boardOverallAvgMax: number | null;
|
|
1875
|
+
boardMedianMin: number | null;
|
|
1876
|
+
boardMedianMax: number | null;
|
|
1877
|
+
boardP25Min: number | null;
|
|
1878
|
+
boardP75Max: number | null;
|
|
1879
|
+
currency: string;
|
|
1880
|
+
};
|
|
1668
1881
|
TokenRequest: {
|
|
1669
1882
|
/**
|
|
1670
1883
|
* @description OAuth grant type. Either `authorization_code` to exchange an authorization code for a new token pair, or `refresh_token` to exchange a refresh token for a new token pair.
|
|
@@ -2109,7 +2322,7 @@ declare function isConflict(e: unknown): e is BoardApiError;
|
|
|
2109
2322
|
* constant because the package is platform-neutral and cannot read
|
|
2110
2323
|
* package.json at runtime.
|
|
2111
2324
|
*/
|
|
2112
|
-
declare const SDK_VERSION = "1.
|
|
2325
|
+
declare const SDK_VERSION = "1.9.0";
|
|
2113
2326
|
|
|
2114
2327
|
type BoardUser = Schemas['BoardUser'];
|
|
2115
2328
|
type BoardAuthSession = Schemas['BoardAuthSession'];
|
|
@@ -2322,6 +2535,20 @@ type PlacesListQuery = {
|
|
|
2322
2535
|
limit?: number;
|
|
2323
2536
|
};
|
|
2324
2537
|
|
|
2538
|
+
/** A job title's salary breakdown (overall + by-seniority + top rails). */
|
|
2539
|
+
type TitleSalaryDetail = Schemas['TitleSalaryDetail'];
|
|
2540
|
+
/** A skill's salary breakdown. */
|
|
2541
|
+
type SkillSalaryDetail = Schemas['SkillSalaryDetail'];
|
|
2542
|
+
/** A place's salary breakdown (city overall + siblings, or area child cities). */
|
|
2543
|
+
type LocationSalaryDetail = Schemas['LocationSalaryDetail'];
|
|
2544
|
+
/**
|
|
2545
|
+
* Board-language overlay for a salary read. `en` (the default) is the identity
|
|
2546
|
+
* fast-path; a non-`en` locale overlays board-language names + canonical slugs.
|
|
2547
|
+
*/
|
|
2548
|
+
type SalaryDetailQuery = {
|
|
2549
|
+
locale?: string;
|
|
2550
|
+
};
|
|
2551
|
+
|
|
2325
2552
|
interface CreateBoardClientOptions {
|
|
2326
2553
|
baseUrl: string;
|
|
2327
2554
|
/** Board identifier: `pk_…` key (provisioned default) | `boards_…` ID | slug. */
|
|
@@ -2930,7 +3157,219 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
|
|
|
2930
3157
|
success: boolean;
|
|
2931
3158
|
}>;
|
|
2932
3159
|
};
|
|
3160
|
+
salaries: {
|
|
3161
|
+
titles: {
|
|
3162
|
+
retrieve(categorySlug: string, query?: SalaryDetailQuery, options?: FetchOptions): Promise<{
|
|
3163
|
+
object: "title_salary_detail";
|
|
3164
|
+
sourceSlug: string;
|
|
3165
|
+
canonicalSlug: string;
|
|
3166
|
+
categoryName: string;
|
|
3167
|
+
overallSalary: {
|
|
3168
|
+
avgMin: number;
|
|
3169
|
+
avgMax: number;
|
|
3170
|
+
p25Min: number;
|
|
3171
|
+
p75Max: number;
|
|
3172
|
+
jobCount: number;
|
|
3173
|
+
} | null;
|
|
3174
|
+
bySeniority: {
|
|
3175
|
+
seniority: string;
|
|
3176
|
+
avgSalaryMin: number;
|
|
3177
|
+
avgSalaryMax: number;
|
|
3178
|
+
jobCount: number;
|
|
3179
|
+
boardAvgMin: number | null;
|
|
3180
|
+
boardAvgMax: number | null;
|
|
3181
|
+
boardMedianMin: number | null;
|
|
3182
|
+
boardMedianMax: number | null;
|
|
3183
|
+
boardP25Min: number | null;
|
|
3184
|
+
boardP75Min: number | null;
|
|
3185
|
+
boardP25Max: number | null;
|
|
3186
|
+
boardP75Max: number | null;
|
|
3187
|
+
diffPercent: number | null;
|
|
3188
|
+
}[];
|
|
3189
|
+
topCompanies: {
|
|
3190
|
+
avgSalaryMin: number;
|
|
3191
|
+
avgSalaryMax: number;
|
|
3192
|
+
jobCount: number;
|
|
3193
|
+
companySlug: string;
|
|
3194
|
+
companyName: string;
|
|
3195
|
+
logoPath: string | null;
|
|
3196
|
+
}[];
|
|
3197
|
+
topLocations: {
|
|
3198
|
+
avgSalaryMin: number;
|
|
3199
|
+
avgSalaryMax: number;
|
|
3200
|
+
jobCount: number;
|
|
3201
|
+
placeName: string;
|
|
3202
|
+
placeSlug: string;
|
|
3203
|
+
countryCode: string;
|
|
3204
|
+
}[];
|
|
3205
|
+
topSkills: {
|
|
3206
|
+
avgSalaryMin: number;
|
|
3207
|
+
avgSalaryMax: number;
|
|
3208
|
+
jobCount: number;
|
|
3209
|
+
skillSlug: string;
|
|
3210
|
+
skillName: string;
|
|
3211
|
+
}[];
|
|
3212
|
+
relatedTitles: {
|
|
3213
|
+
avgSalaryMin: number;
|
|
3214
|
+
avgSalaryMax: number;
|
|
3215
|
+
jobCount: number;
|
|
3216
|
+
categorySlug: string;
|
|
3217
|
+
categoryName: string;
|
|
3218
|
+
}[];
|
|
3219
|
+
totalLocationCount: number;
|
|
3220
|
+
boardOverallAvgMin: number | null;
|
|
3221
|
+
boardOverallAvgMax: number | null;
|
|
3222
|
+
boardMedianMin: number | null;
|
|
3223
|
+
boardMedianMax: number | null;
|
|
3224
|
+
boardP25Min: number | null;
|
|
3225
|
+
boardP75Max: number | null;
|
|
3226
|
+
currency: string;
|
|
3227
|
+
}>;
|
|
3228
|
+
};
|
|
3229
|
+
skills: {
|
|
3230
|
+
retrieve(skillSlug: string, query?: SalaryDetailQuery, options?: FetchOptions): Promise<{
|
|
3231
|
+
object: "skill_salary_detail";
|
|
3232
|
+
sourceSlug: string;
|
|
3233
|
+
canonicalSlug: string;
|
|
3234
|
+
skillName: string;
|
|
3235
|
+
overallSalary: {
|
|
3236
|
+
avgMin: number;
|
|
3237
|
+
avgMax: number;
|
|
3238
|
+
medianMin: number;
|
|
3239
|
+
medianMax: number;
|
|
3240
|
+
p25Min: number;
|
|
3241
|
+
p75Max: number;
|
|
3242
|
+
jobCount: number;
|
|
3243
|
+
} | null;
|
|
3244
|
+
bySeniority: {
|
|
3245
|
+
seniority: string;
|
|
3246
|
+
avgSalaryMin: number;
|
|
3247
|
+
avgSalaryMax: number;
|
|
3248
|
+
jobCount: number;
|
|
3249
|
+
boardAvgMin: number | null;
|
|
3250
|
+
boardAvgMax: number | null;
|
|
3251
|
+
diffPercent: number | null;
|
|
3252
|
+
}[];
|
|
3253
|
+
topCompanies: {
|
|
3254
|
+
avgSalaryMin: number;
|
|
3255
|
+
avgSalaryMax: number;
|
|
3256
|
+
jobCount: number;
|
|
3257
|
+
companySlug: string;
|
|
3258
|
+
companyName: string;
|
|
3259
|
+
logoPath: string | null;
|
|
3260
|
+
}[];
|
|
3261
|
+
topLocations: {
|
|
3262
|
+
avgSalaryMin: number;
|
|
3263
|
+
avgSalaryMax: number;
|
|
3264
|
+
jobCount: number;
|
|
3265
|
+
placeName: string;
|
|
3266
|
+
placeSlug: string;
|
|
3267
|
+
countryCode: string;
|
|
3268
|
+
}[];
|
|
3269
|
+
topTitles: {
|
|
3270
|
+
avgSalaryMin: number;
|
|
3271
|
+
avgSalaryMax: number;
|
|
3272
|
+
jobCount: number;
|
|
3273
|
+
categorySlug: string;
|
|
3274
|
+
categoryName: string;
|
|
3275
|
+
}[];
|
|
3276
|
+
relatedSkills: {
|
|
3277
|
+
avgSalaryMin: number;
|
|
3278
|
+
avgSalaryMax: number;
|
|
3279
|
+
jobCount: number;
|
|
3280
|
+
skillSlug: string;
|
|
3281
|
+
skillName: string;
|
|
3282
|
+
}[];
|
|
3283
|
+
totalLocationCount: number;
|
|
3284
|
+
boardOverallAvgMin: number | null;
|
|
3285
|
+
boardOverallAvgMax: number | null;
|
|
3286
|
+
boardMedianMin: number | null;
|
|
3287
|
+
boardMedianMax: number | null;
|
|
3288
|
+
currency: string;
|
|
3289
|
+
}>;
|
|
3290
|
+
};
|
|
3291
|
+
locations: {
|
|
3292
|
+
retrieve(locationSlug: string, query?: SalaryDetailQuery, options?: FetchOptions): Promise<{
|
|
3293
|
+
object: "location_salary_detail";
|
|
3294
|
+
sourceSlug: string;
|
|
3295
|
+
canonicalSlug: string;
|
|
3296
|
+
placeName: string;
|
|
3297
|
+
placeId: string;
|
|
3298
|
+
adminLevel: string;
|
|
3299
|
+
countryCode: string;
|
|
3300
|
+
overallSalary: {
|
|
3301
|
+
avgMin: number;
|
|
3302
|
+
avgMax: number;
|
|
3303
|
+
medianMin: number;
|
|
3304
|
+
medianMax: number;
|
|
3305
|
+
p25Min: number;
|
|
3306
|
+
p75Max: number;
|
|
3307
|
+
jobCount: number;
|
|
3308
|
+
} | null;
|
|
3309
|
+
childLocations: {
|
|
3310
|
+
placeName: string;
|
|
3311
|
+
placeSlug: string;
|
|
3312
|
+
countryCode: string;
|
|
3313
|
+
avgSalaryMin: number;
|
|
3314
|
+
avgSalaryMax: number;
|
|
3315
|
+
medianSalaryMin: number;
|
|
3316
|
+
medianSalaryMax: number;
|
|
3317
|
+
p25SalaryMin: number;
|
|
3318
|
+
p75SalaryMax: number;
|
|
3319
|
+
jobCount: number;
|
|
3320
|
+
currency: string;
|
|
3321
|
+
}[];
|
|
3322
|
+
childLocationsByRegion: {
|
|
3323
|
+
regionName: string;
|
|
3324
|
+
regionSlug: string;
|
|
3325
|
+
cities: {
|
|
3326
|
+
placeName: string;
|
|
3327
|
+
placeSlug: string;
|
|
3328
|
+
countryCode: string;
|
|
3329
|
+
avgSalaryMin: number;
|
|
3330
|
+
avgSalaryMax: number;
|
|
3331
|
+
medianSalaryMin: number;
|
|
3332
|
+
medianSalaryMax: number;
|
|
3333
|
+
p25SalaryMin: number;
|
|
3334
|
+
p75SalaryMax: number;
|
|
3335
|
+
jobCount: number;
|
|
3336
|
+
currency: string;
|
|
3337
|
+
}[];
|
|
3338
|
+
}[];
|
|
3339
|
+
topCategories: {
|
|
3340
|
+
avgSalaryMin: number;
|
|
3341
|
+
avgSalaryMax: number;
|
|
3342
|
+
jobCount: number;
|
|
3343
|
+
categorySlug: string;
|
|
3344
|
+
categoryName: string;
|
|
3345
|
+
}[];
|
|
3346
|
+
topSkills: {
|
|
3347
|
+
avgSalaryMin: number;
|
|
3348
|
+
avgSalaryMax: number;
|
|
3349
|
+
jobCount: number;
|
|
3350
|
+
skillSlug: string;
|
|
3351
|
+
skillName: string;
|
|
3352
|
+
}[];
|
|
3353
|
+
siblingLocations: {
|
|
3354
|
+
placeName: string;
|
|
3355
|
+
placeSlug: string;
|
|
3356
|
+
countryCode: string;
|
|
3357
|
+
avgSalaryMin: number;
|
|
3358
|
+
avgSalaryMax: number;
|
|
3359
|
+
medianSalaryMin: number;
|
|
3360
|
+
medianSalaryMax: number;
|
|
3361
|
+
p25SalaryMin: number;
|
|
3362
|
+
p75SalaryMax: number;
|
|
3363
|
+
jobCount: number;
|
|
3364
|
+
currency: string;
|
|
3365
|
+
}[];
|
|
3366
|
+
boardOverallAvgMin: number | null;
|
|
3367
|
+
boardOverallAvgMax: number | null;
|
|
3368
|
+
currency: string;
|
|
3369
|
+
}>;
|
|
3370
|
+
};
|
|
3371
|
+
};
|
|
2933
3372
|
};
|
|
2934
3373
|
type BoardSdk = ReturnType<typeof createBoardClient>;
|
|
2935
3374
|
|
|
2936
|
-
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 CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanySimilarQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, 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 JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, 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 ResetPasswordBody, SDK_VERSION, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
|
|
3375
|
+
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 CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanySimilarQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, 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 JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, 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 ResetPasswordBody, SDK_VERSION, type SalaryDetailQuery, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type SkillSalaryDetail, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type TitleSalaryDetail, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
|
package/dist/index.d.ts
CHANGED
|
@@ -887,6 +887,87 @@ interface components {
|
|
|
887
887
|
address: string | null;
|
|
888
888
|
} | null;
|
|
889
889
|
};
|
|
890
|
+
LocationSalaryDetail: {
|
|
891
|
+
/** @enum {string} */
|
|
892
|
+
object: "location_salary_detail";
|
|
893
|
+
/** @description Immutable English source place slug — the salary-stats key. */
|
|
894
|
+
sourceSlug: string;
|
|
895
|
+
/** @description Board-language canonical URL slug — the starter 308 target. */
|
|
896
|
+
canonicalSlug: string;
|
|
897
|
+
placeName: string;
|
|
898
|
+
placeId: string;
|
|
899
|
+
adminLevel: string;
|
|
900
|
+
countryCode: string;
|
|
901
|
+
overallSalary: {
|
|
902
|
+
avgMin: number;
|
|
903
|
+
avgMax: number;
|
|
904
|
+
medianMin: number;
|
|
905
|
+
medianMax: number;
|
|
906
|
+
p25Min: number;
|
|
907
|
+
p75Max: number;
|
|
908
|
+
jobCount: number;
|
|
909
|
+
} | null;
|
|
910
|
+
childLocations: {
|
|
911
|
+
placeName: string;
|
|
912
|
+
placeSlug: string;
|
|
913
|
+
countryCode: string;
|
|
914
|
+
avgSalaryMin: number;
|
|
915
|
+
avgSalaryMax: number;
|
|
916
|
+
medianSalaryMin: number;
|
|
917
|
+
medianSalaryMax: number;
|
|
918
|
+
p25SalaryMin: number;
|
|
919
|
+
p75SalaryMax: number;
|
|
920
|
+
jobCount: number;
|
|
921
|
+
currency: string;
|
|
922
|
+
}[];
|
|
923
|
+
childLocationsByRegion: {
|
|
924
|
+
regionName: string;
|
|
925
|
+
regionSlug: string;
|
|
926
|
+
cities: {
|
|
927
|
+
placeName: string;
|
|
928
|
+
placeSlug: string;
|
|
929
|
+
countryCode: string;
|
|
930
|
+
avgSalaryMin: number;
|
|
931
|
+
avgSalaryMax: number;
|
|
932
|
+
medianSalaryMin: number;
|
|
933
|
+
medianSalaryMax: number;
|
|
934
|
+
p25SalaryMin: number;
|
|
935
|
+
p75SalaryMax: number;
|
|
936
|
+
jobCount: number;
|
|
937
|
+
currency: string;
|
|
938
|
+
}[];
|
|
939
|
+
}[];
|
|
940
|
+
topCategories: {
|
|
941
|
+
avgSalaryMin: number;
|
|
942
|
+
avgSalaryMax: number;
|
|
943
|
+
jobCount: number;
|
|
944
|
+
categorySlug: string;
|
|
945
|
+
categoryName: string;
|
|
946
|
+
}[];
|
|
947
|
+
topSkills: {
|
|
948
|
+
avgSalaryMin: number;
|
|
949
|
+
avgSalaryMax: number;
|
|
950
|
+
jobCount: number;
|
|
951
|
+
skillSlug: string;
|
|
952
|
+
skillName: string;
|
|
953
|
+
}[];
|
|
954
|
+
siblingLocations: {
|
|
955
|
+
placeName: string;
|
|
956
|
+
placeSlug: string;
|
|
957
|
+
countryCode: string;
|
|
958
|
+
avgSalaryMin: number;
|
|
959
|
+
avgSalaryMax: number;
|
|
960
|
+
medianSalaryMin: number;
|
|
961
|
+
medianSalaryMax: number;
|
|
962
|
+
p25SalaryMin: number;
|
|
963
|
+
p75SalaryMax: number;
|
|
964
|
+
jobCount: number;
|
|
965
|
+
currency: string;
|
|
966
|
+
}[];
|
|
967
|
+
boardOverallAvgMin: number | null;
|
|
968
|
+
boardOverallAvgMax: number | null;
|
|
969
|
+
currency: string;
|
|
970
|
+
};
|
|
890
971
|
MediaGet: components["schemas"]["MediaUpload"] & {
|
|
891
972
|
/** @description Time at which the file was uploaded. ISO 8601 datetime. */
|
|
892
973
|
uploadedAt: string;
|
|
@@ -1654,6 +1735,69 @@ interface components {
|
|
|
1654
1735
|
/** @description Stripe billing-portal configuration ID used for self-serve plan management. Pass `null` to clear. */
|
|
1655
1736
|
jobAccessStripePortalConfigId?: string | unknown | unknown;
|
|
1656
1737
|
};
|
|
1738
|
+
SkillSalaryDetail: {
|
|
1739
|
+
/** @enum {string} */
|
|
1740
|
+
object: "skill_salary_detail";
|
|
1741
|
+
/** @description Immutable English source slug — the salary-stats key. */
|
|
1742
|
+
sourceSlug: string;
|
|
1743
|
+
/** @description Board-language canonical URL slug — the starter 308 target. */
|
|
1744
|
+
canonicalSlug: string;
|
|
1745
|
+
skillName: string;
|
|
1746
|
+
overallSalary: {
|
|
1747
|
+
avgMin: number;
|
|
1748
|
+
avgMax: number;
|
|
1749
|
+
medianMin: number;
|
|
1750
|
+
medianMax: number;
|
|
1751
|
+
p25Min: number;
|
|
1752
|
+
p75Max: number;
|
|
1753
|
+
jobCount: number;
|
|
1754
|
+
} | null;
|
|
1755
|
+
bySeniority: {
|
|
1756
|
+
seniority: string;
|
|
1757
|
+
avgSalaryMin: number;
|
|
1758
|
+
avgSalaryMax: number;
|
|
1759
|
+
jobCount: number;
|
|
1760
|
+
boardAvgMin: number | null;
|
|
1761
|
+
boardAvgMax: number | null;
|
|
1762
|
+
diffPercent: number | null;
|
|
1763
|
+
}[];
|
|
1764
|
+
topCompanies: {
|
|
1765
|
+
avgSalaryMin: number;
|
|
1766
|
+
avgSalaryMax: number;
|
|
1767
|
+
jobCount: number;
|
|
1768
|
+
companySlug: string;
|
|
1769
|
+
companyName: string;
|
|
1770
|
+
logoPath: string | null;
|
|
1771
|
+
}[];
|
|
1772
|
+
topLocations: {
|
|
1773
|
+
avgSalaryMin: number;
|
|
1774
|
+
avgSalaryMax: number;
|
|
1775
|
+
jobCount: number;
|
|
1776
|
+
placeName: string;
|
|
1777
|
+
placeSlug: string;
|
|
1778
|
+
countryCode: string;
|
|
1779
|
+
}[];
|
|
1780
|
+
topTitles: {
|
|
1781
|
+
avgSalaryMin: number;
|
|
1782
|
+
avgSalaryMax: number;
|
|
1783
|
+
jobCount: number;
|
|
1784
|
+
categorySlug: string;
|
|
1785
|
+
categoryName: string;
|
|
1786
|
+
}[];
|
|
1787
|
+
relatedSkills: {
|
|
1788
|
+
avgSalaryMin: number;
|
|
1789
|
+
avgSalaryMax: number;
|
|
1790
|
+
jobCount: number;
|
|
1791
|
+
skillSlug: string;
|
|
1792
|
+
skillName: string;
|
|
1793
|
+
}[];
|
|
1794
|
+
totalLocationCount: number;
|
|
1795
|
+
boardOverallAvgMin: number | null;
|
|
1796
|
+
boardOverallAvgMax: number | null;
|
|
1797
|
+
boardMedianMin: number | null;
|
|
1798
|
+
boardMedianMax: number | null;
|
|
1799
|
+
currency: string;
|
|
1800
|
+
};
|
|
1657
1801
|
/** @description Geo for place resolutions; `null` for category/skill. */
|
|
1658
1802
|
TaxonomyGeo: {
|
|
1659
1803
|
lat: number | null;
|
|
@@ -1665,6 +1809,75 @@ interface components {
|
|
|
1665
1809
|
locality: string | null;
|
|
1666
1810
|
placeType: string | null;
|
|
1667
1811
|
} | null;
|
|
1812
|
+
TitleSalaryDetail: {
|
|
1813
|
+
/** @enum {string} */
|
|
1814
|
+
object: "title_salary_detail";
|
|
1815
|
+
/** @description Immutable English source slug — the salary-stats key. */
|
|
1816
|
+
sourceSlug: string;
|
|
1817
|
+
/** @description Board-language canonical URL slug — the starter 308 target. */
|
|
1818
|
+
canonicalSlug: string;
|
|
1819
|
+
categoryName: string;
|
|
1820
|
+
overallSalary: {
|
|
1821
|
+
avgMin: number;
|
|
1822
|
+
avgMax: number;
|
|
1823
|
+
p25Min: number;
|
|
1824
|
+
p75Max: number;
|
|
1825
|
+
jobCount: number;
|
|
1826
|
+
} | null;
|
|
1827
|
+
bySeniority: {
|
|
1828
|
+
seniority: string;
|
|
1829
|
+
avgSalaryMin: number;
|
|
1830
|
+
avgSalaryMax: number;
|
|
1831
|
+
jobCount: number;
|
|
1832
|
+
boardAvgMin: number | null;
|
|
1833
|
+
boardAvgMax: number | null;
|
|
1834
|
+
boardMedianMin: number | null;
|
|
1835
|
+
boardMedianMax: number | null;
|
|
1836
|
+
boardP25Min: number | null;
|
|
1837
|
+
boardP75Min: number | null;
|
|
1838
|
+
boardP25Max: number | null;
|
|
1839
|
+
boardP75Max: number | null;
|
|
1840
|
+
diffPercent: number | null;
|
|
1841
|
+
}[];
|
|
1842
|
+
topCompanies: {
|
|
1843
|
+
avgSalaryMin: number;
|
|
1844
|
+
avgSalaryMax: number;
|
|
1845
|
+
jobCount: number;
|
|
1846
|
+
companySlug: string;
|
|
1847
|
+
companyName: string;
|
|
1848
|
+
logoPath: string | null;
|
|
1849
|
+
}[];
|
|
1850
|
+
topLocations: {
|
|
1851
|
+
avgSalaryMin: number;
|
|
1852
|
+
avgSalaryMax: number;
|
|
1853
|
+
jobCount: number;
|
|
1854
|
+
placeName: string;
|
|
1855
|
+
placeSlug: string;
|
|
1856
|
+
countryCode: string;
|
|
1857
|
+
}[];
|
|
1858
|
+
topSkills: {
|
|
1859
|
+
avgSalaryMin: number;
|
|
1860
|
+
avgSalaryMax: number;
|
|
1861
|
+
jobCount: number;
|
|
1862
|
+
skillSlug: string;
|
|
1863
|
+
skillName: string;
|
|
1864
|
+
}[];
|
|
1865
|
+
relatedTitles: {
|
|
1866
|
+
avgSalaryMin: number;
|
|
1867
|
+
avgSalaryMax: number;
|
|
1868
|
+
jobCount: number;
|
|
1869
|
+
categorySlug: string;
|
|
1870
|
+
categoryName: string;
|
|
1871
|
+
}[];
|
|
1872
|
+
totalLocationCount: number;
|
|
1873
|
+
boardOverallAvgMin: number | null;
|
|
1874
|
+
boardOverallAvgMax: number | null;
|
|
1875
|
+
boardMedianMin: number | null;
|
|
1876
|
+
boardMedianMax: number | null;
|
|
1877
|
+
boardP25Min: number | null;
|
|
1878
|
+
boardP75Max: number | null;
|
|
1879
|
+
currency: string;
|
|
1880
|
+
};
|
|
1668
1881
|
TokenRequest: {
|
|
1669
1882
|
/**
|
|
1670
1883
|
* @description OAuth grant type. Either `authorization_code` to exchange an authorization code for a new token pair, or `refresh_token` to exchange a refresh token for a new token pair.
|
|
@@ -2109,7 +2322,7 @@ declare function isConflict(e: unknown): e is BoardApiError;
|
|
|
2109
2322
|
* constant because the package is platform-neutral and cannot read
|
|
2110
2323
|
* package.json at runtime.
|
|
2111
2324
|
*/
|
|
2112
|
-
declare const SDK_VERSION = "1.
|
|
2325
|
+
declare const SDK_VERSION = "1.9.0";
|
|
2113
2326
|
|
|
2114
2327
|
type BoardUser = Schemas['BoardUser'];
|
|
2115
2328
|
type BoardAuthSession = Schemas['BoardAuthSession'];
|
|
@@ -2322,6 +2535,20 @@ type PlacesListQuery = {
|
|
|
2322
2535
|
limit?: number;
|
|
2323
2536
|
};
|
|
2324
2537
|
|
|
2538
|
+
/** A job title's salary breakdown (overall + by-seniority + top rails). */
|
|
2539
|
+
type TitleSalaryDetail = Schemas['TitleSalaryDetail'];
|
|
2540
|
+
/** A skill's salary breakdown. */
|
|
2541
|
+
type SkillSalaryDetail = Schemas['SkillSalaryDetail'];
|
|
2542
|
+
/** A place's salary breakdown (city overall + siblings, or area child cities). */
|
|
2543
|
+
type LocationSalaryDetail = Schemas['LocationSalaryDetail'];
|
|
2544
|
+
/**
|
|
2545
|
+
* Board-language overlay for a salary read. `en` (the default) is the identity
|
|
2546
|
+
* fast-path; a non-`en` locale overlays board-language names + canonical slugs.
|
|
2547
|
+
*/
|
|
2548
|
+
type SalaryDetailQuery = {
|
|
2549
|
+
locale?: string;
|
|
2550
|
+
};
|
|
2551
|
+
|
|
2325
2552
|
interface CreateBoardClientOptions {
|
|
2326
2553
|
baseUrl: string;
|
|
2327
2554
|
/** Board identifier: `pk_…` key (provisioned default) | `boards_…` ID | slug. */
|
|
@@ -2930,7 +3157,219 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
|
|
|
2930
3157
|
success: boolean;
|
|
2931
3158
|
}>;
|
|
2932
3159
|
};
|
|
3160
|
+
salaries: {
|
|
3161
|
+
titles: {
|
|
3162
|
+
retrieve(categorySlug: string, query?: SalaryDetailQuery, options?: FetchOptions): Promise<{
|
|
3163
|
+
object: "title_salary_detail";
|
|
3164
|
+
sourceSlug: string;
|
|
3165
|
+
canonicalSlug: string;
|
|
3166
|
+
categoryName: string;
|
|
3167
|
+
overallSalary: {
|
|
3168
|
+
avgMin: number;
|
|
3169
|
+
avgMax: number;
|
|
3170
|
+
p25Min: number;
|
|
3171
|
+
p75Max: number;
|
|
3172
|
+
jobCount: number;
|
|
3173
|
+
} | null;
|
|
3174
|
+
bySeniority: {
|
|
3175
|
+
seniority: string;
|
|
3176
|
+
avgSalaryMin: number;
|
|
3177
|
+
avgSalaryMax: number;
|
|
3178
|
+
jobCount: number;
|
|
3179
|
+
boardAvgMin: number | null;
|
|
3180
|
+
boardAvgMax: number | null;
|
|
3181
|
+
boardMedianMin: number | null;
|
|
3182
|
+
boardMedianMax: number | null;
|
|
3183
|
+
boardP25Min: number | null;
|
|
3184
|
+
boardP75Min: number | null;
|
|
3185
|
+
boardP25Max: number | null;
|
|
3186
|
+
boardP75Max: number | null;
|
|
3187
|
+
diffPercent: number | null;
|
|
3188
|
+
}[];
|
|
3189
|
+
topCompanies: {
|
|
3190
|
+
avgSalaryMin: number;
|
|
3191
|
+
avgSalaryMax: number;
|
|
3192
|
+
jobCount: number;
|
|
3193
|
+
companySlug: string;
|
|
3194
|
+
companyName: string;
|
|
3195
|
+
logoPath: string | null;
|
|
3196
|
+
}[];
|
|
3197
|
+
topLocations: {
|
|
3198
|
+
avgSalaryMin: number;
|
|
3199
|
+
avgSalaryMax: number;
|
|
3200
|
+
jobCount: number;
|
|
3201
|
+
placeName: string;
|
|
3202
|
+
placeSlug: string;
|
|
3203
|
+
countryCode: string;
|
|
3204
|
+
}[];
|
|
3205
|
+
topSkills: {
|
|
3206
|
+
avgSalaryMin: number;
|
|
3207
|
+
avgSalaryMax: number;
|
|
3208
|
+
jobCount: number;
|
|
3209
|
+
skillSlug: string;
|
|
3210
|
+
skillName: string;
|
|
3211
|
+
}[];
|
|
3212
|
+
relatedTitles: {
|
|
3213
|
+
avgSalaryMin: number;
|
|
3214
|
+
avgSalaryMax: number;
|
|
3215
|
+
jobCount: number;
|
|
3216
|
+
categorySlug: string;
|
|
3217
|
+
categoryName: string;
|
|
3218
|
+
}[];
|
|
3219
|
+
totalLocationCount: number;
|
|
3220
|
+
boardOverallAvgMin: number | null;
|
|
3221
|
+
boardOverallAvgMax: number | null;
|
|
3222
|
+
boardMedianMin: number | null;
|
|
3223
|
+
boardMedianMax: number | null;
|
|
3224
|
+
boardP25Min: number | null;
|
|
3225
|
+
boardP75Max: number | null;
|
|
3226
|
+
currency: string;
|
|
3227
|
+
}>;
|
|
3228
|
+
};
|
|
3229
|
+
skills: {
|
|
3230
|
+
retrieve(skillSlug: string, query?: SalaryDetailQuery, options?: FetchOptions): Promise<{
|
|
3231
|
+
object: "skill_salary_detail";
|
|
3232
|
+
sourceSlug: string;
|
|
3233
|
+
canonicalSlug: string;
|
|
3234
|
+
skillName: string;
|
|
3235
|
+
overallSalary: {
|
|
3236
|
+
avgMin: number;
|
|
3237
|
+
avgMax: number;
|
|
3238
|
+
medianMin: number;
|
|
3239
|
+
medianMax: number;
|
|
3240
|
+
p25Min: number;
|
|
3241
|
+
p75Max: number;
|
|
3242
|
+
jobCount: number;
|
|
3243
|
+
} | null;
|
|
3244
|
+
bySeniority: {
|
|
3245
|
+
seniority: string;
|
|
3246
|
+
avgSalaryMin: number;
|
|
3247
|
+
avgSalaryMax: number;
|
|
3248
|
+
jobCount: number;
|
|
3249
|
+
boardAvgMin: number | null;
|
|
3250
|
+
boardAvgMax: number | null;
|
|
3251
|
+
diffPercent: number | null;
|
|
3252
|
+
}[];
|
|
3253
|
+
topCompanies: {
|
|
3254
|
+
avgSalaryMin: number;
|
|
3255
|
+
avgSalaryMax: number;
|
|
3256
|
+
jobCount: number;
|
|
3257
|
+
companySlug: string;
|
|
3258
|
+
companyName: string;
|
|
3259
|
+
logoPath: string | null;
|
|
3260
|
+
}[];
|
|
3261
|
+
topLocations: {
|
|
3262
|
+
avgSalaryMin: number;
|
|
3263
|
+
avgSalaryMax: number;
|
|
3264
|
+
jobCount: number;
|
|
3265
|
+
placeName: string;
|
|
3266
|
+
placeSlug: string;
|
|
3267
|
+
countryCode: string;
|
|
3268
|
+
}[];
|
|
3269
|
+
topTitles: {
|
|
3270
|
+
avgSalaryMin: number;
|
|
3271
|
+
avgSalaryMax: number;
|
|
3272
|
+
jobCount: number;
|
|
3273
|
+
categorySlug: string;
|
|
3274
|
+
categoryName: string;
|
|
3275
|
+
}[];
|
|
3276
|
+
relatedSkills: {
|
|
3277
|
+
avgSalaryMin: number;
|
|
3278
|
+
avgSalaryMax: number;
|
|
3279
|
+
jobCount: number;
|
|
3280
|
+
skillSlug: string;
|
|
3281
|
+
skillName: string;
|
|
3282
|
+
}[];
|
|
3283
|
+
totalLocationCount: number;
|
|
3284
|
+
boardOverallAvgMin: number | null;
|
|
3285
|
+
boardOverallAvgMax: number | null;
|
|
3286
|
+
boardMedianMin: number | null;
|
|
3287
|
+
boardMedianMax: number | null;
|
|
3288
|
+
currency: string;
|
|
3289
|
+
}>;
|
|
3290
|
+
};
|
|
3291
|
+
locations: {
|
|
3292
|
+
retrieve(locationSlug: string, query?: SalaryDetailQuery, options?: FetchOptions): Promise<{
|
|
3293
|
+
object: "location_salary_detail";
|
|
3294
|
+
sourceSlug: string;
|
|
3295
|
+
canonicalSlug: string;
|
|
3296
|
+
placeName: string;
|
|
3297
|
+
placeId: string;
|
|
3298
|
+
adminLevel: string;
|
|
3299
|
+
countryCode: string;
|
|
3300
|
+
overallSalary: {
|
|
3301
|
+
avgMin: number;
|
|
3302
|
+
avgMax: number;
|
|
3303
|
+
medianMin: number;
|
|
3304
|
+
medianMax: number;
|
|
3305
|
+
p25Min: number;
|
|
3306
|
+
p75Max: number;
|
|
3307
|
+
jobCount: number;
|
|
3308
|
+
} | null;
|
|
3309
|
+
childLocations: {
|
|
3310
|
+
placeName: string;
|
|
3311
|
+
placeSlug: string;
|
|
3312
|
+
countryCode: string;
|
|
3313
|
+
avgSalaryMin: number;
|
|
3314
|
+
avgSalaryMax: number;
|
|
3315
|
+
medianSalaryMin: number;
|
|
3316
|
+
medianSalaryMax: number;
|
|
3317
|
+
p25SalaryMin: number;
|
|
3318
|
+
p75SalaryMax: number;
|
|
3319
|
+
jobCount: number;
|
|
3320
|
+
currency: string;
|
|
3321
|
+
}[];
|
|
3322
|
+
childLocationsByRegion: {
|
|
3323
|
+
regionName: string;
|
|
3324
|
+
regionSlug: string;
|
|
3325
|
+
cities: {
|
|
3326
|
+
placeName: string;
|
|
3327
|
+
placeSlug: string;
|
|
3328
|
+
countryCode: string;
|
|
3329
|
+
avgSalaryMin: number;
|
|
3330
|
+
avgSalaryMax: number;
|
|
3331
|
+
medianSalaryMin: number;
|
|
3332
|
+
medianSalaryMax: number;
|
|
3333
|
+
p25SalaryMin: number;
|
|
3334
|
+
p75SalaryMax: number;
|
|
3335
|
+
jobCount: number;
|
|
3336
|
+
currency: string;
|
|
3337
|
+
}[];
|
|
3338
|
+
}[];
|
|
3339
|
+
topCategories: {
|
|
3340
|
+
avgSalaryMin: number;
|
|
3341
|
+
avgSalaryMax: number;
|
|
3342
|
+
jobCount: number;
|
|
3343
|
+
categorySlug: string;
|
|
3344
|
+
categoryName: string;
|
|
3345
|
+
}[];
|
|
3346
|
+
topSkills: {
|
|
3347
|
+
avgSalaryMin: number;
|
|
3348
|
+
avgSalaryMax: number;
|
|
3349
|
+
jobCount: number;
|
|
3350
|
+
skillSlug: string;
|
|
3351
|
+
skillName: string;
|
|
3352
|
+
}[];
|
|
3353
|
+
siblingLocations: {
|
|
3354
|
+
placeName: string;
|
|
3355
|
+
placeSlug: string;
|
|
3356
|
+
countryCode: string;
|
|
3357
|
+
avgSalaryMin: number;
|
|
3358
|
+
avgSalaryMax: number;
|
|
3359
|
+
medianSalaryMin: number;
|
|
3360
|
+
medianSalaryMax: number;
|
|
3361
|
+
p25SalaryMin: number;
|
|
3362
|
+
p75SalaryMax: number;
|
|
3363
|
+
jobCount: number;
|
|
3364
|
+
currency: string;
|
|
3365
|
+
}[];
|
|
3366
|
+
boardOverallAvgMin: number | null;
|
|
3367
|
+
boardOverallAvgMax: number | null;
|
|
3368
|
+
currency: string;
|
|
3369
|
+
}>;
|
|
3370
|
+
};
|
|
3371
|
+
};
|
|
2933
3372
|
};
|
|
2934
3373
|
type BoardSdk = ReturnType<typeof createBoardClient>;
|
|
2935
3374
|
|
|
2936
|
-
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 CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanySimilarQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, 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 JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, 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 ResetPasswordBody, SDK_VERSION, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
|
|
3375
|
+
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 CompaniesListQuery, type CompaniesSearchBody, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanySimilarQuery, type CreateBoardClientOptions, type CustomStorage, type EducationRequirement, type EmbedJobsQuery, type EmploymentType, type FetchOptions, type ForgotPasswordBody, 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 JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type Logger, type LoginBody, type LogoutBody, type OfficeLocation, type PlacesListQuery, 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 ResetPasswordBody, SDK_VERSION, type SalaryDetailQuery, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type Seniority, type SkillSalaryDetail, type StorageMode, type StorefrontPagination, type TaxonomyGeo, type TaxonomyResolution, type TitleSalaryDetail, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
|
package/dist/index.js
CHANGED
|
@@ -149,7 +149,7 @@ async function clearSession(storage) {
|
|
|
149
149
|
}
|
|
150
150
|
|
|
151
151
|
// src/version.ts
|
|
152
|
-
var SDK_VERSION = "1.
|
|
152
|
+
var SDK_VERSION = "1.9.0";
|
|
153
153
|
|
|
154
154
|
// src/client.ts
|
|
155
155
|
function isRawBody(body) {
|
|
@@ -843,6 +843,36 @@ function redirectsNamespace(client) {
|
|
|
843
843
|
};
|
|
844
844
|
}
|
|
845
845
|
|
|
846
|
+
// src/namespaces/salaries.ts
|
|
847
|
+
function salariesNamespace(client) {
|
|
848
|
+
return {
|
|
849
|
+
titles: {
|
|
850
|
+
retrieve(categorySlug, query, options) {
|
|
851
|
+
return client.fetch(
|
|
852
|
+
`/salaries/titles/${encodeURIComponent(categorySlug)}`,
|
|
853
|
+
{ ...options, query }
|
|
854
|
+
);
|
|
855
|
+
}
|
|
856
|
+
},
|
|
857
|
+
skills: {
|
|
858
|
+
retrieve(skillSlug, query, options) {
|
|
859
|
+
return client.fetch(
|
|
860
|
+
`/salaries/skills/${encodeURIComponent(skillSlug)}`,
|
|
861
|
+
{ ...options, query }
|
|
862
|
+
);
|
|
863
|
+
}
|
|
864
|
+
},
|
|
865
|
+
locations: {
|
|
866
|
+
retrieve(locationSlug, query, options) {
|
|
867
|
+
return client.fetch(
|
|
868
|
+
`/salaries/locations/${encodeURIComponent(locationSlug)}`,
|
|
869
|
+
{ ...options, query }
|
|
870
|
+
);
|
|
871
|
+
}
|
|
872
|
+
}
|
|
873
|
+
};
|
|
874
|
+
}
|
|
875
|
+
|
|
846
876
|
// src/namespaces/taxonomy.ts
|
|
847
877
|
function taxonomyResolver(client, kind) {
|
|
848
878
|
return {
|
|
@@ -927,6 +957,7 @@ function createBoardClient(options) {
|
|
|
927
957
|
password: passwordNamespace(client),
|
|
928
958
|
taxonomy: taxonomyNamespace(client),
|
|
929
959
|
redirects: redirectsNamespace(client),
|
|
930
|
-
jobAlerts: jobAlertsNamespace(client)
|
|
960
|
+
jobAlerts: jobAlertsNamespace(client),
|
|
961
|
+
salaries: salariesNamespace(client)
|
|
931
962
|
};
|
|
932
963
|
}
|
package/dist/index.mjs
CHANGED
|
@@ -109,7 +109,7 @@ async function clearSession(storage) {
|
|
|
109
109
|
}
|
|
110
110
|
|
|
111
111
|
// src/version.ts
|
|
112
|
-
var SDK_VERSION = "1.
|
|
112
|
+
var SDK_VERSION = "1.9.0";
|
|
113
113
|
|
|
114
114
|
// src/client.ts
|
|
115
115
|
function isRawBody(body) {
|
|
@@ -803,6 +803,36 @@ function redirectsNamespace(client) {
|
|
|
803
803
|
};
|
|
804
804
|
}
|
|
805
805
|
|
|
806
|
+
// src/namespaces/salaries.ts
|
|
807
|
+
function salariesNamespace(client) {
|
|
808
|
+
return {
|
|
809
|
+
titles: {
|
|
810
|
+
retrieve(categorySlug, query, options) {
|
|
811
|
+
return client.fetch(
|
|
812
|
+
`/salaries/titles/${encodeURIComponent(categorySlug)}`,
|
|
813
|
+
{ ...options, query }
|
|
814
|
+
);
|
|
815
|
+
}
|
|
816
|
+
},
|
|
817
|
+
skills: {
|
|
818
|
+
retrieve(skillSlug, query, options) {
|
|
819
|
+
return client.fetch(
|
|
820
|
+
`/salaries/skills/${encodeURIComponent(skillSlug)}`,
|
|
821
|
+
{ ...options, query }
|
|
822
|
+
);
|
|
823
|
+
}
|
|
824
|
+
},
|
|
825
|
+
locations: {
|
|
826
|
+
retrieve(locationSlug, query, options) {
|
|
827
|
+
return client.fetch(
|
|
828
|
+
`/salaries/locations/${encodeURIComponent(locationSlug)}`,
|
|
829
|
+
{ ...options, query }
|
|
830
|
+
);
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
};
|
|
834
|
+
}
|
|
835
|
+
|
|
806
836
|
// src/namespaces/taxonomy.ts
|
|
807
837
|
function taxonomyResolver(client, kind) {
|
|
808
838
|
return {
|
|
@@ -887,7 +917,8 @@ function createBoardClient(options) {
|
|
|
887
917
|
password: passwordNamespace(client),
|
|
888
918
|
taxonomy: taxonomyNamespace(client),
|
|
889
919
|
redirects: redirectsNamespace(client),
|
|
890
|
-
jobAlerts: jobAlertsNamespace(client)
|
|
920
|
+
jobAlerts: jobAlertsNamespace(client),
|
|
921
|
+
salaries: salariesNamespace(client)
|
|
891
922
|
};
|
|
892
923
|
}
|
|
893
924
|
export {
|
package/package.json
CHANGED
package/skills/manifest.json
CHANGED