socialtap 1.483.27 → 1.485.28
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 +2 -2
- package/dist/commands.js +1 -1
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/dist/models.d.ts +28 -75
- package/dist/resources.d.ts +7 -101
- package/dist/resources.js +5 -100
- package/dist/tooldefs.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
SocialTap is the social media scraper API for developers and AI agents. Send a public link, a handle or a search and get live data back in one schema. Failed requests are free.
|
|
6
6
|
|
|
7
7
|
The TypeScript SDK for the SocialTap API: a method for every endpoint, typed models and errors, retries and pagination.
|
|
8
|
-
Generated from the SocialTap catalog (version 1.
|
|
8
|
+
Generated from the SocialTap catalog (version 1.485.28). Docs: https://socialtap.dev/docs.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
|
@@ -181,7 +181,7 @@ Every result also carries the envelope `meta` (request ID, source, cache status,
|
|
|
181
181
|
| `linkbio.profile` | `client.linkbio.profile.get()` | 1 credit |
|
|
182
182
|
| `linkedin.ad` | `client.linkedin.ad.get()` | 1 credit |
|
|
183
183
|
| `linkedin.post` | `client.linkedin.post.get()` | 1 credit |
|
|
184
|
-
| `linkedin.profile` | `client.linkedin.profile.get()` | 1 credit (public page) or 5 credits (data partner) |
|
|
184
|
+
| `linkedin.profile` | `client.linkedin.profile.get()` | 1 credit (public page or web search) or 5 credits (data partner) |
|
|
185
185
|
| `linkedin.search_ads` | `client.linkedin.searchAds.list()` | 1 credit |
|
|
186
186
|
| `linkedin.search_posts` | `client.linkedin.searchPosts.list()` | 1 credit + 1 per result filled in |
|
|
187
187
|
| `linkedin.search_profiles` | `client.linkedin.searchProfiles.list()` | 1 credit + 1 per result filled in |
|
package/dist/commands.js
CHANGED
|
@@ -1486,7 +1486,7 @@ export const COMMANDS = [
|
|
|
1486
1486
|
name: "profile",
|
|
1487
1487
|
endpoint: "linkedin.profile",
|
|
1488
1488
|
summary: "Company size and industry, or a member's career",
|
|
1489
|
-
price: "1 credit (public page) or 5 credits (data partner)",
|
|
1489
|
+
price: "1 credit (public page or web search) or 5 credits (data partner)",
|
|
1490
1490
|
params: [
|
|
1491
1491
|
{ name: "handle", type: "string", required: true, description: "The LinkedIn account: a Page's link (linkedin.com/company/<name>, /school/<name>, /showcase/<name>, any tab of it) or a member's (linkedin.com/in/<name>), or its name with the prefix that says which (company/google, school/mit, showcase/microsoft-security, in/williamhgates). A bare name is a company's; LinkedIn leads a company name to the school or showcase page of that name. Names are case-insensitive. At most 2048 characters. Example: https://www.linkedin.com/company/microsoft/" },
|
|
1492
1492
|
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
package/dist/constants.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** SDK version: 1.<contract facts>.<generator revision> (sdk/README.md). */
|
|
2
|
-
export declare const VERSION = "1.
|
|
2
|
+
export declare const VERSION = "1.485.28";
|
|
3
3
|
/** The production API origin. */
|
|
4
4
|
export declare const DEFAULT_BASE_URL = "https://socialtap.dev";
|
|
5
5
|
/** Environment variable the API key is read from. */
|
package/dist/constants.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Code generated by engine/cmd/gensdk (make gen) from catalog/catalog.gen.json; DO NOT EDIT.
|
|
2
2
|
/** SDK version: 1.<contract facts>.<generator revision> (sdk/README.md). */
|
|
3
|
-
export const VERSION = "1.
|
|
3
|
+
export const VERSION = "1.485.28";
|
|
4
4
|
/** The production API origin. */
|
|
5
5
|
export const DEFAULT_BASE_URL = "https://socialtap.dev";
|
|
6
6
|
/** Environment variable the API key is read from. */
|
package/dist/models.d.ts
CHANGED
|
@@ -6743,11 +6743,6 @@ export interface ResponseMeta {
|
|
|
6743
6743
|
* leaves out. [] when none.
|
|
6744
6744
|
*/
|
|
6745
6745
|
warnings: Warning[];
|
|
6746
|
-
/**
|
|
6747
|
-
* live, or test for a test key's answer: a recorded response (fixture), free and deterministic; null when
|
|
6748
|
-
* SocialTap could not tell. New values may be added. Known values: live, test.
|
|
6749
|
-
*/
|
|
6750
|
-
mode: "live" | "test" | (string & {}) | null;
|
|
6751
6746
|
}
|
|
6752
6747
|
/** The page object of list responses. */
|
|
6753
6748
|
export interface PageInfo {
|
|
@@ -6773,18 +6768,10 @@ export interface RouteMeta {
|
|
|
6773
6768
|
* prices).
|
|
6774
6769
|
*/
|
|
6775
6770
|
credits_charged: number;
|
|
6776
|
-
/**
|
|
6777
|
-
* Account balance (the test balance for a test key); null without an account (signup) or when SocialTap could
|
|
6778
|
-
* not read it.
|
|
6779
|
-
*/
|
|
6771
|
+
/** Account balance; null without an account (signup) or when SocialTap could not read it. */
|
|
6780
6772
|
credits_remaining: number | null;
|
|
6781
6773
|
/** Your x-client-request-id, echoed; null when you sent none. */
|
|
6782
6774
|
client_request_id: string | null;
|
|
6783
|
-
/**
|
|
6784
|
-
* Mode of the credential that made the request: live, or test for a test key; null without one (signup). Known
|
|
6785
|
-
* values: live, test.
|
|
6786
|
-
*/
|
|
6787
|
-
mode: "live" | "test" | (string & {}) | null;
|
|
6788
6775
|
/** Things to act on that did not fail the request. [] when none. */
|
|
6789
6776
|
warnings: Warning[];
|
|
6790
6777
|
}
|
|
@@ -6805,11 +6792,6 @@ export interface APIKey {
|
|
|
6805
6792
|
id: string;
|
|
6806
6793
|
/** Your label for the key. */
|
|
6807
6794
|
name: string;
|
|
6808
|
-
/**
|
|
6809
|
-
* live keys spend credits on real requests; test keys answer from recorded responses, free. Known values: live,
|
|
6810
|
-
* test.
|
|
6811
|
-
*/
|
|
6812
|
-
mode: "live" | "test" | (string & {});
|
|
6813
6795
|
/**
|
|
6814
6796
|
* pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET
|
|
6815
6797
|
* /v1/account). expired: past expires_at. Known values: active, pending, expired, revoked.
|
|
@@ -6836,11 +6818,11 @@ export interface APIKey {
|
|
|
6836
6818
|
/** When the key was revoked; null while it is not. Format: date-time. */
|
|
6837
6819
|
revoked_at: string | null;
|
|
6838
6820
|
/**
|
|
6839
|
-
* true for the account's built-in dashboard key
|
|
6840
|
-
*
|
|
6841
|
-
*
|
|
6842
|
-
*
|
|
6843
|
-
*
|
|
6821
|
+
* true for the account's built-in dashboard key: the dashboard's playground runs as it (so its requests are
|
|
6822
|
+
* logged, counted and billed like any key's). Nobody holds its secret, so it works only from the signed-in
|
|
6823
|
+
* dashboard. Only its spend_limit can be changed (to cap what the playground spends live); renaming, rescoping,
|
|
6824
|
+
* restricting, rotating or revoking it is forbidden (details.reason dashboard_key). It is made on first use and
|
|
6825
|
+
* revoked with the account.
|
|
6844
6826
|
*/
|
|
6845
6827
|
dashboard: boolean;
|
|
6846
6828
|
/**
|
|
@@ -6873,15 +6855,7 @@ export interface Account {
|
|
|
6873
6855
|
status: "active" | "unverified" | (string & {});
|
|
6874
6856
|
/** Plan ID. */
|
|
6875
6857
|
plan: string;
|
|
6876
|
-
/**
|
|
6877
|
-
* Mode of the credential that made this request. A test key sees the fixed test balance. Known values: live,
|
|
6878
|
-
* test.
|
|
6879
|
-
*/
|
|
6880
|
-
mode: "live" | "test" | (string & {});
|
|
6881
|
-
/**
|
|
6882
|
-
* Credits the account owns, including those held by requests in flight and unfinished jobs; for a test key, the
|
|
6883
|
-
* fixed test balance.
|
|
6884
|
-
*/
|
|
6858
|
+
/** Credits the account owns, including those held by requests in flight and unfinished jobs. */
|
|
6885
6859
|
balance: number;
|
|
6886
6860
|
/**
|
|
6887
6861
|
* Credits new requests can set aside now: balance minus what requests in flight and unfinished jobs hold. For a
|
|
@@ -6909,8 +6883,8 @@ export interface Account {
|
|
|
6909
6883
|
* Why this account got no free credits when it was confirmed; null when it got them, or isn't confirmed yet.
|
|
6910
6884
|
* disposable_address: a throwaway mail service. domain_daily_limit, network_daily_limit: too many new accounts
|
|
6911
6885
|
* today from its email domain, or from its network. mailbox_used: this mailbox already had them. A daily limit
|
|
6912
|
-
* is tried again at the next session, on a later day; the others stand. Everything else works as on any account
|
|
6913
|
-
*
|
|
6886
|
+
* is tried again at the next session, on a later day; the others stand. Everything else works as on any account,
|
|
6887
|
+
* buying credits included. New values may be added. Known values: disposable_address, domain_daily_limit,
|
|
6914
6888
|
* network_daily_limit, mailbox_used.
|
|
6915
6889
|
*/
|
|
6916
6890
|
free_credits_skipped: "disposable_address" | "domain_daily_limit" | "network_daily_limit" | "mailbox_used" | (string & {}) | null;
|
|
@@ -7006,8 +6980,7 @@ export interface UsageRateBucket {
|
|
|
7006
6980
|
ending_at: string;
|
|
7007
6981
|
/**
|
|
7008
6982
|
* Requests the ceiling counted, refused ones included: endpoint requests (Prefer: respond-async ones too) and
|
|
7009
|
-
* the gateway's own routes, from every key and the dashboard. Not counted: a job's items (the job paces them)
|
|
7010
|
-
* and test-mode endpoint requests (they have a ceiling of their own).
|
|
6983
|
+
* the gateway's own routes, from every key and the dashboard. Not counted: a job's items (the job paces them).
|
|
7011
6984
|
*/
|
|
7012
6985
|
requests: number;
|
|
7013
6986
|
/** Of requests, those refused with rate_limited (free) because the account was above its ceiling. */
|
|
@@ -7024,7 +6997,7 @@ export interface UsageRateBucket {
|
|
|
7024
6997
|
average_rps: number;
|
|
7025
6998
|
/**
|
|
7026
6999
|
* false for a bucket that ends before the account's request rate was first recorded (its first request since the
|
|
7027
|
-
* rate has been measured): no data, rather than no requests.
|
|
7000
|
+
* rate has been measured): no data, rather than no requests.
|
|
7028
7001
|
*/
|
|
7029
7002
|
recorded: boolean;
|
|
7030
7003
|
}
|
|
@@ -7303,8 +7276,6 @@ export interface RequestLogEntry {
|
|
|
7303
7276
|
endpoint: string;
|
|
7304
7277
|
/** The key that made it (key_…). */
|
|
7305
7278
|
api_key_id: string;
|
|
7306
|
-
/** live, or test (recorded answers, free). Known values: live, test. */
|
|
7307
|
-
mode: "live" | "test" | (string & {});
|
|
7308
7279
|
/**
|
|
7309
7280
|
* The query params as sent (at most 32; a value longer than 2048 characters is cut). Run the request again with
|
|
7310
7281
|
* them.
|
|
@@ -7316,7 +7287,7 @@ export interface RequestLogEntry {
|
|
|
7316
7287
|
http_status: number;
|
|
7317
7288
|
/** ok, or the error code it answered. */
|
|
7318
7289
|
outcome: string;
|
|
7319
|
-
/** Credits charged (0: failures
|
|
7290
|
+
/** Credits charged (0: failures and cache hits are free). */
|
|
7320
7291
|
credits_charged: number;
|
|
7321
7292
|
/** Time from receiving the request to answering it, in milliseconds. */
|
|
7322
7293
|
latency_ms: number;
|
|
@@ -7358,11 +7329,6 @@ export interface APIKeyCreated {
|
|
|
7358
7329
|
id: string;
|
|
7359
7330
|
/** Your label for the key. */
|
|
7360
7331
|
name: string;
|
|
7361
|
-
/**
|
|
7362
|
-
* live keys spend credits on real requests; test keys answer from recorded responses, free. Known values: live,
|
|
7363
|
-
* test.
|
|
7364
|
-
*/
|
|
7365
|
-
mode: "live" | "test" | (string & {});
|
|
7366
7332
|
/**
|
|
7367
7333
|
* pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET
|
|
7368
7334
|
* /v1/account). expired: past expires_at. Known values: active, pending, expired, revoked.
|
|
@@ -7389,11 +7355,11 @@ export interface APIKeyCreated {
|
|
|
7389
7355
|
/** When the key was revoked; null while it is not. Format: date-time. */
|
|
7390
7356
|
revoked_at: string | null;
|
|
7391
7357
|
/**
|
|
7392
|
-
* true for the account's built-in dashboard key
|
|
7393
|
-
*
|
|
7394
|
-
*
|
|
7395
|
-
*
|
|
7396
|
-
*
|
|
7358
|
+
* true for the account's built-in dashboard key: the dashboard's playground runs as it (so its requests are
|
|
7359
|
+
* logged, counted and billed like any key's). Nobody holds its secret, so it works only from the signed-in
|
|
7360
|
+
* dashboard. Only its spend_limit can be changed (to cap what the playground spends live); renaming, rescoping,
|
|
7361
|
+
* restricting, rotating or revoking it is forbidden (details.reason dashboard_key). It is made on first use and
|
|
7362
|
+
* revoked with the account.
|
|
7397
7363
|
*/
|
|
7398
7364
|
dashboard: boolean;
|
|
7399
7365
|
/**
|
|
@@ -7419,8 +7385,6 @@ export interface APIKeyRef {
|
|
|
7419
7385
|
id: string;
|
|
7420
7386
|
/** Its label. */
|
|
7421
7387
|
name: string;
|
|
7422
|
-
/** Its mode. Known values: live, test. */
|
|
7423
|
-
mode: "live" | "test" | (string & {});
|
|
7424
7388
|
/** The secret's first characters. */
|
|
7425
7389
|
prefix: string;
|
|
7426
7390
|
/** What it may call. Known values: endpoints, jobs, jobs:read, account:read, admin. */
|
|
@@ -7433,11 +7397,6 @@ export interface APIKeyRevoked {
|
|
|
7433
7397
|
id: string;
|
|
7434
7398
|
/** Your label for the key. */
|
|
7435
7399
|
name: string;
|
|
7436
|
-
/**
|
|
7437
|
-
* live keys spend credits on real requests; test keys answer from recorded responses, free. Known values: live,
|
|
7438
|
-
* test.
|
|
7439
|
-
*/
|
|
7440
|
-
mode: "live" | "test" | (string & {});
|
|
7441
7400
|
/**
|
|
7442
7401
|
* pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET
|
|
7443
7402
|
* /v1/account). expired: past expires_at. Known values: active, pending, expired, revoked.
|
|
@@ -7464,11 +7423,11 @@ export interface APIKeyRevoked {
|
|
|
7464
7423
|
/** When the key was revoked; null while it is not. Format: date-time. */
|
|
7465
7424
|
revoked_at: string | null;
|
|
7466
7425
|
/**
|
|
7467
|
-
* true for the account's built-in dashboard key
|
|
7468
|
-
*
|
|
7469
|
-
*
|
|
7470
|
-
*
|
|
7471
|
-
*
|
|
7426
|
+
* true for the account's built-in dashboard key: the dashboard's playground runs as it (so its requests are
|
|
7427
|
+
* logged, counted and billed like any key's). Nobody holds its secret, so it works only from the signed-in
|
|
7428
|
+
* dashboard. Only its spend_limit can be changed (to cap what the playground spends live); renaming, rescoping,
|
|
7429
|
+
* restricting, rotating or revoking it is forbidden (details.reason dashboard_key). It is made on first use and
|
|
7430
|
+
* revoked with the account.
|
|
7472
7431
|
*/
|
|
7473
7432
|
dashboard: boolean;
|
|
7474
7433
|
/**
|
|
@@ -7777,8 +7736,6 @@ export interface APIKeyEventData {
|
|
|
7777
7736
|
api_key_id: string;
|
|
7778
7737
|
/** Its label. */
|
|
7779
7738
|
name: string;
|
|
7780
|
-
/** Its mode. Known values: live, test. */
|
|
7781
|
-
mode: "live" | "test" | (string & {});
|
|
7782
7739
|
/** The secret's first characters, to recognize it. */
|
|
7783
7740
|
prefix: string;
|
|
7784
7741
|
}
|
|
@@ -7793,9 +7750,9 @@ export interface AccountUpdate {
|
|
|
7793
7750
|
*/
|
|
7794
7751
|
low_balance_threshold?: number | null;
|
|
7795
7752
|
/**
|
|
7796
|
-
* true keeps the answer body of every request made from now on
|
|
7797
|
-
*
|
|
7798
|
-
*
|
|
7753
|
+
* true keeps the answer body of every request made from now on up to 1 MB each (a longer one is cut), for 7
|
|
7754
|
+
* days: GET /v1/requests/{id}/response returns it. false stops keeping them; bodies already kept are deleted
|
|
7755
|
+
* when their time is up. Takes effect within a minute.
|
|
7799
7756
|
*/
|
|
7800
7757
|
keep_response_bodies?: boolean | null;
|
|
7801
7758
|
}
|
|
@@ -7879,8 +7836,6 @@ export interface RequestsQuery {
|
|
|
7879
7836
|
api_key_id?: string;
|
|
7880
7837
|
/** ok (answered with data), error (any failure), or one error code (not_found). */
|
|
7881
7838
|
outcome?: string;
|
|
7882
|
-
/** Only live or only test requests. A test key sees test requests only. Known values: live, test. */
|
|
7883
|
-
mode?: "live" | "test";
|
|
7884
7839
|
/**
|
|
7885
7840
|
* Only requests that reached the API this way: rest (an HTTP request), mcp (an MCP tool call) or job (a request
|
|
7886
7841
|
* of a job). Known values: rest, mcp, job.
|
|
@@ -7913,10 +7868,10 @@ export interface APIKeyCreate {
|
|
|
7913
7868
|
/** Your label for the key. Default: "API key". */
|
|
7914
7869
|
name?: string;
|
|
7915
7870
|
/**
|
|
7916
|
-
*
|
|
7917
|
-
*
|
|
7871
|
+
* live, the only mode: test mode was retired on 2026-11-09, so "test" is invalid_input. Every key spends
|
|
7872
|
+
* credits. Known values: live.
|
|
7918
7873
|
*/
|
|
7919
|
-
mode?: "live"
|
|
7874
|
+
mode?: "live";
|
|
7920
7875
|
/**
|
|
7921
7876
|
* Default: endpoints, jobs and account:read. Only an admin credential creates keys, and a key never gets a scope
|
|
7922
7877
|
* its creator lacks. Known values: endpoints, jobs, jobs:read, account:read, admin.
|
|
@@ -7937,8 +7892,6 @@ export interface APIKeyCreate {
|
|
|
7937
7892
|
}
|
|
7938
7893
|
/** A request's params or body (gateway routes). */
|
|
7939
7894
|
export interface APIKeysQuery {
|
|
7940
|
-
/** Only keys of this mode. A test key always sees test keys only. Known values: live, test. */
|
|
7941
|
-
mode?: "live" | "test";
|
|
7942
7895
|
/** Keys per page (default and maximum 100). */
|
|
7943
7896
|
limit?: number;
|
|
7944
7897
|
/** page.next_cursor of the previous page. */
|
package/dist/resources.d.ts
CHANGED
|
@@ -5990,7 +5990,8 @@ export declare class LinkedInProfile {
|
|
|
5990
5990
|
* member has their headline, about text, location, followers, connections, experience, education, skills,
|
|
5991
5991
|
* certifications, projects, publications, recommendations and the other sections their public profile lists.
|
|
5992
5992
|
*
|
|
5993
|
-
* Cost: 1 credit (public page) or 5 credits (data partner). Failed requests and cache hits are
|
|
5993
|
+
* Cost: 1 credit (public page or web search) or 5 credits (data partner). Failed requests and cache hits are
|
|
5994
|
+
* free.
|
|
5994
5995
|
*
|
|
5995
5996
|
* With `fields`, the items are `PartialModel<Profile>`: only the selected paths are sent, so any member may be
|
|
5996
5997
|
* absent.
|
|
@@ -13758,13 +13759,11 @@ export declare class AccountResource {
|
|
|
13758
13759
|
/**
|
|
13759
13760
|
* `account.get`: Get the account, balance and calling key.
|
|
13760
13761
|
*
|
|
13761
|
-
* The account's balance and plan, the low-balance alert threshold, and the calling key: its
|
|
13762
|
-
*
|
|
13763
|
-
*
|
|
13762
|
+
* The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit
|
|
13763
|
+
* (with what it used this interval) and expiry. Free; never cached. A pending agent key may call it (and nothing
|
|
13764
|
+
* else) to learn when its owner confirmed.
|
|
13764
13765
|
*
|
|
13765
13766
|
* Free; needs an API key with the `account:read` scope (GET /v1/account).
|
|
13766
|
-
*
|
|
13767
|
-
* Test mode: A test key sees the fixed test balance.
|
|
13768
13767
|
*/
|
|
13769
13768
|
get(options?: RequestOptions): Promise<Result<Account, EnvelopeRouteMeta>>;
|
|
13770
13769
|
/**
|
|
@@ -13776,9 +13775,6 @@ export declare class AccountResource {
|
|
|
13776
13775
|
* response (GET /v1/requests/{id}/response). Absent fields keep their value. Free.
|
|
13777
13776
|
*
|
|
13778
13777
|
* Free; needs an API key with the `admin` scope (PATCH /v1/account).
|
|
13779
|
-
*
|
|
13780
|
-
* Test mode: A test key's change is validated and answered but not stored: test mode never changes the live
|
|
13781
|
-
* account.
|
|
13782
13778
|
*/
|
|
13783
13779
|
update(body?: AccountUpdate, options?: RequestOptions): Promise<Result<Account, EnvelopeRouteMeta>>;
|
|
13784
13780
|
}
|
|
@@ -13797,8 +13793,6 @@ export declare class UsageRateResource {
|
|
|
13797
13793
|
*
|
|
13798
13794
|
* Free; needs an API key with the `account:read` scope (GET /v1/usage/rate).
|
|
13799
13795
|
*
|
|
13800
|
-
* Test mode: A test key gets an empty report: test requests are not metered.
|
|
13801
|
-
*
|
|
13802
13796
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
13803
13797
|
*/
|
|
13804
13798
|
list(params?: UsageRateQuery, options?: RequestOptions): Promise<ListResult<UsageRateBucket, EnvelopeRouteMeta>>;
|
|
@@ -13826,8 +13820,6 @@ export declare class UsageResource {
|
|
|
13826
13820
|
*
|
|
13827
13821
|
* Free; needs an API key with the `account:read` scope (GET /v1/usage).
|
|
13828
13822
|
*
|
|
13829
|
-
* Test mode: A test key gets an empty report: test requests are not metered.
|
|
13830
|
-
*
|
|
13831
13823
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
13832
13824
|
*/
|
|
13833
13825
|
list(params?: UsageQuery, options?: RequestOptions): Promise<ListResult<UsageBucket, EnvelopeRouteMeta>>;
|
|
@@ -13849,8 +13841,6 @@ export declare class CreditTransactionsResource {
|
|
|
13849
13841
|
*
|
|
13850
13842
|
* Free; needs an API key with the `account:read` scope (GET /v1/credit_transactions).
|
|
13851
13843
|
*
|
|
13852
|
-
* Test mode: A test key gets an empty report: test requests are not metered.
|
|
13853
|
-
*
|
|
13854
13844
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
13855
13845
|
*/
|
|
13856
13846
|
list(params?: CreditTransactionsQuery, options?: RequestOptions): Promise<ListResult<CreditTransaction, EnvelopeRouteMeta>>;
|
|
@@ -13872,8 +13862,6 @@ export declare class BillingCheckoutResource {
|
|
|
13872
13862
|
* open. Other accounts' sessions are not_found. Free.
|
|
13873
13863
|
*
|
|
13874
13864
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/checkout/{id}).
|
|
13875
|
-
*
|
|
13876
|
-
* Test mode: Answers a test key's placeholder session as open.
|
|
13877
13865
|
*/
|
|
13878
13866
|
get(id: string, options?: RequestOptions): Promise<Result<CheckoutSession, EnvelopeRouteMeta>>;
|
|
13879
13867
|
}
|
|
@@ -13889,8 +13877,6 @@ export declare class BillingSubscriptionResource {
|
|
|
13889
13877
|
* account is pay as you go. Free.
|
|
13890
13878
|
*
|
|
13891
13879
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/subscription).
|
|
13892
|
-
*
|
|
13893
|
-
* Test mode: A test key sees no monthly plan: test mode has no card and no billing.
|
|
13894
13880
|
*/
|
|
13895
13881
|
get(options?: RequestOptions): Promise<Result<Subscription, EnvelopeRouteMeta>>;
|
|
13896
13882
|
}
|
|
@@ -13906,8 +13892,6 @@ export declare class BillingAutoTopupResource {
|
|
|
13906
13892
|
* Free.
|
|
13907
13893
|
*
|
|
13908
13894
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/auto_topup).
|
|
13909
|
-
*
|
|
13910
|
-
* Test mode: A test key sees auto top-up off: test mode has no card and no balance to top up.
|
|
13911
13895
|
*/
|
|
13912
13896
|
get(options?: RequestOptions): Promise<Result<AutoTopup, EnvelopeRouteMeta>>;
|
|
13913
13897
|
}
|
|
@@ -13924,8 +13908,6 @@ export declare class BillingPurchasesResource {
|
|
|
13924
13908
|
*
|
|
13925
13909
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/purchases).
|
|
13926
13910
|
*
|
|
13927
|
-
* Test mode: A test key sees no purchases: test mode has no card and no billing.
|
|
13928
|
-
*
|
|
13929
13911
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
13930
13912
|
*/
|
|
13931
13913
|
list(params?: PurchasesQuery, options?: RequestOptions): Promise<ListResult<Purchase, EnvelopeRouteMeta>>;
|
|
@@ -13942,8 +13924,6 @@ export declare class BillingPurchasesResource {
|
|
|
13942
13924
|
* other accounts' purchases are not_found. Free.
|
|
13943
13925
|
*
|
|
13944
13926
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/purchases/{id}/receipt).
|
|
13945
|
-
*
|
|
13946
|
-
* Test mode: A test key has no purchases: every ID is not_found.
|
|
13947
13927
|
*/
|
|
13948
13928
|
receipt(id: string, options?: RequestOptions): Promise<Result<PurchaseReceipt, EnvelopeRouteMeta>>;
|
|
13949
13929
|
}
|
|
@@ -13968,8 +13948,8 @@ export declare class RequestsResource {
|
|
|
13968
13948
|
* `requests.list`: List requests, newest first (the request log).
|
|
13969
13949
|
*
|
|
13970
13950
|
* Every endpoint request the account made, newest first, cursor-paged: its endpoint, params, status, outcome,
|
|
13971
|
-
* credits, latency and whether the cache answered, filtered by endpoint, key, outcome,
|
|
13972
|
-
*
|
|
13951
|
+
* credits, latency and whether the cache answered, filtered by endpoint, key, outcome, surface and time, and
|
|
13952
|
+
* searched by the params' values (q: a handle, a link or an ID). Requests are kept for `log_retention_s`, at
|
|
13973
13953
|
* most `log_max_rows` per account. Responses are kept only with keep_response_bodies on (GET
|
|
13974
13954
|
* /v1/requests/{id}/response). A request appears within about 10 seconds. Requests refused before any work are
|
|
13975
13955
|
* not listed (the runaway-protection ceiling's: GET /v1/usage/rate counts them; over the failure budget or while
|
|
@@ -13977,8 +13957,6 @@ export declare class RequestsResource {
|
|
|
13977
13957
|
*
|
|
13978
13958
|
* Free; needs an API key with the `account:read` scope (GET /v1/requests).
|
|
13979
13959
|
*
|
|
13980
|
-
* Test mode: A test key sees test requests only; a live key and the dashboard see both.
|
|
13981
|
-
*
|
|
13982
13960
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
13983
13961
|
*/
|
|
13984
13962
|
list(params?: RequestsQuery, options?: RequestOptions): Promise<ListResult<RequestLogEntry, EnvelopeRouteMeta>>;
|
|
@@ -13993,8 +13971,6 @@ export declare class RequestsResource {
|
|
|
13993
13971
|
* One request of the request log by its ID (meta.request_id of its answer). Free.
|
|
13994
13972
|
*
|
|
13995
13973
|
* Free; needs an API key with the `account:read` scope (GET /v1/requests/{id}).
|
|
13996
|
-
*
|
|
13997
|
-
* Test mode: A test key sees test requests only; a live key and the dashboard see both.
|
|
13998
13974
|
*/
|
|
13999
13975
|
get(id: string, options?: RequestOptions): Promise<Result<RequestLogEntry, EnvelopeRouteMeta>>;
|
|
14000
13976
|
/**
|
|
@@ -14005,8 +13981,6 @@ export declare class RequestsResource {
|
|
|
14005
13981
|
* Free.
|
|
14006
13982
|
*
|
|
14007
13983
|
* Free; needs an API key with the `account:read` scope (GET /v1/requests/{id}/response).
|
|
14008
|
-
*
|
|
14009
|
-
* Test mode: A test key sees test requests only; a live key and the dashboard see both.
|
|
14010
13984
|
*/
|
|
14011
13985
|
getResponse(id: string, options?: RequestOptions): Promise<Result<RequestResponse, EnvelopeRouteMeta>>;
|
|
14012
13986
|
}
|
|
@@ -14025,8 +13999,6 @@ export declare class ApiKeysResource {
|
|
|
14025
13999
|
*
|
|
14026
14000
|
* Free; needs an API key with the `admin` scope (POST /v1/api_keys).
|
|
14027
14001
|
*
|
|
14028
|
-
* Test mode: A test key sees and manages test keys only.
|
|
14029
|
-
*
|
|
14030
14002
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14031
14003
|
* a retry never repeats the work.
|
|
14032
14004
|
*/
|
|
@@ -14038,8 +14010,6 @@ export declare class ApiKeysResource {
|
|
|
14038
14010
|
*
|
|
14039
14011
|
* Free; needs an API key with the `account:read` scope (GET /v1/api_keys).
|
|
14040
14012
|
*
|
|
14041
|
-
* Test mode: A test key sees and manages test keys only.
|
|
14042
|
-
*
|
|
14043
14013
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
14044
14014
|
*/
|
|
14045
14015
|
list(params?: APIKeysQuery, options?: RequestOptions): Promise<ListResult<APIKey, EnvelopeRouteMeta>>;
|
|
@@ -14054,8 +14024,6 @@ export declare class ApiKeysResource {
|
|
|
14054
14024
|
* One key and its spend this interval; never its secret. Free.
|
|
14055
14025
|
*
|
|
14056
14026
|
* Free; needs an API key with the `account:read` scope (GET /v1/api_keys/{id}).
|
|
14057
|
-
*
|
|
14058
|
-
* Test mode: A test key sees and manages test keys only.
|
|
14059
14027
|
*/
|
|
14060
14028
|
get(id: string, options?: RequestOptions): Promise<Result<APIKey, EnvelopeRouteMeta>>;
|
|
14061
14029
|
/**
|
|
@@ -14065,8 +14033,6 @@ export declare class ApiKeysResource {
|
|
|
14065
14033
|
* effect within a minute everywhere. Free.
|
|
14066
14034
|
*
|
|
14067
14035
|
* Free; needs an API key with the `admin` scope (PATCH /v1/api_keys/{id}).
|
|
14068
|
-
*
|
|
14069
|
-
* Test mode: A test key sees and manages test keys only.
|
|
14070
14036
|
*/
|
|
14071
14037
|
update(id: string, body?: APIKeyUpdate, options?: RequestOptions): Promise<Result<APIKey, EnvelopeRouteMeta>>;
|
|
14072
14038
|
/**
|
|
@@ -14082,8 +14048,6 @@ export declare class ApiKeysResource {
|
|
|
14082
14048
|
*
|
|
14083
14049
|
* Free; needs an API key with the `admin` scope (POST /v1/api_keys/{id}/rotate_secret).
|
|
14084
14050
|
*
|
|
14085
|
-
* Test mode: A test key sees and manages test keys only.
|
|
14086
|
-
*
|
|
14087
14051
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14088
14052
|
* a retry never repeats the work.
|
|
14089
14053
|
*/
|
|
@@ -14100,8 +14064,6 @@ export declare class ApiKeysResource {
|
|
|
14100
14064
|
* each with its own `api_key.revoked` event; revoking it again changes nothing. Free.
|
|
14101
14065
|
*
|
|
14102
14066
|
* Free; needs an API key with the `admin` scope (DELETE /v1/api_keys/{id}).
|
|
14103
|
-
*
|
|
14104
|
-
* Test mode: A test key sees and manages test keys only.
|
|
14105
14067
|
*/
|
|
14106
14068
|
revoke(id: string, options?: RequestOptions): Promise<Result<APIKeyRevoked, EnvelopeRouteMeta>>;
|
|
14107
14069
|
}
|
|
@@ -14120,9 +14082,6 @@ export declare class JobsResultsResource {
|
|
|
14120
14082
|
*
|
|
14121
14083
|
* Free; needs an API key with the `jobs:read` scope (GET /v1/jobs/{id}/results).
|
|
14122
14084
|
*
|
|
14123
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
14124
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
14125
|
-
*
|
|
14126
14085
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
14127
14086
|
*/
|
|
14128
14087
|
list(id: string, params?: JobResultsQuery, options?: RequestOptions): Promise<ListResult<JobResult, EnvelopeRouteMeta>>;
|
|
@@ -14152,9 +14111,6 @@ export declare class JobsResource {
|
|
|
14152
14111
|
*
|
|
14153
14112
|
* Free; needs an API key with the `jobs` scope (POST /v1/jobs).
|
|
14154
14113
|
*
|
|
14155
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
14156
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
14157
|
-
*
|
|
14158
14114
|
* It may answer 202 (accepted: the work continues) with the same body; the result's status tells.
|
|
14159
14115
|
*
|
|
14160
14116
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
@@ -14168,9 +14124,6 @@ export declare class JobsResource {
|
|
|
14168
14124
|
*
|
|
14169
14125
|
* Free; needs an API key with the `jobs:read` scope (GET /v1/jobs).
|
|
14170
14126
|
*
|
|
14171
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
14172
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
14173
|
-
*
|
|
14174
14127
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
14175
14128
|
*/
|
|
14176
14129
|
list(params?: JobsQuery, options?: RequestOptions): Promise<ListResult<Job, EnvelopeRouteMeta>>;
|
|
@@ -14185,9 +14138,6 @@ export declare class JobsResource {
|
|
|
14185
14138
|
* The job's status, per-state request counts and credits. Free: poll it, or long-poll with `wait`.
|
|
14186
14139
|
*
|
|
14187
14140
|
* Free; needs an API key with the `jobs:read` scope (GET /v1/jobs/{id}).
|
|
14188
|
-
*
|
|
14189
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
14190
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
14191
14141
|
*/
|
|
14192
14142
|
get(id: string, params?: JobGetQuery, options?: RequestOptions): Promise<Result<Job, EnvelopeRouteMeta>>;
|
|
14193
14143
|
/**
|
|
@@ -14198,9 +14148,6 @@ export declare class JobsResource {
|
|
|
14198
14148
|
*
|
|
14199
14149
|
* Free; needs an API key with the `jobs` scope (POST /v1/jobs/{id}/cancel).
|
|
14200
14150
|
*
|
|
14201
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
14202
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
14203
|
-
*
|
|
14204
14151
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14205
14152
|
* a retry never repeats the work.
|
|
14206
14153
|
*/
|
|
@@ -14230,9 +14177,6 @@ export declare class WebhookEndpointsDeliveriesResource {
|
|
|
14230
14177
|
*
|
|
14231
14178
|
* Free; needs an API key with the `account:read` scope (GET /v1/webhook_endpoints/{id}/deliveries).
|
|
14232
14179
|
*
|
|
14233
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14234
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14235
|
-
*
|
|
14236
14180
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
14237
14181
|
*/
|
|
14238
14182
|
list(id: string, params?: WebhookDeliveriesQuery, options?: RequestOptions): Promise<ListResult<WebhookDelivery, EnvelopeRouteMeta>>;
|
|
@@ -14261,9 +14205,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14261
14205
|
*
|
|
14262
14206
|
* Free; needs an API key with the `admin` scope (POST /v1/webhook_endpoints).
|
|
14263
14207
|
*
|
|
14264
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14265
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14266
|
-
*
|
|
14267
14208
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14268
14209
|
* a retry never repeats the work.
|
|
14269
14210
|
*/
|
|
@@ -14275,9 +14216,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14275
14216
|
*
|
|
14276
14217
|
* Free; needs an API key with the `account:read` scope (GET /v1/webhook_endpoints).
|
|
14277
14218
|
*
|
|
14278
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14279
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14280
|
-
*
|
|
14281
14219
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
14282
14220
|
*/
|
|
14283
14221
|
list(params?: WebhookEndpointsQuery, options?: RequestOptions): Promise<ListResult<WebhookEndpoint, EnvelopeRouteMeta>>;
|
|
@@ -14292,9 +14230,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14292
14230
|
* One webhook endpoint (never its secret). Free.
|
|
14293
14231
|
*
|
|
14294
14232
|
* Free; needs an API key with the `account:read` scope (GET /v1/webhook_endpoints/{id}).
|
|
14295
|
-
*
|
|
14296
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14297
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14298
14233
|
*/
|
|
14299
14234
|
get(id: string, options?: RequestOptions): Promise<Result<WebhookEndpoint, EnvelopeRouteMeta>>;
|
|
14300
14235
|
/**
|
|
@@ -14304,9 +14239,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14304
14239
|
* re-enables an endpoint SocialTap disabled (see `disabled_reason`). Free.
|
|
14305
14240
|
*
|
|
14306
14241
|
* Free; needs an API key with the `admin` scope (PATCH /v1/webhook_endpoints/{id}).
|
|
14307
|
-
*
|
|
14308
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14309
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14310
14242
|
*/
|
|
14311
14243
|
update(id: string, body?: UpdateWebhookEndpointRequest, options?: RequestOptions): Promise<Result<WebhookEndpoint, EnvelopeRouteMeta>>;
|
|
14312
14244
|
/**
|
|
@@ -14315,9 +14247,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14315
14247
|
* Deletes the endpoint; pending deliveries to it stop. Free.
|
|
14316
14248
|
*
|
|
14317
14249
|
* Free; needs an API key with the `admin` scope (DELETE /v1/webhook_endpoints/{id}).
|
|
14318
|
-
*
|
|
14319
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14320
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14321
14250
|
*/
|
|
14322
14251
|
delete(id: string, options?: RequestOptions): Promise<Result<Deleted, EnvelopeRouteMeta>>;
|
|
14323
14252
|
/**
|
|
@@ -14328,9 +14257,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14328
14257
|
*
|
|
14329
14258
|
* Free; needs an API key with the `admin` scope (POST /v1/webhook_endpoints/{id}/rotate_secret).
|
|
14330
14259
|
*
|
|
14331
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14332
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14333
|
-
*
|
|
14334
14260
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14335
14261
|
* a retry never repeats the work.
|
|
14336
14262
|
*/
|
|
@@ -14343,9 +14269,6 @@ export declare class WebhookEndpointsResource {
|
|
|
14343
14269
|
*
|
|
14344
14270
|
* Free; needs an API key with the `admin` scope (POST /v1/webhook_endpoints/{id}/test).
|
|
14345
14271
|
*
|
|
14346
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
14347
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
14348
|
-
*
|
|
14349
14272
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14350
14273
|
* a retry never repeats the work.
|
|
14351
14274
|
*/
|
|
@@ -14363,10 +14286,6 @@ export declare class EventsResource {
|
|
|
14363
14286
|
*
|
|
14364
14287
|
* Free; needs an API key with the `account:read` scope (GET /v1/events).
|
|
14365
14288
|
*
|
|
14366
|
-
* Test mode: A test key sees only test keys' events: job.*, api_key.created, api_key.revoked,
|
|
14367
|
-
* api_key.secret_rotated and webhook.test. credits.*, auto_topup.*, plan.* and api_key.spend_limit_reached are
|
|
14368
|
-
* live only.
|
|
14369
|
-
*
|
|
14370
14289
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
14371
14290
|
*/
|
|
14372
14291
|
list(params?: EventsQuery, options?: RequestOptions): Promise<ListResult<Event, EnvelopeRouteMeta>>;
|
|
@@ -14381,10 +14300,6 @@ export declare class EventsResource {
|
|
|
14381
14300
|
* One event, as webhooks deliver it. Free.
|
|
14382
14301
|
*
|
|
14383
14302
|
* Free; needs an API key with the `account:read` scope (GET /v1/events/{id}).
|
|
14384
|
-
*
|
|
14385
|
-
* Test mode: A test key sees only test keys' events: job.*, api_key.created, api_key.revoked,
|
|
14386
|
-
* api_key.secret_rotated and webhook.test. credits.*, auto_topup.*, plan.* and api_key.spend_limit_reached are
|
|
14387
|
-
* live only.
|
|
14388
14303
|
*/
|
|
14389
14304
|
get(id: string, options?: RequestOptions): Promise<Result<Event, EnvelopeRouteMeta>>;
|
|
14390
14305
|
/**
|
|
@@ -14395,10 +14310,6 @@ export declare class EventsResource {
|
|
|
14395
14310
|
*
|
|
14396
14311
|
* Free; needs an API key with the `admin` scope (POST /v1/events/{id}/redeliver).
|
|
14397
14312
|
*
|
|
14398
|
-
* Test mode: A test key sees only test keys' events: job.*, api_key.created, api_key.revoked,
|
|
14399
|
-
* api_key.secret_rotated and webhook.test. credits.*, auto_topup.*, plan.* and api_key.spend_limit_reached are
|
|
14400
|
-
* live only.
|
|
14401
|
-
*
|
|
14402
14313
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
14403
14314
|
* a retry never repeats the work.
|
|
14404
14315
|
*
|
|
@@ -14416,8 +14327,6 @@ export declare class NotificationPreferencesResource {
|
|
|
14416
14327
|
* Per category: email and dashboard on or off (default on). Security mail is always sent. Free.
|
|
14417
14328
|
*
|
|
14418
14329
|
* Free; needs an API key with the `account:read` scope (GET /v1/notification_preferences).
|
|
14419
|
-
*
|
|
14420
|
-
* Test mode: A test key sees the account's preferences (one set, for live and test).
|
|
14421
14330
|
*/
|
|
14422
14331
|
get(options?: RequestOptions): Promise<Result<NotificationPreferences, EnvelopeRouteMeta>>;
|
|
14423
14332
|
/**
|
|
@@ -14428,9 +14337,6 @@ export declare class NotificationPreferencesResource {
|
|
|
14428
14337
|
* Free.
|
|
14429
14338
|
*
|
|
14430
14339
|
* Free; needs an API key with the `admin` scope (PATCH /v1/notification_preferences).
|
|
14431
|
-
*
|
|
14432
|
-
* Test mode: A test key's change is validated and answered but not stored: test mode never changes the live
|
|
14433
|
-
* account.
|
|
14434
14340
|
*/
|
|
14435
14341
|
update(body: NotificationPreferencesUpdate, options?: RequestOptions): Promise<Result<NotificationPreferences, EnvelopeRouteMeta>>;
|
|
14436
14342
|
}
|
package/dist/resources.js
CHANGED
|
@@ -3227,13 +3227,11 @@ export class AccountResource {
|
|
|
3227
3227
|
/**
|
|
3228
3228
|
* `account.get`: Get the account, balance and calling key.
|
|
3229
3229
|
*
|
|
3230
|
-
* The account's balance and plan, the low-balance alert threshold, and the calling key: its
|
|
3231
|
-
*
|
|
3232
|
-
*
|
|
3230
|
+
* The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit
|
|
3231
|
+
* (with what it used this interval) and expiry. Free; never cached. A pending agent key may call it (and nothing
|
|
3232
|
+
* else) to learn when its owner confirmed.
|
|
3233
3233
|
*
|
|
3234
3234
|
* Free; needs an API key with the `account:read` scope (GET /v1/account).
|
|
3235
|
-
*
|
|
3236
|
-
* Test mode: A test key sees the fixed test balance.
|
|
3237
3235
|
*/
|
|
3238
3236
|
get(options) {
|
|
3239
3237
|
return this.#core._call("GET", "/v1/account", {}, undefined, options, false);
|
|
@@ -3247,9 +3245,6 @@ export class AccountResource {
|
|
|
3247
3245
|
* response (GET /v1/requests/{id}/response). Absent fields keep their value. Free.
|
|
3248
3246
|
*
|
|
3249
3247
|
* Free; needs an API key with the `admin` scope (PATCH /v1/account).
|
|
3250
|
-
*
|
|
3251
|
-
* Test mode: A test key's change is validated and answered but not stored: test mode never changes the live
|
|
3252
|
-
* account.
|
|
3253
3248
|
*/
|
|
3254
3249
|
update(body = {}, options) {
|
|
3255
3250
|
return this.#core._call("PATCH", "/v1/account", {}, body, options, false);
|
|
@@ -3272,8 +3267,6 @@ export class UsageRateResource {
|
|
|
3272
3267
|
*
|
|
3273
3268
|
* Free; needs an API key with the `account:read` scope (GET /v1/usage/rate).
|
|
3274
3269
|
*
|
|
3275
|
-
* Test mode: A test key gets an empty report: test requests are not metered.
|
|
3276
|
-
*
|
|
3277
3270
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3278
3271
|
*/
|
|
3279
3272
|
list(params = {}, options) {
|
|
@@ -3308,8 +3301,6 @@ export class UsageResource {
|
|
|
3308
3301
|
*
|
|
3309
3302
|
* Free; needs an API key with the `account:read` scope (GET /v1/usage).
|
|
3310
3303
|
*
|
|
3311
|
-
* Test mode: A test key gets an empty report: test requests are not metered.
|
|
3312
|
-
*
|
|
3313
3304
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3314
3305
|
*/
|
|
3315
3306
|
list(params = {}, options) {
|
|
@@ -3337,8 +3328,6 @@ export class CreditTransactionsResource {
|
|
|
3337
3328
|
*
|
|
3338
3329
|
* Free; needs an API key with the `account:read` scope (GET /v1/credit_transactions).
|
|
3339
3330
|
*
|
|
3340
|
-
* Test mode: A test key gets an empty report: test requests are not metered.
|
|
3341
|
-
*
|
|
3342
3331
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3343
3332
|
*/
|
|
3344
3333
|
list(params = {}, options) {
|
|
@@ -3366,8 +3355,6 @@ export class BillingCheckoutResource {
|
|
|
3366
3355
|
* open. Other accounts' sessions are not_found. Free.
|
|
3367
3356
|
*
|
|
3368
3357
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/checkout/{id}).
|
|
3369
|
-
*
|
|
3370
|
-
* Test mode: Answers a test key's placeholder session as open.
|
|
3371
3358
|
*/
|
|
3372
3359
|
get(id, options) {
|
|
3373
3360
|
return this.#core._call("GET", `/v1/billing/checkout/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -3387,8 +3374,6 @@ export class BillingSubscriptionResource {
|
|
|
3387
3374
|
* account is pay as you go. Free.
|
|
3388
3375
|
*
|
|
3389
3376
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/subscription).
|
|
3390
|
-
*
|
|
3391
|
-
* Test mode: A test key sees no monthly plan: test mode has no card and no billing.
|
|
3392
3377
|
*/
|
|
3393
3378
|
get(options) {
|
|
3394
3379
|
return this.#core._call("GET", "/v1/billing/subscription", {}, undefined, options, false);
|
|
@@ -3408,8 +3393,6 @@ export class BillingAutoTopupResource {
|
|
|
3408
3393
|
* Free.
|
|
3409
3394
|
*
|
|
3410
3395
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/auto_topup).
|
|
3411
|
-
*
|
|
3412
|
-
* Test mode: A test key sees auto top-up off: test mode has no card and no balance to top up.
|
|
3413
3396
|
*/
|
|
3414
3397
|
get(options) {
|
|
3415
3398
|
return this.#core._call("GET", "/v1/billing/auto_topup", {}, undefined, options, false);
|
|
@@ -3430,8 +3413,6 @@ export class BillingPurchasesResource {
|
|
|
3430
3413
|
*
|
|
3431
3414
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/purchases).
|
|
3432
3415
|
*
|
|
3433
|
-
* Test mode: A test key sees no purchases: test mode has no card and no billing.
|
|
3434
|
-
*
|
|
3435
3416
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3436
3417
|
*/
|
|
3437
3418
|
list(params = {}, options) {
|
|
@@ -3452,8 +3433,6 @@ export class BillingPurchasesResource {
|
|
|
3452
3433
|
* other accounts' purchases are not_found. Free.
|
|
3453
3434
|
*
|
|
3454
3435
|
* Free; needs an API key with the `account:read` scope (GET /v1/billing/purchases/{id}/receipt).
|
|
3455
|
-
*
|
|
3456
|
-
* Test mode: A test key has no purchases: every ID is not_found.
|
|
3457
3436
|
*/
|
|
3458
3437
|
receipt(id, options) {
|
|
3459
3438
|
return this.#core._call("GET", `/v1/billing/purchases/${encodeURIComponent(id)}/receipt`, {}, undefined, options, false);
|
|
@@ -3488,8 +3467,8 @@ export class RequestsResource {
|
|
|
3488
3467
|
* `requests.list`: List requests, newest first (the request log).
|
|
3489
3468
|
*
|
|
3490
3469
|
* Every endpoint request the account made, newest first, cursor-paged: its endpoint, params, status, outcome,
|
|
3491
|
-
* credits, latency and whether the cache answered, filtered by endpoint, key, outcome,
|
|
3492
|
-
*
|
|
3470
|
+
* credits, latency and whether the cache answered, filtered by endpoint, key, outcome, surface and time, and
|
|
3471
|
+
* searched by the params' values (q: a handle, a link or an ID). Requests are kept for `log_retention_s`, at
|
|
3493
3472
|
* most `log_max_rows` per account. Responses are kept only with keep_response_bodies on (GET
|
|
3494
3473
|
* /v1/requests/{id}/response). A request appears within about 10 seconds. Requests refused before any work are
|
|
3495
3474
|
* not listed (the runaway-protection ceiling's: GET /v1/usage/rate counts them; over the failure budget or while
|
|
@@ -3497,8 +3476,6 @@ export class RequestsResource {
|
|
|
3497
3476
|
*
|
|
3498
3477
|
* Free; needs an API key with the `account:read` scope (GET /v1/requests).
|
|
3499
3478
|
*
|
|
3500
|
-
* Test mode: A test key sees test requests only; a live key and the dashboard see both.
|
|
3501
|
-
*
|
|
3502
3479
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3503
3480
|
*/
|
|
3504
3481
|
list(params = {}, options) {
|
|
@@ -3517,8 +3494,6 @@ export class RequestsResource {
|
|
|
3517
3494
|
* One request of the request log by its ID (meta.request_id of its answer). Free.
|
|
3518
3495
|
*
|
|
3519
3496
|
* Free; needs an API key with the `account:read` scope (GET /v1/requests/{id}).
|
|
3520
|
-
*
|
|
3521
|
-
* Test mode: A test key sees test requests only; a live key and the dashboard see both.
|
|
3522
3497
|
*/
|
|
3523
3498
|
get(id, options) {
|
|
3524
3499
|
return this.#core._call("GET", `/v1/requests/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -3531,8 +3506,6 @@ export class RequestsResource {
|
|
|
3531
3506
|
* Free.
|
|
3532
3507
|
*
|
|
3533
3508
|
* Free; needs an API key with the `account:read` scope (GET /v1/requests/{id}/response).
|
|
3534
|
-
*
|
|
3535
|
-
* Test mode: A test key sees test requests only; a live key and the dashboard see both.
|
|
3536
3509
|
*/
|
|
3537
3510
|
getResponse(id, options) {
|
|
3538
3511
|
return this.#core._call("GET", `/v1/requests/${encodeURIComponent(id)}/response`, {}, undefined, options, false);
|
|
@@ -3555,8 +3528,6 @@ export class ApiKeysResource {
|
|
|
3555
3528
|
*
|
|
3556
3529
|
* Free; needs an API key with the `admin` scope (POST /v1/api_keys).
|
|
3557
3530
|
*
|
|
3558
|
-
* Test mode: A test key sees and manages test keys only.
|
|
3559
|
-
*
|
|
3560
3531
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
3561
3532
|
* a retry never repeats the work.
|
|
3562
3533
|
*/
|
|
@@ -3570,8 +3541,6 @@ export class ApiKeysResource {
|
|
|
3570
3541
|
*
|
|
3571
3542
|
* Free; needs an API key with the `account:read` scope (GET /v1/api_keys).
|
|
3572
3543
|
*
|
|
3573
|
-
* Test mode: A test key sees and manages test keys only.
|
|
3574
|
-
*
|
|
3575
3544
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3576
3545
|
*/
|
|
3577
3546
|
list(params = {}, options) {
|
|
@@ -3590,8 +3559,6 @@ export class ApiKeysResource {
|
|
|
3590
3559
|
* One key and its spend this interval; never its secret. Free.
|
|
3591
3560
|
*
|
|
3592
3561
|
* Free; needs an API key with the `account:read` scope (GET /v1/api_keys/{id}).
|
|
3593
|
-
*
|
|
3594
|
-
* Test mode: A test key sees and manages test keys only.
|
|
3595
3562
|
*/
|
|
3596
3563
|
get(id, options) {
|
|
3597
3564
|
return this.#core._call("GET", `/v1/api_keys/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -3603,8 +3570,6 @@ export class ApiKeysResource {
|
|
|
3603
3570
|
* effect within a minute everywhere. Free.
|
|
3604
3571
|
*
|
|
3605
3572
|
* Free; needs an API key with the `admin` scope (PATCH /v1/api_keys/{id}).
|
|
3606
|
-
*
|
|
3607
|
-
* Test mode: A test key sees and manages test keys only.
|
|
3608
3573
|
*/
|
|
3609
3574
|
update(id, body = {}, options) {
|
|
3610
3575
|
return this.#core._call("PATCH", `/v1/api_keys/${encodeURIComponent(id)}`, {}, body, options, false);
|
|
@@ -3622,8 +3587,6 @@ export class ApiKeysResource {
|
|
|
3622
3587
|
*
|
|
3623
3588
|
* Free; needs an API key with the `admin` scope (POST /v1/api_keys/{id}/rotate_secret).
|
|
3624
3589
|
*
|
|
3625
|
-
* Test mode: A test key sees and manages test keys only.
|
|
3626
|
-
*
|
|
3627
3590
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
3628
3591
|
* a retry never repeats the work.
|
|
3629
3592
|
*/
|
|
@@ -3642,8 +3605,6 @@ export class ApiKeysResource {
|
|
|
3642
3605
|
* each with its own `api_key.revoked` event; revoking it again changes nothing. Free.
|
|
3643
3606
|
*
|
|
3644
3607
|
* Free; needs an API key with the `admin` scope (DELETE /v1/api_keys/{id}).
|
|
3645
|
-
*
|
|
3646
|
-
* Test mode: A test key sees and manages test keys only.
|
|
3647
3608
|
*/
|
|
3648
3609
|
revoke(id, options) {
|
|
3649
3610
|
return this.#core._call("DELETE", `/v1/api_keys/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -3666,9 +3627,6 @@ export class JobsResultsResource {
|
|
|
3666
3627
|
*
|
|
3667
3628
|
* Free; needs an API key with the `jobs:read` scope (GET /v1/jobs/{id}/results).
|
|
3668
3629
|
*
|
|
3669
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
3670
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
3671
|
-
*
|
|
3672
3630
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3673
3631
|
*/
|
|
3674
3632
|
list(id, params = {}, options) {
|
|
@@ -3705,9 +3663,6 @@ export class JobsResource {
|
|
|
3705
3663
|
*
|
|
3706
3664
|
* Free; needs an API key with the `jobs` scope (POST /v1/jobs).
|
|
3707
3665
|
*
|
|
3708
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
3709
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
3710
|
-
*
|
|
3711
3666
|
* It may answer 202 (accepted: the work continues) with the same body; the result's status tells.
|
|
3712
3667
|
*
|
|
3713
3668
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
@@ -3723,9 +3678,6 @@ export class JobsResource {
|
|
|
3723
3678
|
*
|
|
3724
3679
|
* Free; needs an API key with the `jobs:read` scope (GET /v1/jobs).
|
|
3725
3680
|
*
|
|
3726
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
3727
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
3728
|
-
*
|
|
3729
3681
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3730
3682
|
*/
|
|
3731
3683
|
list(params = {}, options) {
|
|
@@ -3744,9 +3696,6 @@ export class JobsResource {
|
|
|
3744
3696
|
* The job's status, per-state request counts and credits. Free: poll it, or long-poll with `wait`.
|
|
3745
3697
|
*
|
|
3746
3698
|
* Free; needs an API key with the `jobs:read` scope (GET /v1/jobs/{id}).
|
|
3747
|
-
*
|
|
3748
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
3749
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
3750
3699
|
*/
|
|
3751
3700
|
get(id, params = {}, options) {
|
|
3752
3701
|
return this.#core._call("GET", `/v1/jobs/${encodeURIComponent(id)}`, { ...params }, undefined, options, false);
|
|
@@ -3759,9 +3708,6 @@ export class JobsResource {
|
|
|
3759
3708
|
*
|
|
3760
3709
|
* Free; needs an API key with the `jobs` scope (POST /v1/jobs/{id}/cancel).
|
|
3761
3710
|
*
|
|
3762
|
-
* Test mode: A test key's job runs every item in test mode: each gets its endpoint's test-mode answer (recorded
|
|
3763
|
-
* responses, magic inputs), free; nothing is held or charged. A test key sees test jobs only.
|
|
3764
|
-
*
|
|
3765
3711
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
3766
3712
|
* a retry never repeats the work.
|
|
3767
3713
|
*/
|
|
@@ -3823,9 +3769,6 @@ export class WebhookEndpointsDeliveriesResource {
|
|
|
3823
3769
|
*
|
|
3824
3770
|
* Free; needs an API key with the `account:read` scope (GET /v1/webhook_endpoints/{id}/deliveries).
|
|
3825
3771
|
*
|
|
3826
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3827
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3828
|
-
*
|
|
3829
3772
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3830
3773
|
*/
|
|
3831
3774
|
list(id, params = {}, options) {
|
|
@@ -3861,9 +3804,6 @@ export class WebhookEndpointsResource {
|
|
|
3861
3804
|
*
|
|
3862
3805
|
* Free; needs an API key with the `admin` scope (POST /v1/webhook_endpoints).
|
|
3863
3806
|
*
|
|
3864
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3865
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3866
|
-
*
|
|
3867
3807
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
3868
3808
|
* a retry never repeats the work.
|
|
3869
3809
|
*/
|
|
@@ -3877,9 +3817,6 @@ export class WebhookEndpointsResource {
|
|
|
3877
3817
|
*
|
|
3878
3818
|
* Free; needs an API key with the `account:read` scope (GET /v1/webhook_endpoints).
|
|
3879
3819
|
*
|
|
3880
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3881
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3882
|
-
*
|
|
3883
3820
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3884
3821
|
*/
|
|
3885
3822
|
list(params = {}, options) {
|
|
@@ -3898,9 +3835,6 @@ export class WebhookEndpointsResource {
|
|
|
3898
3835
|
* One webhook endpoint (never its secret). Free.
|
|
3899
3836
|
*
|
|
3900
3837
|
* Free; needs an API key with the `account:read` scope (GET /v1/webhook_endpoints/{id}).
|
|
3901
|
-
*
|
|
3902
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3903
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3904
3838
|
*/
|
|
3905
3839
|
get(id, options) {
|
|
3906
3840
|
return this.#core._call("GET", `/v1/webhook_endpoints/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -3912,9 +3846,6 @@ export class WebhookEndpointsResource {
|
|
|
3912
3846
|
* re-enables an endpoint SocialTap disabled (see `disabled_reason`). Free.
|
|
3913
3847
|
*
|
|
3914
3848
|
* Free; needs an API key with the `admin` scope (PATCH /v1/webhook_endpoints/{id}).
|
|
3915
|
-
*
|
|
3916
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3917
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3918
3849
|
*/
|
|
3919
3850
|
update(id, body = {}, options) {
|
|
3920
3851
|
return this.#core._call("PATCH", `/v1/webhook_endpoints/${encodeURIComponent(id)}`, {}, body, options, false);
|
|
@@ -3925,9 +3856,6 @@ export class WebhookEndpointsResource {
|
|
|
3925
3856
|
* Deletes the endpoint; pending deliveries to it stop. Free.
|
|
3926
3857
|
*
|
|
3927
3858
|
* Free; needs an API key with the `admin` scope (DELETE /v1/webhook_endpoints/{id}).
|
|
3928
|
-
*
|
|
3929
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3930
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3931
3859
|
*/
|
|
3932
3860
|
delete(id, options) {
|
|
3933
3861
|
return this.#core._call("DELETE", `/v1/webhook_endpoints/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -3940,9 +3868,6 @@ export class WebhookEndpointsResource {
|
|
|
3940
3868
|
*
|
|
3941
3869
|
* Free; needs an API key with the `admin` scope (POST /v1/webhook_endpoints/{id}/rotate_secret).
|
|
3942
3870
|
*
|
|
3943
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3944
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3945
|
-
*
|
|
3946
3871
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
3947
3872
|
* a retry never repeats the work.
|
|
3948
3873
|
*/
|
|
@@ -3957,9 +3882,6 @@ export class WebhookEndpointsResource {
|
|
|
3957
3882
|
*
|
|
3958
3883
|
* Free; needs an API key with the `admin` scope (POST /v1/webhook_endpoints/{id}/test).
|
|
3959
3884
|
*
|
|
3960
|
-
* Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive only
|
|
3961
|
-
* test keys' events (GET /v1/events says which), signed and retried like live ones.
|
|
3962
|
-
*
|
|
3963
3885
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
3964
3886
|
* a retry never repeats the work.
|
|
3965
3887
|
*/
|
|
@@ -3981,10 +3903,6 @@ export class EventsResource {
|
|
|
3981
3903
|
*
|
|
3982
3904
|
* Free; needs an API key with the `account:read` scope (GET /v1/events).
|
|
3983
3905
|
*
|
|
3984
|
-
* Test mode: A test key sees only test keys' events: job.*, api_key.created, api_key.revoked,
|
|
3985
|
-
* api_key.secret_rotated and webhook.test. credits.*, auto_topup.*, plan.* and api_key.spend_limit_reached are
|
|
3986
|
-
* live only.
|
|
3987
|
-
*
|
|
3988
3906
|
* One page; `page.next_cursor` continues the list (or use iterate).
|
|
3989
3907
|
*/
|
|
3990
3908
|
list(params = {}, options) {
|
|
@@ -4003,10 +3921,6 @@ export class EventsResource {
|
|
|
4003
3921
|
* One event, as webhooks deliver it. Free.
|
|
4004
3922
|
*
|
|
4005
3923
|
* Free; needs an API key with the `account:read` scope (GET /v1/events/{id}).
|
|
4006
|
-
*
|
|
4007
|
-
* Test mode: A test key sees only test keys' events: job.*, api_key.created, api_key.revoked,
|
|
4008
|
-
* api_key.secret_rotated and webhook.test. credits.*, auto_topup.*, plan.* and api_key.spend_limit_reached are
|
|
4009
|
-
* live only.
|
|
4010
3924
|
*/
|
|
4011
3925
|
get(id, options) {
|
|
4012
3926
|
return this.#core._call("GET", `/v1/events/${encodeURIComponent(id)}`, {}, undefined, options, false);
|
|
@@ -4019,10 +3933,6 @@ export class EventsResource {
|
|
|
4019
3933
|
*
|
|
4020
3934
|
* Free; needs an API key with the `admin` scope (POST /v1/events/{id}/redeliver).
|
|
4021
3935
|
*
|
|
4022
|
-
* Test mode: A test key sees only test keys' events: job.*, api_key.created, api_key.revoked,
|
|
4023
|
-
* api_key.secret_rotated and webhook.test. credits.*, auto_topup.*, plan.* and api_key.spend_limit_reached are
|
|
4024
|
-
* live only.
|
|
4025
|
-
*
|
|
4026
3936
|
* Sends an Idempotency-Key (yours, or a new UUID reused by this call's retries), so it is retried like a GET and
|
|
4027
3937
|
* a retry never repeats the work.
|
|
4028
3938
|
*
|
|
@@ -4044,8 +3954,6 @@ export class NotificationPreferencesResource {
|
|
|
4044
3954
|
* Per category: email and dashboard on or off (default on). Security mail is always sent. Free.
|
|
4045
3955
|
*
|
|
4046
3956
|
* Free; needs an API key with the `account:read` scope (GET /v1/notification_preferences).
|
|
4047
|
-
*
|
|
4048
|
-
* Test mode: A test key sees the account's preferences (one set, for live and test).
|
|
4049
3957
|
*/
|
|
4050
3958
|
get(options) {
|
|
4051
3959
|
return this.#core._call("GET", "/v1/notification_preferences", {}, undefined, options, false);
|
|
@@ -4058,9 +3966,6 @@ export class NotificationPreferencesResource {
|
|
|
4058
3966
|
* Free.
|
|
4059
3967
|
*
|
|
4060
3968
|
* Free; needs an API key with the `admin` scope (PATCH /v1/notification_preferences).
|
|
4061
|
-
*
|
|
4062
|
-
* Test mode: A test key's change is validated and answered but not stored: test mode never changes the live
|
|
4063
|
-
* account.
|
|
4064
3969
|
*/
|
|
4065
3970
|
update(body, options) {
|
|
4066
3971
|
return this.#core._call("PATCH", "/v1/notification_preferences", {}, body, options, false);
|
package/dist/tooldefs.js
CHANGED
|
@@ -240,7 +240,7 @@ export const TOOLS = [
|
|
|
240
240
|
{
|
|
241
241
|
name: "get_profile",
|
|
242
242
|
title: "Profile by handle",
|
|
243
|
-
description: "Public accounts (creators, channels, pages, companies, communities) with their bio, links, and follower and post counts. Pass handle: a profile link, @handle, username or ID. Price per successful call: Apple Music, Bluesky, Facebook, Google, Instagram, Komi, Kwai, Lnk.Bio, Linkme, Linktree, Pillar, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X, YouTube: 1 credit. LinkedIn: 1 credit (public page) or 5 credits (data partner).",
|
|
243
|
+
description: "Public accounts (creators, channels, pages, companies, communities) with their bio, links, and follower and post counts. Pass handle: a profile link, @handle, username or ID. Price per successful call: Apple Music, Bluesky, Facebook, Google, Instagram, Komi, Kwai, Lnk.Bio, Linkme, Linktree, Pillar, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X, YouTube: 1 credit. LinkedIn: 1 credit (public page or web search) or 5 credits (data partner).",
|
|
244
244
|
inputSchema: {
|
|
245
245
|
"type": "object",
|
|
246
246
|
"properties": {
|
|
@@ -949,7 +949,7 @@ export const TOOLS = [
|
|
|
949
949
|
{
|
|
950
950
|
name: "get_account",
|
|
951
951
|
title: "Get account balance",
|
|
952
|
-
description: "Get the account, balance and calling key. The account's balance and plan, the low-balance alert threshold, and the calling key: its
|
|
952
|
+
description: "Get the account, balance and calling key. The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit (with what it used this interval) and expiry. Free; never cached. A pending agent key may call it (and nothing else) to learn when its owner confirmed. Use it to check the credit balance before a large task; every other result already states credits_remaining.",
|
|
953
953
|
inputSchema: {
|
|
954
954
|
"type": "object",
|
|
955
955
|
"properties": {},
|