@tapline/client 0.2.14 → 0.2.15
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/README.md +6 -2
- package/dist/cjs/client.d.ts +2 -0
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +29 -26
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/index.d.ts +2 -0
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +30 -27
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/airbnb/client.d.ts +6 -6
- package/dist/cjs/services/airbnb/client.d.ts.map +1 -1
- package/dist/cjs/services/airbnb/client.js +6 -6
- package/dist/cjs/services/airbnb/client.js.map +1 -1
- package/dist/cjs/services/birdeye/client.d.ts +10 -10
- package/dist/cjs/services/birdeye/client.d.ts.map +1 -1
- package/dist/cjs/services/birdeye/client.js +10 -10
- package/dist/cjs/services/birdeye/client.js.map +1 -1
- package/dist/cjs/services/brave_search/client.d.ts +1 -1
- package/dist/cjs/services/brave_search/client.d.ts.map +1 -1
- package/dist/cjs/services/brave_search/client.js +1 -1
- package/dist/cjs/services/brave_search/client.js.map +1 -1
- package/dist/cjs/services/brave_search/types.d.ts +1211 -1273
- package/dist/cjs/services/brave_search/types.d.ts.map +1 -1
- package/dist/cjs/services/facebook/types.d.ts +417 -430
- package/dist/cjs/services/facebook/types.d.ts.map +1 -1
- package/dist/cjs/services/facebook_ad_library/types.d.ts +259 -182
- package/dist/cjs/services/facebook_ad_library/types.d.ts.map +1 -1
- package/dist/cjs/services/facebook_marketplace/types.d.ts +162 -170
- package/dist/cjs/services/facebook_marketplace/types.d.ts.map +1 -1
- package/dist/cjs/services/geckoterminal/client.d.ts +2 -2
- package/dist/cjs/services/geckoterminal/client.d.ts.map +1 -1
- package/dist/cjs/services/geckoterminal/client.js +2 -2
- package/dist/cjs/services/geckoterminal/client.js.map +1 -1
- package/dist/cjs/services/geckoterminal/types.d.ts +15 -4
- package/dist/cjs/services/geckoterminal/types.d.ts.map +1 -1
- package/dist/cjs/services/gmgn/client.d.ts +18 -18
- package/dist/cjs/services/gmgn/client.d.ts.map +1 -1
- package/dist/cjs/services/gmgn/client.js +18 -18
- package/dist/cjs/services/gmgn/client.js.map +1 -1
- package/dist/cjs/services/gmgn/types.d.ts +2 -2
- package/dist/cjs/services/gmgn/types.d.ts.map +1 -1
- package/dist/cjs/services/goplus/client.d.ts +3 -3
- package/dist/cjs/services/goplus/client.d.ts.map +1 -1
- package/dist/cjs/services/goplus/client.js +3 -3
- package/dist/cjs/services/goplus/client.js.map +1 -1
- package/dist/cjs/services/imovelweb/client.d.ts +6 -6
- package/dist/cjs/services/imovelweb/client.d.ts.map +1 -1
- package/dist/cjs/services/imovelweb/client.js +6 -6
- package/dist/cjs/services/imovelweb/client.js.map +1 -1
- package/dist/cjs/services/indeed/types.d.ts +233 -187
- package/dist/cjs/services/indeed/types.d.ts.map +1 -1
- package/dist/cjs/services/instagram/client.d.ts +12 -12
- package/dist/cjs/services/instagram/client.d.ts.map +1 -1
- package/dist/cjs/services/instagram/client.js +12 -12
- package/dist/cjs/services/instagram/client.js.map +1 -1
- package/dist/cjs/services/instagram/types.d.ts +399 -2284
- package/dist/cjs/services/instagram/types.d.ts.map +1 -1
- package/dist/cjs/services/linkedin/client.d.ts +7 -7
- package/dist/cjs/services/linkedin/client.d.ts.map +1 -1
- package/dist/cjs/services/linkedin/client.js +7 -7
- package/dist/cjs/services/linkedin/client.js.map +1 -1
- package/dist/cjs/services/pinterest/client.d.ts +4 -4
- package/dist/cjs/services/pinterest/client.d.ts.map +1 -1
- package/dist/cjs/services/pinterest/client.js +4 -4
- package/dist/cjs/services/pinterest/client.js.map +1 -1
- package/dist/cjs/services/pinterest/types.d.ts +740 -711
- package/dist/cjs/services/pinterest/types.d.ts.map +1 -1
- package/dist/cjs/services/pinterest_v2/client.d.ts +15 -0
- package/dist/cjs/services/pinterest_v2/client.d.ts.map +1 -0
- package/dist/cjs/services/pinterest_v2/client.js +28 -0
- package/dist/cjs/services/pinterest_v2/client.js.map +1 -0
- package/dist/cjs/services/pinterest_v2/index.d.ts +3 -0
- package/dist/cjs/services/pinterest_v2/index.d.ts.map +1 -0
- package/dist/cjs/services/pinterest_v2/index.js +22 -0
- package/dist/cjs/services/pinterest_v2/index.js.map +1 -0
- package/dist/cjs/services/pinterest_v2/types.d.ts +558 -0
- package/dist/cjs/services/pinterest_v2/types.d.ts.map +1 -0
- package/dist/cjs/services/pinterest_v2/types.js +4 -0
- package/dist/cjs/services/pinterest_v2/types.js.map +1 -0
- package/dist/cjs/services/ponsfamily/client.d.ts +8 -8
- package/dist/cjs/services/ponsfamily/client.d.ts.map +1 -1
- package/dist/cjs/services/ponsfamily/client.js +8 -8
- package/dist/cjs/services/ponsfamily/client.js.map +1 -1
- package/dist/cjs/services/ponsfamily/types.d.ts +83 -14
- package/dist/cjs/services/ponsfamily/types.d.ts.map +1 -1
- package/dist/cjs/services/pumpfun/client.d.ts +56 -56
- package/dist/cjs/services/pumpfun/client.d.ts.map +1 -1
- package/dist/cjs/services/pumpfun/client.js +56 -56
- package/dist/cjs/services/pumpfun/client.js.map +1 -1
- package/dist/cjs/services/pumpfun/types.d.ts +280 -101
- package/dist/cjs/services/pumpfun/types.d.ts.map +1 -1
- package/dist/cjs/services/twitter/client.d.ts +5 -5
- package/dist/cjs/services/twitter/client.d.ts.map +1 -1
- package/dist/cjs/services/twitter/client.js +5 -5
- package/dist/cjs/services/twitter/client.js.map +1 -1
- package/dist/cjs/services/twitter/types.d.ts +294 -403
- package/dist/cjs/services/twitter/types.d.ts.map +1 -1
- package/dist/cjs/services/youtube/client.d.ts +11 -11
- package/dist/cjs/services/youtube/client.d.ts.map +1 -1
- package/dist/cjs/services/youtube/client.js +11 -11
- package/dist/cjs/services/youtube/client.js.map +1 -1
- package/dist/cjs/services/youtube/types.d.ts +164 -158
- package/dist/cjs/services/youtube/types.d.ts.map +1 -1
- package/dist/cjs/services/zillow/client.d.ts +8 -6
- package/dist/cjs/services/zillow/client.d.ts.map +1 -1
- package/dist/cjs/services/zillow/client.js +10 -5
- package/dist/cjs/services/zillow/client.js.map +1 -1
- package/dist/cjs/services/zillow/types.d.ts +720 -886
- package/dist/cjs/services/zillow/types.d.ts.map +1 -1
- package/dist/client.d.ts +2 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +3 -0
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/services/airbnb/client.d.ts +6 -6
- package/dist/services/airbnb/client.d.ts.map +1 -1
- package/dist/services/airbnb/client.js +6 -6
- package/dist/services/airbnb/client.js.map +1 -1
- package/dist/services/birdeye/client.d.ts +10 -10
- package/dist/services/birdeye/client.d.ts.map +1 -1
- package/dist/services/birdeye/client.js +10 -10
- package/dist/services/birdeye/client.js.map +1 -1
- package/dist/services/brave_search/client.d.ts +1 -1
- package/dist/services/brave_search/client.d.ts.map +1 -1
- package/dist/services/brave_search/client.js +1 -1
- package/dist/services/brave_search/client.js.map +1 -1
- package/dist/services/brave_search/types.d.ts +1211 -1273
- package/dist/services/brave_search/types.d.ts.map +1 -1
- package/dist/services/facebook/types.d.ts +417 -430
- package/dist/services/facebook/types.d.ts.map +1 -1
- package/dist/services/facebook_ad_library/types.d.ts +259 -182
- package/dist/services/facebook_ad_library/types.d.ts.map +1 -1
- package/dist/services/facebook_marketplace/types.d.ts +162 -170
- package/dist/services/facebook_marketplace/types.d.ts.map +1 -1
- package/dist/services/geckoterminal/client.d.ts +2 -2
- package/dist/services/geckoterminal/client.d.ts.map +1 -1
- package/dist/services/geckoterminal/client.js +2 -2
- package/dist/services/geckoterminal/client.js.map +1 -1
- package/dist/services/geckoterminal/types.d.ts +15 -4
- package/dist/services/geckoterminal/types.d.ts.map +1 -1
- package/dist/services/gmgn/client.d.ts +18 -18
- package/dist/services/gmgn/client.d.ts.map +1 -1
- package/dist/services/gmgn/client.js +18 -18
- package/dist/services/gmgn/client.js.map +1 -1
- package/dist/services/gmgn/types.d.ts +2 -2
- package/dist/services/gmgn/types.d.ts.map +1 -1
- package/dist/services/goplus/client.d.ts +3 -3
- package/dist/services/goplus/client.d.ts.map +1 -1
- package/dist/services/goplus/client.js +3 -3
- package/dist/services/goplus/client.js.map +1 -1
- package/dist/services/imovelweb/client.d.ts +6 -6
- package/dist/services/imovelweb/client.d.ts.map +1 -1
- package/dist/services/imovelweb/client.js +6 -6
- package/dist/services/imovelweb/client.js.map +1 -1
- package/dist/services/indeed/types.d.ts +233 -187
- package/dist/services/indeed/types.d.ts.map +1 -1
- package/dist/services/instagram/client.d.ts +12 -12
- package/dist/services/instagram/client.d.ts.map +1 -1
- package/dist/services/instagram/client.js +12 -12
- package/dist/services/instagram/client.js.map +1 -1
- package/dist/services/instagram/types.d.ts +399 -2284
- package/dist/services/instagram/types.d.ts.map +1 -1
- package/dist/services/linkedin/client.d.ts +7 -7
- package/dist/services/linkedin/client.d.ts.map +1 -1
- package/dist/services/linkedin/client.js +7 -7
- package/dist/services/linkedin/client.js.map +1 -1
- package/dist/services/pinterest/client.d.ts +4 -4
- package/dist/services/pinterest/client.d.ts.map +1 -1
- package/dist/services/pinterest/client.js +4 -4
- package/dist/services/pinterest/client.js.map +1 -1
- package/dist/services/pinterest/types.d.ts +740 -711
- package/dist/services/pinterest/types.d.ts.map +1 -1
- package/dist/services/pinterest_v2/client.d.ts +15 -0
- package/dist/services/pinterest_v2/client.d.ts.map +1 -0
- package/dist/services/pinterest_v2/client.js +24 -0
- package/dist/services/pinterest_v2/client.js.map +1 -0
- package/dist/services/pinterest_v2/index.d.ts +3 -0
- package/dist/services/pinterest_v2/index.d.ts.map +1 -0
- package/dist/services/pinterest_v2/index.js +4 -0
- package/dist/services/pinterest_v2/index.js.map +1 -0
- package/dist/services/pinterest_v2/types.d.ts +558 -0
- package/dist/services/pinterest_v2/types.d.ts.map +1 -0
- package/dist/services/pinterest_v2/types.js +3 -0
- package/dist/services/pinterest_v2/types.js.map +1 -0
- package/dist/services/ponsfamily/client.d.ts +8 -8
- package/dist/services/ponsfamily/client.d.ts.map +1 -1
- package/dist/services/ponsfamily/client.js +8 -8
- package/dist/services/ponsfamily/client.js.map +1 -1
- package/dist/services/ponsfamily/types.d.ts +83 -14
- package/dist/services/ponsfamily/types.d.ts.map +1 -1
- package/dist/services/pumpfun/client.d.ts +56 -56
- package/dist/services/pumpfun/client.d.ts.map +1 -1
- package/dist/services/pumpfun/client.js +56 -56
- package/dist/services/pumpfun/client.js.map +1 -1
- package/dist/services/pumpfun/types.d.ts +280 -101
- package/dist/services/pumpfun/types.d.ts.map +1 -1
- package/dist/services/twitter/client.d.ts +5 -5
- package/dist/services/twitter/client.d.ts.map +1 -1
- package/dist/services/twitter/client.js +5 -5
- package/dist/services/twitter/client.js.map +1 -1
- package/dist/services/twitter/types.d.ts +294 -403
- package/dist/services/twitter/types.d.ts.map +1 -1
- package/dist/services/youtube/client.d.ts +11 -11
- package/dist/services/youtube/client.d.ts.map +1 -1
- package/dist/services/youtube/client.js +11 -11
- package/dist/services/youtube/client.js.map +1 -1
- package/dist/services/youtube/types.d.ts +164 -158
- package/dist/services/youtube/types.d.ts.map +1 -1
- package/dist/services/zillow/client.d.ts +8 -6
- package/dist/services/zillow/client.d.ts.map +1 -1
- package/dist/services/zillow/client.js +10 -5
- package/dist/services/zillow/client.js.map +1 -1
- package/dist/services/zillow/types.d.ts +720 -886
- package/dist/services/zillow/types.d.ts.map +1 -1
- package/package.json +3 -2
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
export interface ErrorDetail {
|
|
2
|
-
|
|
3
|
-
input?: unknown | null;
|
|
2
|
+
type?: string | null;
|
|
4
3
|
loc?: (string | number)[] | null;
|
|
5
4
|
msg?: string | null;
|
|
6
|
-
|
|
5
|
+
input?: unknown | null;
|
|
6
|
+
ctx?: Record<string, unknown> | null;
|
|
7
7
|
}
|
|
8
8
|
export interface ErrorResponse {
|
|
9
9
|
code: PublicError;
|
|
10
|
-
details?: ErrorDetail[] | null;
|
|
11
|
-
domain?: string | null;
|
|
12
10
|
message: string;
|
|
13
11
|
request_id: string;
|
|
12
|
+
domain?: string | null;
|
|
13
|
+
details?: ErrorDetail[] | null;
|
|
14
14
|
upgrade_url?: string | null;
|
|
15
15
|
}
|
|
16
16
|
export interface GetCompanyParams {
|
|
@@ -22,39 +22,42 @@ export interface GetCompanyParams {
|
|
|
22
22
|
language?: IndeedLanguage | null;
|
|
23
23
|
}
|
|
24
24
|
export interface GetJobParams {
|
|
25
|
-
/** Indeed country site the job was posted on (`gb` is the UK); Indeed sends its pay only there. */
|
|
26
|
-
country?: IndeedCountry;
|
|
27
25
|
/** Indeed job key: `key` of a search result, or `jk` in a viewjob URL. */
|
|
28
26
|
job_key: string;
|
|
27
|
+
/** Indeed country site the job was posted on (`gb` is the UK); Indeed sends its pay only there. */
|
|
28
|
+
country?: IndeedCountry;
|
|
29
29
|
}
|
|
30
30
|
export interface GetSalariesParams {
|
|
31
|
-
/** Indeed company key, to keep to one employer's pay reports. */
|
|
32
|
-
company_key?: string | null;
|
|
33
|
-
/** Job title; leave out for every title. */
|
|
34
|
-
job_title?: string | null;
|
|
35
31
|
/** Country, state or city as Indeed's path (`US`, `US/TX`, `US/TX/Austin`); location suggestions carry it as `salary_location` for US cities. */
|
|
36
32
|
location: string;
|
|
33
|
+
/** Job title; leave out for every title. */
|
|
34
|
+
job_title?: string | null;
|
|
35
|
+
/** Indeed company key, to keep to one employer's pay reports. */
|
|
36
|
+
company_key?: string | null;
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Indeed Apply
|
|
39
|
+
* Indeed Apply metadata. Token-derived fields are null when the token does not decode.
|
|
40
40
|
*
|
|
41
41
|
* `ats_job_id` is the job's id in the employer's applicant system. `required_resume_fields` and
|
|
42
42
|
* `optional_resume_fields` list the résumé sections the application requires or offers, comma-separated
|
|
43
|
-
* (`phone,education,skills`).
|
|
43
|
+
* (`phone,education,skills`). `scopes` appears only when Indeed sends it and names supported clients such as
|
|
44
|
+
* `desktop` and `mobile`. `locale` is the language or locale tag a few tokens carry (`en`, `fr`, `en_US`).
|
|
44
45
|
*/
|
|
45
46
|
export interface IndeedApply {
|
|
47
|
+
ats_job_id: string | null;
|
|
46
48
|
advertiser_number: string | null;
|
|
49
|
+
scopes?: string[] | null;
|
|
47
50
|
asks_for: IndeedApplyAsks | null;
|
|
48
|
-
ats_job_id: string | null;
|
|
49
|
-
optional_resume_fields: string | null;
|
|
50
51
|
required_resume_fields: string | null;
|
|
52
|
+
optional_resume_fields: string | null;
|
|
53
|
+
locale: string | null;
|
|
51
54
|
}
|
|
52
55
|
/** `required`, `optional` or `hidden` per item; `name` is the name format asked: `first_and_last` or `full`. */
|
|
53
56
|
export interface IndeedApplyAsks {
|
|
54
|
-
cover_letter: string | null;
|
|
55
57
|
name: string | null;
|
|
56
|
-
phone: string | null;
|
|
57
58
|
resume: string | null;
|
|
59
|
+
cover_letter: string | null;
|
|
60
|
+
phone: string | null;
|
|
58
61
|
}
|
|
59
62
|
export interface IndeedAttribute {
|
|
60
63
|
code: string;
|
|
@@ -62,27 +65,29 @@ export interface IndeedAttribute {
|
|
|
62
65
|
}
|
|
63
66
|
export interface IndeedAttributeCount {
|
|
64
67
|
code: string;
|
|
65
|
-
count: number;
|
|
66
68
|
label: string | null;
|
|
69
|
+
count: number;
|
|
67
70
|
}
|
|
68
71
|
export interface IndeedCeo {
|
|
69
|
-
approval: IndeedCeoApproval | null;
|
|
70
72
|
name: string | null;
|
|
73
|
+
approval: IndeedCeoApproval | null;
|
|
71
74
|
photo_url: string | null;
|
|
72
75
|
}
|
|
76
|
+
/** `percent` is the share of yes answers, rounded to a whole number. */
|
|
73
77
|
export interface IndeedCeoApproval {
|
|
74
|
-
no_count: number | null;
|
|
75
78
|
yes_count: number | null;
|
|
79
|
+
no_count: number | null;
|
|
80
|
+
percent: number | null;
|
|
76
81
|
}
|
|
77
82
|
/** `key` is Indeed's `<state>|<county>|<admin3>||<city>` facet key, split into the other fields; Indeed sends no labels for the codes. */
|
|
78
83
|
export interface IndeedCityFacet {
|
|
79
|
-
|
|
80
|
-
city: string | null;
|
|
84
|
+
key: string;
|
|
81
85
|
count: number;
|
|
86
|
+
city: string | null;
|
|
87
|
+
state_code: string | null;
|
|
82
88
|
county_code: string | null;
|
|
89
|
+
admin3_code: string | null;
|
|
83
90
|
is_remote: boolean;
|
|
84
|
-
key: string;
|
|
85
|
-
state_code: string | null;
|
|
86
91
|
}
|
|
87
92
|
export interface IndeedCodeLabel {
|
|
88
93
|
code: string | null;
|
|
@@ -90,28 +95,30 @@ export interface IndeedCodeLabel {
|
|
|
90
95
|
}
|
|
91
96
|
/** `description` is the short blurb and `about` the long text of the company page. `industry` is Indeed's single industry label and `sectors` its sector list; either may be empty alone. `headquarters` lists the places Indeed gives as head office. `reported_pay` is for the requested country. */
|
|
92
97
|
export interface IndeedCompany {
|
|
93
|
-
about: string | null;
|
|
94
|
-
brand_color: string | null;
|
|
95
|
-
ceo: IndeedCeo;
|
|
96
|
-
description: string | null;
|
|
97
|
-
happiness: IndeedCompanyHappiness;
|
|
98
|
-
headquarters: string[];
|
|
99
|
-
images: IndeedCompanyImages;
|
|
100
|
-
industry: string | null;
|
|
101
|
-
is_claimed: boolean | null;
|
|
102
98
|
key: string;
|
|
103
|
-
links: IndeedCompanyLinks;
|
|
104
99
|
name: string | null;
|
|
105
|
-
|
|
100
|
+
description: string | null;
|
|
101
|
+
about: string | null;
|
|
106
102
|
page_url: string | null;
|
|
107
|
-
|
|
108
|
-
|
|
103
|
+
page_path: string | null;
|
|
104
|
+
reviews_url: string | null;
|
|
105
|
+
salaries_url: string | null;
|
|
106
|
+
links: IndeedCompanyLinks;
|
|
109
107
|
reported_pay: IndeedReportedPay;
|
|
110
|
-
|
|
111
|
-
|
|
108
|
+
ratings: IndeedCompanyRatings;
|
|
109
|
+
happiness: IndeedCompanyHappiness;
|
|
112
110
|
similar_companies: IndeedCompanySummary[];
|
|
111
|
+
industry: string | null;
|
|
112
|
+
sectors: string[];
|
|
113
113
|
size: IndeedCodeLabel;
|
|
114
|
+
revenue: IndeedCodeLabel;
|
|
115
|
+
headquarters: string[];
|
|
116
|
+
profile_sections: IndeedProfileSection[];
|
|
117
|
+
ceo: IndeedCeo;
|
|
118
|
+
is_claimed: boolean | null;
|
|
119
|
+
brand_color: string | null;
|
|
114
120
|
stock_symbol: string | null;
|
|
121
|
+
images: IndeedCompanyImages;
|
|
115
122
|
}
|
|
116
123
|
/** `total_count` is how many companies Indeed would list for the query, at most 50. */
|
|
117
124
|
export interface IndeedCompanyDirectory {
|
|
@@ -125,66 +132,66 @@ export interface IndeedCompanyDirectoryEntry {
|
|
|
125
132
|
}
|
|
126
133
|
/** Indeed's facet sends company keys only; `/v1/indeed/companies/{company_key}` names one. */
|
|
127
134
|
export interface IndeedCompanyFacet {
|
|
128
|
-
count: number;
|
|
129
135
|
key: string;
|
|
136
|
+
count: number;
|
|
130
137
|
}
|
|
131
138
|
export interface IndeedCompanyHappiness {
|
|
132
|
-
|
|
139
|
+
overall: IndeedHappinessScore | null;
|
|
140
|
+
management: IndeedHappinessScore | null;
|
|
141
|
+
learning: IndeedHappinessScore | null;
|
|
133
142
|
appreciation: IndeedHappinessScore | null;
|
|
134
143
|
belonging: IndeedHappinessScore | null;
|
|
144
|
+
purpose: IndeedHappinessScore | null;
|
|
145
|
+
achievement: IndeedHappinessScore | null;
|
|
135
146
|
energy: IndeedHappinessScore | null;
|
|
136
147
|
flexibility: IndeedHappinessScore | null;
|
|
137
148
|
inclusion: IndeedHappinessScore | null;
|
|
138
|
-
learning: IndeedHappinessScore | null;
|
|
139
|
-
management: IndeedHappinessScore | null;
|
|
140
|
-
overall: IndeedHappinessScore | null;
|
|
141
|
-
purpose: IndeedHappinessScore | null;
|
|
142
149
|
support: IndeedHappinessScore | null;
|
|
143
150
|
trust: IndeedHappinessScore | null;
|
|
144
151
|
}
|
|
145
152
|
export interface IndeedCompanyImages {
|
|
146
|
-
header_url: string | null;
|
|
147
153
|
logo_url: string | null;
|
|
154
|
+
header_url: string | null;
|
|
148
155
|
rectangular_logo_url: string | null;
|
|
149
156
|
}
|
|
150
157
|
export interface IndeedCompanyLinks {
|
|
158
|
+
website: string | null;
|
|
151
159
|
facebook: string | null;
|
|
152
|
-
instagram: string | null;
|
|
153
160
|
twitter: string | null;
|
|
154
|
-
|
|
161
|
+
instagram: string | null;
|
|
155
162
|
}
|
|
156
163
|
export interface IndeedCompanyRatings {
|
|
164
|
+
overall: IndeedRating | null;
|
|
165
|
+
work_life_balance: IndeedRating | null;
|
|
157
166
|
compensation_and_benefits: IndeedRating | null;
|
|
158
|
-
culture_and_values: IndeedRating | null;
|
|
159
167
|
job_security_and_advancement: IndeedRating | null;
|
|
160
168
|
management: IndeedRating | null;
|
|
161
|
-
|
|
162
|
-
work_life_balance: IndeedRating | null;
|
|
169
|
+
culture_and_values: IndeedRating | null;
|
|
163
170
|
}
|
|
164
171
|
/** `score` is Indeed's relative autocomplete ranking. `logo_url` is the 64 px logo; `square_logo_64`, `intent_confidence` and `sub_query` are further autocomplete fields Indeed left empty in every sample. */
|
|
165
172
|
export interface IndeedCompanySuggestion {
|
|
166
|
-
intent_confidence: string | null;
|
|
167
173
|
key: string;
|
|
168
|
-
logo_url: string | null;
|
|
169
174
|
name: string | null;
|
|
170
|
-
page_path: string | null;
|
|
171
175
|
page_url: string | null;
|
|
176
|
+
page_path: string | null;
|
|
172
177
|
score: number;
|
|
173
|
-
|
|
178
|
+
intent_confidence: string | null;
|
|
174
179
|
sub_query: string | null;
|
|
180
|
+
logo_url: string | null;
|
|
181
|
+
square_logo_64: string | null;
|
|
175
182
|
}
|
|
176
183
|
export interface IndeedCompanySuggestions {
|
|
177
184
|
companies: IndeedCompanySuggestion[];
|
|
178
185
|
}
|
|
179
186
|
/** `page_path` is the company's path on every Indeed country site; `page_url` puts it on the site of the request or the job. */
|
|
180
187
|
export interface IndeedCompanySummary {
|
|
181
|
-
is_claimed: boolean | null;
|
|
182
188
|
key: string;
|
|
183
|
-
logo_url: string | null;
|
|
184
189
|
name: string | null;
|
|
185
|
-
page_path: string | null;
|
|
186
190
|
page_url: string | null;
|
|
191
|
+
page_path: string | null;
|
|
187
192
|
rating: IndeedRating | null;
|
|
193
|
+
is_claimed: boolean | null;
|
|
194
|
+
logo_url: string | null;
|
|
188
195
|
}
|
|
189
196
|
export interface IndeedCoordinates {
|
|
190
197
|
latitude: number;
|
|
@@ -195,29 +202,30 @@ export type IndeedCountry = "ae" | "ar" | "at" | "au" | "be" | "bh" | "br" | "ca
|
|
|
195
202
|
export type IndeedCursorCompletion = "exhausted";
|
|
196
203
|
/** `completion` is `exhausted` on the last page and null while more pages follow; Indeed stops near 1,000 results whatever the total. */
|
|
197
204
|
export interface IndeedCursorPagination {
|
|
198
|
-
completion: IndeedCursorCompletion | null;
|
|
199
205
|
next_cursor: string | null;
|
|
200
206
|
previous_cursor: string | null;
|
|
207
|
+
completion: IndeedCursorCompletion | null;
|
|
201
208
|
}
|
|
202
209
|
export type IndeedDistanceUnit = "miles" | "kilometers";
|
|
203
210
|
/** How the hiring account behaves on Indeed: hires in the past 30 days, typical reply time in days, share of applicants answered (0 to 1). */
|
|
204
211
|
export interface IndeedEmployerActivity {
|
|
205
212
|
hires_last_30_days: number | null;
|
|
213
|
+
response_time_days: number | null;
|
|
214
|
+
response_rate: number | null;
|
|
206
215
|
is_actively_reviewing: boolean | null;
|
|
207
|
-
is_top_rated: boolean | null;
|
|
208
216
|
last_active_days_ago: number | null;
|
|
209
|
-
|
|
210
|
-
response_time_days: number | null;
|
|
217
|
+
is_top_rated: boolean | null;
|
|
211
218
|
}
|
|
212
219
|
export type IndeedExperienceLevel = "entry" | "mid" | "senior";
|
|
213
220
|
/** Work happiness from 0 to 100 over `count` survey answers. */
|
|
214
221
|
export interface IndeedHappinessScore {
|
|
215
|
-
count: number | null;
|
|
216
222
|
score: number | null;
|
|
223
|
+
count: number | null;
|
|
217
224
|
}
|
|
218
225
|
/**
|
|
219
226
|
* `title` is as posted, `standard_title` Indeed's standard title and `normalized_title` the lower-case form the search facets use (it drops suffixes such as `(m/w/d)`).
|
|
220
227
|
*
|
|
228
|
+
* `normalized_category` appears only when Indeed sends its job-category code.
|
|
221
229
|
* `employer_reference` is the employer's requisition id; `company_name_as_posted` stays set when the job has no
|
|
222
230
|
* Indeed company page (`company` null). `published_at` is the employer's posting time, often a date at midnight US
|
|
223
231
|
* Central; `posted_on_indeed_at` is when Indeed received it, which `posted_within_days` filters on.
|
|
@@ -225,32 +233,36 @@ export interface IndeedHappinessScore {
|
|
|
225
233
|
* `/v1/indeed/jobs/{job_key}`; search results send it null.
|
|
226
234
|
*/
|
|
227
235
|
export interface IndeedJob {
|
|
236
|
+
key: string;
|
|
237
|
+
title: string | null;
|
|
238
|
+
standard_title: string | null;
|
|
239
|
+
normalized_title: string | null;
|
|
240
|
+
description: string | null;
|
|
241
|
+
description_html: string | null;
|
|
242
|
+
language: string | null;
|
|
243
|
+
indeed_url: string;
|
|
244
|
+
description_urls: string[];
|
|
245
|
+
pay: IndeedPay | null;
|
|
228
246
|
applicants: IndeedJobApplicants | null;
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
247
|
+
status: IndeedJobStatus;
|
|
248
|
+
published_at: string | null;
|
|
249
|
+
posted_on_indeed_at: string | null;
|
|
250
|
+
expires_at: string | null;
|
|
251
|
+
company: IndeedJobCompany | null;
|
|
252
|
+
location: IndeedJobLocation | null;
|
|
253
|
+
origin: IndeedJobOrigin;
|
|
232
254
|
company_name_as_posted: string | null;
|
|
233
|
-
|
|
255
|
+
work_schedule: string | null;
|
|
234
256
|
detailed_salary: string | null;
|
|
257
|
+
description_emails: string[];
|
|
258
|
+
attributes: IndeedJobAttributes;
|
|
259
|
+
requirements: IndeedRequirement[];
|
|
260
|
+
occupations: IndeedAttribute[];
|
|
261
|
+
apply: IndeedJobApply;
|
|
235
262
|
employer_activity: IndeedEmployerActivity | null;
|
|
236
263
|
employer_reference: string | null;
|
|
237
|
-
|
|
238
|
-
indeed_url: string;
|
|
239
|
-
key: string;
|
|
240
|
-
language: string | null;
|
|
241
|
-
location: IndeedJobLocation | null;
|
|
242
|
-
normalized_title: string | null;
|
|
243
|
-
occupations: IndeedAttribute[];
|
|
244
|
-
origin: IndeedJobOrigin;
|
|
245
|
-
pay: IndeedPay | null;
|
|
264
|
+
normalized_category?: string | null;
|
|
246
265
|
photos: IndeedJobPhoto[];
|
|
247
|
-
posted_on_indeed_at: string | null;
|
|
248
|
-
published_at: string | null;
|
|
249
|
-
requirements: IndeedRequirement[];
|
|
250
|
-
standard_title: string | null;
|
|
251
|
-
status: IndeedJobStatus;
|
|
252
|
-
title: string | null;
|
|
253
|
-
work_schedule: string | null;
|
|
254
266
|
}
|
|
255
267
|
/** Applications so far: `organic` from job seekers, `sponsored` through Indeed's paid reach; `count` is their sum. */
|
|
256
268
|
export interface IndeedJobApplicants {
|
|
@@ -260,51 +272,80 @@ export interface IndeedJobApplicants {
|
|
|
260
272
|
}
|
|
261
273
|
/** `url` is the employer's or applicant system's page; `indeed_apply` is null when the job takes no Indeed Apply. */
|
|
262
274
|
export interface IndeedJobApply {
|
|
263
|
-
indeed_apply: IndeedApply | null;
|
|
264
275
|
url: string | null;
|
|
276
|
+
indeed_apply: IndeedApply | null;
|
|
265
277
|
}
|
|
266
278
|
/** Every code of the job's attributes, each in exactly one group. */
|
|
267
279
|
export interface IndeedJobAttributes {
|
|
280
|
+
job_types: IndeedAttribute[];
|
|
281
|
+
work_arrangement: IndeedAttribute[];
|
|
282
|
+
work_settings: IndeedAttribute[];
|
|
283
|
+
shifts: IndeedAttribute[];
|
|
284
|
+
schedules: IndeedAttribute[];
|
|
268
285
|
benefits: IndeedAttribute[];
|
|
269
286
|
compensation_package: IndeedAttribute[];
|
|
270
|
-
credentials: IndeedAttribute[];
|
|
271
|
-
education: IndeedAttribute[];
|
|
272
287
|
encouraged_to_apply: IndeedAttribute[];
|
|
273
|
-
experience_levels: IndeedAttribute[];
|
|
274
|
-
job_types: IndeedAttribute[];
|
|
275
288
|
other_job_details: IndeedAttribute[];
|
|
276
|
-
|
|
277
|
-
|
|
289
|
+
experience_levels: IndeedAttribute[];
|
|
290
|
+
education: IndeedAttribute[];
|
|
278
291
|
security_clearances: IndeedAttribute[];
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
292
|
+
credentials: IndeedAttribute[];
|
|
293
|
+
qualifications: IndeedAttribute[];
|
|
294
|
+
}
|
|
295
|
+
/** The hiring company with the profile facts the job answer carries; `/v1/indeed/companies/{company_key}` has the full profile. */
|
|
296
|
+
export interface IndeedJobCompany {
|
|
297
|
+
key: string;
|
|
298
|
+
name: string | null;
|
|
299
|
+
description: string | null;
|
|
300
|
+
page_url: string | null;
|
|
301
|
+
page_path: string | null;
|
|
302
|
+
website: string | null;
|
|
303
|
+
rating: IndeedRating | null;
|
|
304
|
+
parent_company: IndeedParentCompany | null;
|
|
305
|
+
is_claimed: boolean | null;
|
|
306
|
+
industry: string | null;
|
|
307
|
+
size: IndeedCodeLabel;
|
|
308
|
+
revenue: IndeedCodeLabel;
|
|
309
|
+
headquarters: string[];
|
|
310
|
+
ceo: IndeedJobCompanyCeo | null;
|
|
311
|
+
logo_url: string | null;
|
|
312
|
+
header_url: string | null;
|
|
313
|
+
}
|
|
314
|
+
export interface IndeedJobCompanyCeo {
|
|
315
|
+
name: string | null;
|
|
316
|
+
photo_url: string | null;
|
|
317
|
+
}
|
|
318
|
+
/** The stable group identity and number of related listings represented by one search result. A result without source grouping omits `group`. */
|
|
319
|
+
export interface IndeedJobGroup {
|
|
320
|
+
key: string;
|
|
321
|
+
count: number;
|
|
282
322
|
}
|
|
283
323
|
/** `county_*` is the second admin level and `admin3_*` the third (`GTL` Greater London). A remote job has `is_remote` true, its label `Remote`, and no city, address or coordinates. */
|
|
284
324
|
export interface IndeedJobLocation {
|
|
285
|
-
admin3_code: string | null;
|
|
286
|
-
admin3_name: string | null;
|
|
287
|
-
city: string | null;
|
|
288
|
-
coordinates: IndeedCoordinates | null;
|
|
289
|
-
country_code: string | null;
|
|
290
|
-
country_name: string | null;
|
|
291
|
-
county_code: string | null;
|
|
292
|
-
county_name: string | null;
|
|
293
|
-
full_address: string | null;
|
|
294
|
-
is_remote: boolean;
|
|
295
325
|
label: string | null;
|
|
296
326
|
label_long: string | null;
|
|
327
|
+
full_address: string | null;
|
|
328
|
+
street_address: string | null;
|
|
297
329
|
neighborhood: string | null;
|
|
298
330
|
postal_code: string | null;
|
|
299
|
-
|
|
331
|
+
city: string | null;
|
|
332
|
+
county_name: string | null;
|
|
333
|
+
county_code: string | null;
|
|
334
|
+
admin3_code: string | null;
|
|
335
|
+
admin3_name: string | null;
|
|
300
336
|
state_name: string | null;
|
|
301
|
-
|
|
337
|
+
state_code: string | null;
|
|
338
|
+
country_name: string | null;
|
|
339
|
+
country_code: string | null;
|
|
340
|
+
coordinates: IndeedCoordinates | null;
|
|
341
|
+
is_remote: boolean;
|
|
302
342
|
}
|
|
303
|
-
/** Who supplied the posting to Indeed
|
|
343
|
+
/** Who supplied the posting to Indeed. `source_key` and `feed_key` are opaque Indeed ids; `source_name` is the supplying account. `source_type` appears only when Indeed sends its feed classification. */
|
|
304
344
|
export interface IndeedJobOrigin {
|
|
305
|
-
feed_key: string | null;
|
|
306
345
|
source_key: string | null;
|
|
346
|
+
feed_key: string | null;
|
|
307
347
|
source_name: string | null;
|
|
348
|
+
source_type?: string | null;
|
|
308
349
|
}
|
|
309
350
|
/** A photo the employer added to the posting: its 400 px wide URL and alt text. */
|
|
310
351
|
export interface IndeedJobPhoto {
|
|
@@ -313,31 +354,30 @@ export interface IndeedJobPhoto {
|
|
|
313
354
|
}
|
|
314
355
|
/** Indeed's top five per facet. `attributes` ranks codes of every group, so it overlaps `job_types`; on a company's job list `companies` holds just that company. */
|
|
315
356
|
export interface IndeedJobSearchFacets {
|
|
316
|
-
attributes: IndeedAttributeCount[];
|
|
317
357
|
cities: IndeedCityFacet[];
|
|
318
358
|
companies: IndeedCompanyFacet[];
|
|
359
|
+
attributes: IndeedAttributeCount[];
|
|
319
360
|
job_types: IndeedAttributeCount[];
|
|
320
361
|
normalized_titles: IndeedTitleFacet[];
|
|
321
362
|
}
|
|
322
|
-
/** `tracking_key` is Indeed's id for this search; each result's own is `<tracking_key>-<job key>`. */
|
|
323
363
|
export interface IndeedJobSearchPage {
|
|
324
|
-
facets: IndeedJobSearchFacets;
|
|
325
|
-
pagination: IndeedCursorPagination;
|
|
326
364
|
results: IndeedJobSearchResult[];
|
|
327
365
|
total: IndeedResultTotal | null;
|
|
328
|
-
|
|
366
|
+
facets: IndeedJobSearchFacets;
|
|
367
|
+
pagination: IndeedCursorPagination;
|
|
329
368
|
}
|
|
330
369
|
export interface IndeedJobSearchResult {
|
|
331
|
-
job: IndeedJob;
|
|
332
370
|
snippet: string | null;
|
|
371
|
+
job: IndeedJob;
|
|
372
|
+
group?: IndeedJobGroup | null;
|
|
333
373
|
}
|
|
334
374
|
export type IndeedJobSort = "relevance" | "date";
|
|
335
375
|
/** A null flag means Indeed did not say; search results leave `is_repost` null. */
|
|
336
376
|
export interface IndeedJobStatus {
|
|
337
377
|
is_expired: boolean | null;
|
|
338
|
-
is_high_volume_hiring: boolean | null;
|
|
339
378
|
is_repost: boolean | null;
|
|
340
379
|
is_urgent_hire: boolean | null;
|
|
380
|
+
is_high_volume_hiring: boolean | null;
|
|
341
381
|
}
|
|
342
382
|
export type IndeedJobType = "full_time" | "part_time" | "contract" | "permanent" | "temporary" | "temp_to_hire" | "internship" | "prn" | "travel_nursing";
|
|
343
383
|
/** Label languages Indeed's country sites offer (ISO 639-1). */
|
|
@@ -354,24 +394,30 @@ export interface IndeedMoney {
|
|
|
354
394
|
amount: number;
|
|
355
395
|
currency: string | null;
|
|
356
396
|
}
|
|
397
|
+
export interface IndeedParentCompany {
|
|
398
|
+
key: string;
|
|
399
|
+
name: string | null;
|
|
400
|
+
page_url: string | null;
|
|
401
|
+
page_path: string | null;
|
|
402
|
+
}
|
|
357
403
|
/** `posted` is the employer's pay; `estimated` is Indeed's estimate, sent when the posting has none. `source` says how Indeed got the posted pay (`extraction`: read from the description). */
|
|
358
404
|
export interface IndeedPay {
|
|
405
|
+
text: string | null;
|
|
406
|
+
source: string | null;
|
|
359
407
|
currency: string | null;
|
|
360
|
-
estimated: IndeedPayRange | null;
|
|
361
408
|
posted: IndeedPayRange | null;
|
|
362
|
-
|
|
363
|
-
text: string | null;
|
|
409
|
+
estimated: IndeedPayRange | null;
|
|
364
410
|
}
|
|
365
411
|
/** Mean of the `count` reports quoted in this pay period only, so periods do not convert into each other. */
|
|
366
412
|
export interface IndeedPayMean {
|
|
367
|
-
count: number;
|
|
368
413
|
mean: IndeedMoney;
|
|
414
|
+
count: number;
|
|
369
415
|
}
|
|
370
416
|
/** `kind` is `range`, `exactly`, `at_least` or `at_most`; `exactly` fills `min` and `max` with the one amount. */
|
|
371
417
|
export interface IndeedPayRange {
|
|
372
418
|
kind: string | null;
|
|
373
|
-
max: IndeedMoney | null;
|
|
374
419
|
min: IndeedMoney | null;
|
|
420
|
+
max: IndeedMoney | null;
|
|
375
421
|
period: string | null;
|
|
376
422
|
}
|
|
377
423
|
export interface IndeedPopularSearches {
|
|
@@ -381,13 +427,13 @@ export interface IndeedPopularSearches {
|
|
|
381
427
|
export type IndeedPostedWithin = 1 | 3 | 7 | 14;
|
|
382
428
|
/** A section the company wrote for its Indeed page, its body as HTML. */
|
|
383
429
|
export interface IndeedProfileSection {
|
|
384
|
-
html: string | null;
|
|
385
430
|
title: string | null;
|
|
431
|
+
html: string | null;
|
|
386
432
|
}
|
|
387
433
|
/** Mean employee rating from 1 to 5 over `count` reviews; null where nobody has rated. */
|
|
388
434
|
export interface IndeedRating {
|
|
389
|
-
count: number | null;
|
|
390
435
|
value: number | null;
|
|
436
|
+
count: number | null;
|
|
391
437
|
}
|
|
392
438
|
/**
|
|
393
439
|
* Pay reported to Indeed in one country, by the period each report was quoted in.
|
|
@@ -395,14 +441,14 @@ export interface IndeedRating {
|
|
|
395
441
|
* `currency` is that country's: Indeed sends none with salary reports.
|
|
396
442
|
*/
|
|
397
443
|
export interface IndeedReportedPay {
|
|
444
|
+
report_count: number;
|
|
398
445
|
country_code: string;
|
|
399
446
|
currency: string;
|
|
400
|
-
|
|
401
|
-
hour: IndeedPayMean | null;
|
|
447
|
+
year: IndeedPayMean | null;
|
|
402
448
|
month: IndeedPayMean | null;
|
|
403
|
-
report_count: number;
|
|
404
449
|
week: IndeedPayMean | null;
|
|
405
|
-
|
|
450
|
+
day: IndeedPayMean | null;
|
|
451
|
+
hour: IndeedPayMean | null;
|
|
406
452
|
}
|
|
407
453
|
/** A qualification the employer marked, with `severity` `required` or `preferred`; the same code also sits in `attributes`. */
|
|
408
454
|
export interface IndeedRequirement {
|
|
@@ -418,84 +464,84 @@ export interface IndeedResultTotal {
|
|
|
418
464
|
export interface IndeedSalaries {
|
|
419
465
|
company_key: string | null;
|
|
420
466
|
job_title: string | null;
|
|
421
|
-
location: string;
|
|
422
467
|
reported_pay: IndeedReportedPay;
|
|
468
|
+
location: string;
|
|
423
469
|
}
|
|
424
470
|
export interface IndeedSuggestions {
|
|
425
471
|
suggestions: string[];
|
|
426
472
|
}
|
|
427
473
|
export interface IndeedTitleFacet {
|
|
428
|
-
count: number;
|
|
429
474
|
title: string;
|
|
475
|
+
count: number;
|
|
430
476
|
}
|
|
431
477
|
export type IndeedWorkSetting = "remote" | "hybrid" | "in_person" | "office";
|
|
432
478
|
export interface ListCompanyDirectoryParams {
|
|
479
|
+
/** Company name, industry word or job title. */
|
|
480
|
+
query: string;
|
|
481
|
+
/** City, state or country to keep to (`Houston, TX`); leave out for the whole country site. */
|
|
482
|
+
location?: string | null;
|
|
433
483
|
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
434
484
|
country?: IndeedCountry;
|
|
435
485
|
/** Companies to return. */
|
|
436
486
|
limit?: number;
|
|
437
|
-
/** City, state or country to keep to (`Houston, TX`); leave out for the whole country site. */
|
|
438
|
-
location?: string | null;
|
|
439
|
-
/** Company name, industry word or job title. */
|
|
440
|
-
query: string;
|
|
441
487
|
}
|
|
442
488
|
export interface ListCompanyJobsParams {
|
|
443
|
-
/** Attribute `code` from a job (skill, benefit, licence); repeat for jobs carrying every code. */
|
|
444
|
-
attribute?: string[];
|
|
445
489
|
/** Indeed company key, from `/v1/indeed/companies/search` or a job's `company.key`. */
|
|
446
490
|
company_key: string;
|
|
447
|
-
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
448
|
-
country?: IndeedCountry;
|
|
449
|
-
/** `pagination.next_cursor` or `previous_cursor` of the last page; send the same search and `limit` with it. */
|
|
450
|
-
cursor?: string;
|
|
451
|
-
/** Attribute `code` to leave out; jobs carrying any of them drop. */
|
|
452
|
-
exclude_attribute?: string[];
|
|
453
|
-
/** Job types to leave out, from the `job_type` values. */
|
|
454
|
-
exclude_job_type?: IndeedJobType[];
|
|
455
|
-
/** `entry`, `mid` or `senior`; repeat for jobs at any of them. */
|
|
456
|
-
experience_level?: IndeedExperienceLevel[];
|
|
457
|
-
/** `full_time`, `part_time`, `contract`, `permanent`, `temporary`, `temp_to_hire`, `internship`, `prn` or `travel_nursing`; repeat for jobs of any of them. */
|
|
458
|
-
job_type?: IndeedJobType[];
|
|
459
|
-
/** Jobs to return, up to 25 per call. */
|
|
460
|
-
limit?: number;
|
|
461
|
-
/** City, state or postcode (`Austin, TX`); leave out to search the whole country. */
|
|
462
|
-
location?: string | null;
|
|
463
|
-
/** Minimum yearly pay in the country's currency; Indeed annualises hourly pay. */
|
|
464
|
-
min_salary?: number | null;
|
|
465
|
-
/** Occupation `code` from a job's `occupations`; repeat for jobs in every one. */
|
|
466
|
-
occupation?: string[];
|
|
467
|
-
/** Only jobs that reached Indeed this many days ago or less. */
|
|
468
|
-
posted_within_days?: IndeedPostedWithin | null;
|
|
469
491
|
/** Keywords to narrow the company's jobs; empty lists them all. */
|
|
470
492
|
query?: string;
|
|
493
|
+
/** City, state or postcode (`Austin, TX`); leave out to search the whole country. */
|
|
494
|
+
location?: string | null;
|
|
471
495
|
/** Distance around `location`; 0 keeps to that place. Ignored without `location`. */
|
|
472
496
|
radius?: number;
|
|
473
497
|
/** Unit of `radius`: `miles` or `kilometers`. */
|
|
474
498
|
radius_unit?: IndeedDistanceUnit;
|
|
499
|
+
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
500
|
+
country?: IndeedCountry;
|
|
475
501
|
/** `relevance`, or `date` to favour recent postings; Indeed does not order the page strictly by date. */
|
|
476
502
|
sort?: IndeedJobSort;
|
|
503
|
+
/** Jobs to return, up to 25 per call. */
|
|
504
|
+
limit?: number;
|
|
505
|
+
/** `pagination.next_cursor` or `previous_cursor` of the last page; send the same search and `limit` with it. */
|
|
506
|
+
cursor?: string;
|
|
507
|
+
/** `full_time`, `part_time`, `contract`, `permanent`, `temporary`, `temp_to_hire`, `internship`, `prn` or `travel_nursing`; repeat for jobs of any of them. */
|
|
508
|
+
job_type?: IndeedJobType[];
|
|
477
509
|
/** `remote`, `hybrid`, `in_person` or `office`; repeat for jobs with any of them. */
|
|
478
510
|
work_setting?: IndeedWorkSetting[];
|
|
511
|
+
/** `entry`, `mid` or `senior`; repeat for jobs at any of them. */
|
|
512
|
+
experience_level?: IndeedExperienceLevel[];
|
|
513
|
+
/** Attribute `code` from a job (skill, benefit, licence); repeat for jobs carrying every code. */
|
|
514
|
+
attribute?: string[];
|
|
515
|
+
/** Occupation `code` from a job's `occupations`; repeat for jobs in every one. */
|
|
516
|
+
occupation?: string[];
|
|
517
|
+
/** Job types to leave out, from the `job_type` values. */
|
|
518
|
+
exclude_job_type?: IndeedJobType[];
|
|
519
|
+
/** Attribute `code` to leave out; jobs carrying any of them drop. */
|
|
520
|
+
exclude_attribute?: string[];
|
|
521
|
+
/** Only jobs that reached Indeed this many days ago or less. */
|
|
522
|
+
posted_within_days?: IndeedPostedWithin | null;
|
|
523
|
+
/** Minimum yearly pay in the country's currency; Indeed annualises hourly pay. */
|
|
524
|
+
min_salary?: number | null;
|
|
479
525
|
}
|
|
480
526
|
export interface ListJobTitleSuggestionsParams {
|
|
527
|
+
/** The text typed so far. */
|
|
528
|
+
query: string;
|
|
481
529
|
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
482
530
|
country?: IndeedCountry;
|
|
483
531
|
/** Label language; one the country site offers, defaulting to its main language. */
|
|
484
532
|
language?: IndeedLanguage | null;
|
|
485
533
|
/** Suggestions to return. */
|
|
486
534
|
limit?: number;
|
|
487
|
-
/** The text typed so far. */
|
|
488
|
-
query: string;
|
|
489
535
|
}
|
|
490
536
|
export interface ListLocationSuggestionsParams {
|
|
537
|
+
/** City, state or postcode typed so far. */
|
|
538
|
+
query: string;
|
|
491
539
|
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
492
540
|
country?: IndeedCountry;
|
|
493
541
|
/** Label language; one the country site offers, defaulting to its main language. */
|
|
494
542
|
language?: IndeedLanguage | null;
|
|
495
543
|
/** Suggestions to return. */
|
|
496
544
|
limit?: number;
|
|
497
|
-
/** City, state or postcode typed so far. */
|
|
498
|
-
query: string;
|
|
499
545
|
}
|
|
500
546
|
export interface ListPopularSearchesParams {
|
|
501
547
|
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
@@ -507,51 +553,51 @@ export interface ListPopularSearchesParams {
|
|
|
507
553
|
}
|
|
508
554
|
export type PublicError = "blocked" | "concurrency_exceeded" | "timeout" | "extraction_failed" | "upstream_blocked" | "upstream_unavailable" | "upstream_response_invalid" | "invalid_url_scheme" | "invalid_url_host" | "unauthenticated" | "forbidden" | "resource_forbidden" | "not_found" | "rate_limited" | "invalid_request" | "invalid_cursor" | "insufficient_credits" | "internal_error";
|
|
509
555
|
export interface SearchCompaniesParams {
|
|
556
|
+
/** Company name, or its start. */
|
|
557
|
+
query: string;
|
|
510
558
|
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
511
559
|
country?: IndeedCountry;
|
|
512
560
|
/** Label language; one the country site offers, defaulting to its main language. */
|
|
513
561
|
language?: IndeedLanguage | null;
|
|
514
562
|
/** Suggestions to return. */
|
|
515
563
|
limit?: number;
|
|
516
|
-
/** Company name, or its start. */
|
|
517
|
-
query: string;
|
|
518
564
|
}
|
|
519
565
|
export interface SearchJobsParams {
|
|
520
|
-
/** Attribute `code` from a job (skill, benefit, licence); repeat for jobs carrying every code. */
|
|
521
|
-
attribute?: string[];
|
|
522
|
-
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
523
|
-
country?: IndeedCountry;
|
|
524
|
-
/** `pagination.next_cursor` or `previous_cursor` of the last page; send the same search and `limit` with it. */
|
|
525
|
-
cursor?: string;
|
|
526
|
-
/** Attribute `code` to leave out; jobs carrying any of them drop. */
|
|
527
|
-
exclude_attribute?: string[];
|
|
528
|
-
/** Company `key` whose jobs to leave out. */
|
|
529
|
-
exclude_company?: string[];
|
|
530
|
-
/** Job types to leave out, from the `job_type` values. */
|
|
531
|
-
exclude_job_type?: IndeedJobType[];
|
|
532
|
-
/** `entry`, `mid` or `senior`; repeat for jobs at any of them. */
|
|
533
|
-
experience_level?: IndeedExperienceLevel[];
|
|
534
|
-
/** `full_time`, `part_time`, `contract`, `permanent`, `temporary`, `temp_to_hire`, `internship`, `prn` or `travel_nursing`; repeat for jobs of any of them. */
|
|
535
|
-
job_type?: IndeedJobType[];
|
|
536
|
-
/** Jobs to return, up to 25 per call. */
|
|
537
|
-
limit?: number;
|
|
538
|
-
/** City, state or postcode (`Austin, TX`); leave out to search the whole country. */
|
|
539
|
-
location?: string | null;
|
|
540
|
-
/** Minimum yearly pay in the country's currency; Indeed annualises hourly pay. */
|
|
541
|
-
min_salary?: number | null;
|
|
542
|
-
/** Occupation `code` from a job's `occupations`; repeat for jobs in every one. */
|
|
543
|
-
occupation?: string[];
|
|
544
|
-
/** Only jobs that reached Indeed this many days ago or less. */
|
|
545
|
-
posted_within_days?: IndeedPostedWithin | null;
|
|
546
566
|
/** Job title, skill or company, as typed into Indeed. */
|
|
547
567
|
query: string;
|
|
568
|
+
/** City, state or postcode (`Austin, TX`); leave out to search the whole country. */
|
|
569
|
+
location?: string | null;
|
|
548
570
|
/** Distance around `location`; 0 keeps to that place. Ignored without `location`. */
|
|
549
571
|
radius?: number;
|
|
550
572
|
/** Unit of `radius`: `miles` or `kilometers`. */
|
|
551
573
|
radius_unit?: IndeedDistanceUnit;
|
|
574
|
+
/** Indeed country site, as an ISO code (`gb` is the UK). */
|
|
575
|
+
country?: IndeedCountry;
|
|
552
576
|
/** `relevance`, or `date` to favour recent postings; Indeed does not order the page strictly by date. */
|
|
553
577
|
sort?: IndeedJobSort;
|
|
578
|
+
/** Jobs to return, up to 25 per call. */
|
|
579
|
+
limit?: number;
|
|
580
|
+
/** `pagination.next_cursor` or `previous_cursor` of the last page; send the same search and `limit` with it. */
|
|
581
|
+
cursor?: string;
|
|
582
|
+
/** `full_time`, `part_time`, `contract`, `permanent`, `temporary`, `temp_to_hire`, `internship`, `prn` or `travel_nursing`; repeat for jobs of any of them. */
|
|
583
|
+
job_type?: IndeedJobType[];
|
|
554
584
|
/** `remote`, `hybrid`, `in_person` or `office`; repeat for jobs with any of them. */
|
|
555
585
|
work_setting?: IndeedWorkSetting[];
|
|
586
|
+
/** `entry`, `mid` or `senior`; repeat for jobs at any of them. */
|
|
587
|
+
experience_level?: IndeedExperienceLevel[];
|
|
588
|
+
/** Attribute `code` from a job (skill, benefit, licence); repeat for jobs carrying every code. */
|
|
589
|
+
attribute?: string[];
|
|
590
|
+
/** Occupation `code` from a job's `occupations`; repeat for jobs in every one. */
|
|
591
|
+
occupation?: string[];
|
|
592
|
+
/** Job types to leave out, from the `job_type` values. */
|
|
593
|
+
exclude_job_type?: IndeedJobType[];
|
|
594
|
+
/** Attribute `code` to leave out; jobs carrying any of them drop. */
|
|
595
|
+
exclude_attribute?: string[];
|
|
596
|
+
/** Company `key` whose jobs to leave out. */
|
|
597
|
+
exclude_company?: string[];
|
|
598
|
+
/** Only jobs that reached Indeed this many days ago or less. */
|
|
599
|
+
posted_within_days?: IndeedPostedWithin | null;
|
|
600
|
+
/** Minimum yearly pay in the country's currency; Indeed annualises hourly pay. */
|
|
601
|
+
min_salary?: number | null;
|
|
556
602
|
}
|
|
557
603
|
//# sourceMappingURL=types.d.ts.map
|