agental-sdk 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +5 -1
- package/dist/client.js +2 -0
- package/dist/openapi.d.ts +563 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -27,6 +27,10 @@ export interface SandboxFilter {
|
|
|
27
27
|
memoryKept?: boolean;
|
|
28
28
|
/** open, blocked or allowlist. */
|
|
29
29
|
outbound?: string | readonly string[];
|
|
30
|
+
/** What they are doing: low-cpu, disk-full, memory-full or not-read. Any of them. */
|
|
31
|
+
activity?: string | readonly string[];
|
|
32
|
+
/** None of these. */
|
|
33
|
+
notActivity?: string | readonly string[];
|
|
30
34
|
/** Each key at this value; "*" for any value, the key being set. */
|
|
31
35
|
metadata?: Record<string, string>;
|
|
32
36
|
/** No key at this value; "*" for the key not being set. */
|
|
@@ -35,7 +39,7 @@ export interface SandboxFilter {
|
|
|
35
39
|
text?: string;
|
|
36
40
|
}
|
|
37
41
|
/** How a page of sandboxes is sorted. Only created and -created keep a walk through the pages exact while sandboxes change. */
|
|
38
|
-
export type SandboxSort = "created" | "-created" | "name" | "-name" | "status" | "-status" | "stopped" | "-stopped" | "cost" | "-cost";
|
|
42
|
+
export type SandboxSort = "created" | "-created" | "name" | "-name" | "status" | "-status" | "stopped" | "-stopped" | "cost" | "-cost" | "-cpu" | "-memory" | "-disk";
|
|
39
43
|
/** A page of sandboxes, and what to pass as cursor for the next one: null when this is the last. */
|
|
40
44
|
export interface SandboxPage {
|
|
41
45
|
sandboxes: Sandbox[];
|
package/dist/client.js
CHANGED
|
@@ -18,6 +18,8 @@ function filterQuery(filter) {
|
|
|
18
18
|
many("templateId", filter.templateId);
|
|
19
19
|
many("createdBy", filter.createdBy);
|
|
20
20
|
many("outbound", filter.outbound);
|
|
21
|
+
many("activity", filter.activity);
|
|
22
|
+
many("notActivity", filter.notActivity);
|
|
21
23
|
many("createdAfter", time(filter.createdAfter));
|
|
22
24
|
many("createdBefore", time(filter.createdBefore));
|
|
23
25
|
many("stoppedBefore", time(filter.stoppedBefore));
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2746,6 +2746,93 @@ export interface paths {
|
|
|
2746
2746
|
patch?: never;
|
|
2747
2747
|
trace?: never;
|
|
2748
2748
|
};
|
|
2749
|
+
"/v1/egress": {
|
|
2750
|
+
parameters: {
|
|
2751
|
+
query?: never;
|
|
2752
|
+
header?: never;
|
|
2753
|
+
path?: never;
|
|
2754
|
+
cookie?: never;
|
|
2755
|
+
};
|
|
2756
|
+
/** @description Where the account stands for residential egress: whether it may send a sandbox's web traffic out through a residential address, what it still needs before it may, what that traffic has cost this month against its budget, and whether it is refused now. */
|
|
2757
|
+
get: operations["getEgress"];
|
|
2758
|
+
put?: never;
|
|
2759
|
+
post?: never;
|
|
2760
|
+
delete?: never;
|
|
2761
|
+
options?: never;
|
|
2762
|
+
head?: never;
|
|
2763
|
+
patch?: never;
|
|
2764
|
+
trace?: never;
|
|
2765
|
+
};
|
|
2766
|
+
"/v1/egress/business": {
|
|
2767
|
+
parameters: {
|
|
2768
|
+
query?: never;
|
|
2769
|
+
header?: never;
|
|
2770
|
+
path?: never;
|
|
2771
|
+
cookie?: never;
|
|
2772
|
+
};
|
|
2773
|
+
get?: never;
|
|
2774
|
+
/** @description Tells us the account's company, website and what its sandboxes will use residential addresses for, in place of what it said before. It is kept on the account, and we may refuse residential egress on it. With a plan of Fleet or larger and a card saved, the account may then turn it on for its sandboxes. */
|
|
2775
|
+
put: operations["setEgressBusiness"];
|
|
2776
|
+
post?: never;
|
|
2777
|
+
delete?: never;
|
|
2778
|
+
options?: never;
|
|
2779
|
+
head?: never;
|
|
2780
|
+
patch?: never;
|
|
2781
|
+
trace?: never;
|
|
2782
|
+
};
|
|
2783
|
+
"/v1/egress/budget": {
|
|
2784
|
+
parameters: {
|
|
2785
|
+
query?: never;
|
|
2786
|
+
header?: never;
|
|
2787
|
+
path?: never;
|
|
2788
|
+
cookie?: never;
|
|
2789
|
+
};
|
|
2790
|
+
get?: never;
|
|
2791
|
+
/** @description Sets the most the account's residential traffic costs in a month. Past it, its residential connections are refused, within a minute, until the month ends or the budget is raised. */
|
|
2792
|
+
put: operations["setEgressBudget"];
|
|
2793
|
+
post?: never;
|
|
2794
|
+
delete?: never;
|
|
2795
|
+
options?: never;
|
|
2796
|
+
head?: never;
|
|
2797
|
+
patch?: never;
|
|
2798
|
+
trace?: never;
|
|
2799
|
+
};
|
|
2800
|
+
"/v1/sandboxes/{id}/egress": {
|
|
2801
|
+
parameters: {
|
|
2802
|
+
query?: never;
|
|
2803
|
+
header?: never;
|
|
2804
|
+
path?: never;
|
|
2805
|
+
cookie?: never;
|
|
2806
|
+
};
|
|
2807
|
+
/** @description Where the sandbox's web traffic leaves: from its server, or through a residential address in a country. GET /v1/egress says whether the account's residential traffic is refused now. */
|
|
2808
|
+
get: operations["getSandboxEgress"];
|
|
2809
|
+
/** @description Sets where the sandbox's web traffic leaves, running or stopped, without a restart: new connections take it within seconds of the answer, and connections already open are not moved. residential: its TCP to ports 80 and 443 leaves through a residential address in country, at $3 a GB both directions, from the account's credits, and its UDP to port 443 is refused so HTTP/3 falls back to TCP; box: from its server again. Takes the action network.write. */
|
|
2810
|
+
put: operations["setSandboxEgress"];
|
|
2811
|
+
post?: never;
|
|
2812
|
+
delete?: never;
|
|
2813
|
+
options?: never;
|
|
2814
|
+
head?: never;
|
|
2815
|
+
patch?: never;
|
|
2816
|
+
trace?: never;
|
|
2817
|
+
};
|
|
2818
|
+
"/v1/templates/{id}/egress": {
|
|
2819
|
+
parameters: {
|
|
2820
|
+
query?: never;
|
|
2821
|
+
header?: never;
|
|
2822
|
+
path?: never;
|
|
2823
|
+
cookie?: never;
|
|
2824
|
+
};
|
|
2825
|
+
/** @description Where the web traffic of a sandbox made on the template leaves, unless its create says otherwise. */
|
|
2826
|
+
get: operations["getTemplateEgress"];
|
|
2827
|
+
/** @description Sets where the web traffic of each sandbox made on the template from now on leaves, unless its create says otherwise. Sandboxes already on it keep their own: PUT /v1/sandboxes/{id}/egress changes one. Takes the action network.write. */
|
|
2828
|
+
put: operations["setTemplateEgress"];
|
|
2829
|
+
post?: never;
|
|
2830
|
+
delete?: never;
|
|
2831
|
+
options?: never;
|
|
2832
|
+
head?: never;
|
|
2833
|
+
patch?: never;
|
|
2834
|
+
trace?: never;
|
|
2835
|
+
};
|
|
2749
2836
|
}
|
|
2750
2837
|
export type webhooks = Record<string, never>;
|
|
2751
2838
|
export interface components {
|
|
@@ -3049,6 +3136,7 @@ export interface components {
|
|
|
3049
3136
|
metadata?: {
|
|
3050
3137
|
[key: string]: string;
|
|
3051
3138
|
};
|
|
3139
|
+
egress?: components["schemas"]["EgressInput"];
|
|
3052
3140
|
};
|
|
3053
3141
|
/** @description Addresses the sandbox may reach on top of its template's outbound rule. It is held to the two from its first boot, so it never runs open first. Left out, it has none of its own. The rule itself is its template's: PUT /v1/templates/{id}/network. PUT /v1/sandboxes/{id}/network changes its own addresses later, while it runs. A fork has its source's. Sending outbound here is refused with rule_on_template. Only where GET /v1/policy says networkPolicy. */
|
|
3054
3142
|
SandboxOwnNetworkInput: {
|
|
@@ -3060,6 +3148,26 @@ export interface components {
|
|
|
3060
3148
|
*/
|
|
3061
3149
|
allow: string[];
|
|
3062
3150
|
};
|
|
3151
|
+
/** @description Where its web traffic leaves, from its first boot. Left out, its template's (GET /v1/templates/{id}/egress); {"via": "box"} leaves from its server whatever its template says. PUT /v1/sandboxes/{id}/egress changes it later. A fork has its source's. residential asks that the account may use it: GET /v1/egress. Only where GET /v1/policy says residentialEgress. */
|
|
3152
|
+
EgressInput: {
|
|
3153
|
+
/**
|
|
3154
|
+
* @description box: from the server the sandbox is on, as every sandbox's does unless it asks otherwise, for nothing. residential: its TCP to ports 80 and 443 leaves through a residential address in country, charged at $3 a GB, both directions counted, from the account's credits; its UDP to port 443 is refused, so HTTP/3 falls back to TCP; other ports leave from its server as before.
|
|
3155
|
+
* @example residential
|
|
3156
|
+
* @enum {string}
|
|
3157
|
+
*/
|
|
3158
|
+
via: "box" | "residential";
|
|
3159
|
+
/**
|
|
3160
|
+
* @description With residential: the country the address is in, as two letters of ISO 3166-1, such as de or us. Not with box.
|
|
3161
|
+
* @example de
|
|
3162
|
+
*/
|
|
3163
|
+
country?: string;
|
|
3164
|
+
/**
|
|
3165
|
+
* @description With residential: sticky keeps one address for the sandbox for as long as it holds, as a person's browser would; rotating gives each connection another. Left out, sticky. Not with box.
|
|
3166
|
+
* @example sticky
|
|
3167
|
+
* @enum {string}
|
|
3168
|
+
*/
|
|
3169
|
+
session?: "sticky" | "rotating";
|
|
3170
|
+
};
|
|
3063
3171
|
SandboxList: {
|
|
3064
3172
|
sandboxes: components["schemas"]["Sandbox"][];
|
|
3065
3173
|
/** @description What to send as cursor, with the same sort and limit, for the sandboxes after these. Null when these are the last. */
|
|
@@ -4625,6 +4733,8 @@ export interface components {
|
|
|
4625
4733
|
networkPolicy: boolean;
|
|
4626
4734
|
/** @description Whether a variable can be kept out of its sandbox: set with hosts, its commands see a stand-in, and the proxy on the sandbox's server puts the value in on HTTPS requests to those hosts. False, a save with hosts answers 501 hidden_variables_unavailable, and a variable already kept out stays out. */
|
|
4627
4735
|
hiddenVariables: boolean;
|
|
4736
|
+
/** @description Whether a sandbox's web traffic can leave through a residential address, at $3 a GB: PUT /v1/sandboxes/{id}/egress, and egress on a create or a template. GET /v1/egress says whether the account may. False, asking for it answers 501 residential_egress_unavailable. */
|
|
4737
|
+
residentialEgress: boolean;
|
|
4628
4738
|
/** @description Whether a sandbox's CPU, memory, disk and network are read and kept: GET /v1/sandboxes/{id}/metrics and GET /v1/metrics. False, both answer 501 metrics_unavailable. GET /v1/metrics/running answers either way. */
|
|
4629
4739
|
metrics: boolean;
|
|
4630
4740
|
/** @description Whether an account can have its sandboxes' metrics and lifecycle events sent to a collector of its own, over OTLP/HTTP: GET, PUT and DELETE /v1/telemetry, and POST /v1/telemetry/test. Metrics are sent only where metrics is true as well. False, those calls answer 501 telemetry_unavailable. */
|
|
@@ -5377,6 +5487,79 @@ export interface components {
|
|
|
5377
5487
|
/** @description Always null: nothing raises an account but a change of plan. */
|
|
5378
5488
|
next: null;
|
|
5379
5489
|
};
|
|
5490
|
+
EgressAccount: {
|
|
5491
|
+
/** @description Whether this deployment offers residential egress at all, as GET /v1/policy says residentialEgress. */
|
|
5492
|
+
offered: boolean;
|
|
5493
|
+
/** @description Whether a sandbox of this account may go out residential now: offered, nothing missing, and not refused. */
|
|
5494
|
+
enabled: boolean;
|
|
5495
|
+
/** @description What the account still needs: plan, to be on Fleet ($100 a month) or a larger plan; card, a card saved; business, its company, website and intended use, with PUT /v1/egress/business. */
|
|
5496
|
+
missing: ("plan" | "card" | "business")[];
|
|
5497
|
+
/** @description Set when we refused the account residential egress: its sandboxes' residential traffic is refused until we lift it. */
|
|
5498
|
+
refused: {
|
|
5499
|
+
reason: string;
|
|
5500
|
+
at: string;
|
|
5501
|
+
} | null;
|
|
5502
|
+
/** @description What the account told us of itself, or null. */
|
|
5503
|
+
business: {
|
|
5504
|
+
company: string;
|
|
5505
|
+
website: string;
|
|
5506
|
+
intendedUse: string;
|
|
5507
|
+
submittedAt: string;
|
|
5508
|
+
} | null;
|
|
5509
|
+
/** @description What a GB of residential traffic costs, both directions counted, in millionths of a US dollar: 3000000 is $3. */
|
|
5510
|
+
microsPerGb: number;
|
|
5511
|
+
/** @description What its residential traffic has cost this month, in millionths of a US dollar. It is part of usedMicros in GET /v1/billing. */
|
|
5512
|
+
spentMicros: number;
|
|
5513
|
+
/** @description The most its residential traffic costs in a month. Past it, residential connections are refused until the month ends or the budget is raised. */
|
|
5514
|
+
budgetMicros: number;
|
|
5515
|
+
/** @description Whether the account set its budget. False: it is defaultBudgetMicros. */
|
|
5516
|
+
budgetSet: boolean;
|
|
5517
|
+
defaultBudgetMicros: number;
|
|
5518
|
+
/**
|
|
5519
|
+
* @description Why its residential connections are refused now, or null when they are not: refused, by us; out_of_credit, the credits ran out and an auto-reload did not cover it; budget_reached, this month's budget is spent; plan, the account is no longer on a plan that offers it. It is checked each minute, so a change shows within one.
|
|
5520
|
+
* @enum {string|null}
|
|
5521
|
+
*/
|
|
5522
|
+
blocked: "refused" | "out_of_credit" | "budget_reached" | "plan" | null;
|
|
5523
|
+
};
|
|
5524
|
+
EgressBusiness: {
|
|
5525
|
+
/**
|
|
5526
|
+
* @description The company's legal name.
|
|
5527
|
+
* @example Example Labs Ltd
|
|
5528
|
+
*/
|
|
5529
|
+
company: string;
|
|
5530
|
+
/**
|
|
5531
|
+
* Format: uri
|
|
5532
|
+
* @description Its website.
|
|
5533
|
+
* @example https://example.com
|
|
5534
|
+
*/
|
|
5535
|
+
website: string;
|
|
5536
|
+
/**
|
|
5537
|
+
* @description What its sandboxes will use residential addresses for, in a few sentences: the sites, and why they need it.
|
|
5538
|
+
* @example Our agents test our customers' sign-up flows from the countries they sell in, behind Cloudflare Turnstile.
|
|
5539
|
+
*/
|
|
5540
|
+
intendedUse: string;
|
|
5541
|
+
};
|
|
5542
|
+
EgressBudget: {
|
|
5543
|
+
/**
|
|
5544
|
+
* @description The most the account's residential traffic costs in a month, in millionths of a US dollar: 0 refuses all of it. null gives it the default again, $50.
|
|
5545
|
+
* @example 50000000
|
|
5546
|
+
*/
|
|
5547
|
+
budgetMicros: number | null;
|
|
5548
|
+
};
|
|
5549
|
+
Egress: {
|
|
5550
|
+
/** @enum {string} */
|
|
5551
|
+
via: "box" | "residential";
|
|
5552
|
+
/**
|
|
5553
|
+
* @description With residential, the country, in lower case. Null with box.
|
|
5554
|
+
* @example de
|
|
5555
|
+
*/
|
|
5556
|
+
country: string | null;
|
|
5557
|
+
/**
|
|
5558
|
+
* @description With residential, sticky or rotating. Null with box.
|
|
5559
|
+
* @enum {string|null}
|
|
5560
|
+
*/
|
|
5561
|
+
session: "sticky" | "rotating" | null;
|
|
5562
|
+
};
|
|
5380
5563
|
};
|
|
5381
5564
|
responses: never;
|
|
5382
5565
|
parameters: never;
|
|
@@ -17688,4 +17871,384 @@ export interface operations {
|
|
|
17688
17871
|
};
|
|
17689
17872
|
};
|
|
17690
17873
|
};
|
|
17874
|
+
getEgress: {
|
|
17875
|
+
parameters: {
|
|
17876
|
+
query?: never;
|
|
17877
|
+
header?: never;
|
|
17878
|
+
path?: never;
|
|
17879
|
+
cookie?: never;
|
|
17880
|
+
};
|
|
17881
|
+
requestBody?: never;
|
|
17882
|
+
responses: {
|
|
17883
|
+
/** @description Where the account stands. */
|
|
17884
|
+
200: {
|
|
17885
|
+
headers: {
|
|
17886
|
+
[name: string]: unknown;
|
|
17887
|
+
};
|
|
17888
|
+
content: {
|
|
17889
|
+
"application/json": components["schemas"]["EgressAccount"];
|
|
17890
|
+
};
|
|
17891
|
+
};
|
|
17892
|
+
/** @description invalid_request. The key belongs to no account. */
|
|
17893
|
+
400: {
|
|
17894
|
+
headers: {
|
|
17895
|
+
[name: string]: unknown;
|
|
17896
|
+
};
|
|
17897
|
+
content: {
|
|
17898
|
+
"application/json": components["schemas"]["Error"];
|
|
17899
|
+
};
|
|
17900
|
+
};
|
|
17901
|
+
/** @description Missing or invalid API key. */
|
|
17902
|
+
401: {
|
|
17903
|
+
headers: {
|
|
17904
|
+
[name: string]: unknown;
|
|
17905
|
+
};
|
|
17906
|
+
content: {
|
|
17907
|
+
"application/json": components["schemas"]["Error"];
|
|
17908
|
+
};
|
|
17909
|
+
};
|
|
17910
|
+
};
|
|
17911
|
+
};
|
|
17912
|
+
setEgressBusiness: {
|
|
17913
|
+
parameters: {
|
|
17914
|
+
query?: never;
|
|
17915
|
+
header?: never;
|
|
17916
|
+
path?: never;
|
|
17917
|
+
cookie?: never;
|
|
17918
|
+
};
|
|
17919
|
+
requestBody: {
|
|
17920
|
+
content: {
|
|
17921
|
+
"application/json": components["schemas"]["EgressBusiness"];
|
|
17922
|
+
};
|
|
17923
|
+
};
|
|
17924
|
+
responses: {
|
|
17925
|
+
/** @description Kept, and the account as it stands now. */
|
|
17926
|
+
200: {
|
|
17927
|
+
headers: {
|
|
17928
|
+
[name: string]: unknown;
|
|
17929
|
+
};
|
|
17930
|
+
content: {
|
|
17931
|
+
"application/json": components["schemas"]["EgressAccount"];
|
|
17932
|
+
};
|
|
17933
|
+
};
|
|
17934
|
+
/** @description invalid_request: a field is missing, too long, or website is not an address. The key belongs to no account. */
|
|
17935
|
+
400: {
|
|
17936
|
+
headers: {
|
|
17937
|
+
[name: string]: unknown;
|
|
17938
|
+
};
|
|
17939
|
+
content: {
|
|
17940
|
+
"application/json": components["schemas"]["Error"];
|
|
17941
|
+
};
|
|
17942
|
+
};
|
|
17943
|
+
/** @description Missing or invalid API key. */
|
|
17944
|
+
401: {
|
|
17945
|
+
headers: {
|
|
17946
|
+
[name: string]: unknown;
|
|
17947
|
+
};
|
|
17948
|
+
content: {
|
|
17949
|
+
"application/json": components["schemas"]["Error"];
|
|
17950
|
+
};
|
|
17951
|
+
};
|
|
17952
|
+
/** @description role_required: in a team, only an owner says this. egress_refused: we refused the account residential egress. */
|
|
17953
|
+
403: {
|
|
17954
|
+
headers: {
|
|
17955
|
+
[name: string]: unknown;
|
|
17956
|
+
};
|
|
17957
|
+
content: {
|
|
17958
|
+
"application/json": components["schemas"]["Error"];
|
|
17959
|
+
};
|
|
17960
|
+
};
|
|
17961
|
+
/** @description residential_egress_unavailable: GET /v1/policy says residentialEgress is false. */
|
|
17962
|
+
501: {
|
|
17963
|
+
headers: {
|
|
17964
|
+
[name: string]: unknown;
|
|
17965
|
+
};
|
|
17966
|
+
content: {
|
|
17967
|
+
"application/json": components["schemas"]["Error"];
|
|
17968
|
+
};
|
|
17969
|
+
};
|
|
17970
|
+
};
|
|
17971
|
+
};
|
|
17972
|
+
setEgressBudget: {
|
|
17973
|
+
parameters: {
|
|
17974
|
+
query?: never;
|
|
17975
|
+
header?: never;
|
|
17976
|
+
path?: never;
|
|
17977
|
+
cookie?: never;
|
|
17978
|
+
};
|
|
17979
|
+
requestBody: {
|
|
17980
|
+
content: {
|
|
17981
|
+
"application/json": components["schemas"]["EgressBudget"];
|
|
17982
|
+
};
|
|
17983
|
+
};
|
|
17984
|
+
responses: {
|
|
17985
|
+
/** @description The budget is set, and the account as it stands now. */
|
|
17986
|
+
200: {
|
|
17987
|
+
headers: {
|
|
17988
|
+
[name: string]: unknown;
|
|
17989
|
+
};
|
|
17990
|
+
content: {
|
|
17991
|
+
"application/json": components["schemas"]["EgressAccount"];
|
|
17992
|
+
};
|
|
17993
|
+
};
|
|
17994
|
+
/** @description invalid_request. The budget is not a whole number from 0 to 100000000000, or null, or the key belongs to no account. */
|
|
17995
|
+
400: {
|
|
17996
|
+
headers: {
|
|
17997
|
+
[name: string]: unknown;
|
|
17998
|
+
};
|
|
17999
|
+
content: {
|
|
18000
|
+
"application/json": components["schemas"]["Error"];
|
|
18001
|
+
};
|
|
18002
|
+
};
|
|
18003
|
+
/** @description Missing or invalid API key. */
|
|
18004
|
+
401: {
|
|
18005
|
+
headers: {
|
|
18006
|
+
[name: string]: unknown;
|
|
18007
|
+
};
|
|
18008
|
+
content: {
|
|
18009
|
+
"application/json": components["schemas"]["Error"];
|
|
18010
|
+
};
|
|
18011
|
+
};
|
|
18012
|
+
/** @description role_required: in a team, only an owner sets its budget. */
|
|
18013
|
+
403: {
|
|
18014
|
+
headers: {
|
|
18015
|
+
[name: string]: unknown;
|
|
18016
|
+
};
|
|
18017
|
+
content: {
|
|
18018
|
+
"application/json": components["schemas"]["Error"];
|
|
18019
|
+
};
|
|
18020
|
+
};
|
|
18021
|
+
/** @description residential_egress_unavailable: GET /v1/policy says residentialEgress is false. */
|
|
18022
|
+
501: {
|
|
18023
|
+
headers: {
|
|
18024
|
+
[name: string]: unknown;
|
|
18025
|
+
};
|
|
18026
|
+
content: {
|
|
18027
|
+
"application/json": components["schemas"]["Error"];
|
|
18028
|
+
};
|
|
18029
|
+
};
|
|
18030
|
+
};
|
|
18031
|
+
};
|
|
18032
|
+
getSandboxEgress: {
|
|
18033
|
+
parameters: {
|
|
18034
|
+
query?: never;
|
|
18035
|
+
header?: never;
|
|
18036
|
+
path: {
|
|
18037
|
+
id: string;
|
|
18038
|
+
};
|
|
18039
|
+
cookie?: never;
|
|
18040
|
+
};
|
|
18041
|
+
requestBody?: never;
|
|
18042
|
+
responses: {
|
|
18043
|
+
/** @description Where its web traffic leaves. */
|
|
18044
|
+
200: {
|
|
18045
|
+
headers: {
|
|
18046
|
+
[name: string]: unknown;
|
|
18047
|
+
};
|
|
18048
|
+
content: {
|
|
18049
|
+
"application/json": components["schemas"]["Egress"];
|
|
18050
|
+
};
|
|
18051
|
+
};
|
|
18052
|
+
/** @description Missing or invalid API key. */
|
|
18053
|
+
401: {
|
|
18054
|
+
headers: {
|
|
18055
|
+
[name: string]: unknown;
|
|
18056
|
+
};
|
|
18057
|
+
content: {
|
|
18058
|
+
"application/json": components["schemas"]["Error"];
|
|
18059
|
+
};
|
|
18060
|
+
};
|
|
18061
|
+
/** @description Not found. */
|
|
18062
|
+
404: {
|
|
18063
|
+
headers: {
|
|
18064
|
+
[name: string]: unknown;
|
|
18065
|
+
};
|
|
18066
|
+
content: {
|
|
18067
|
+
"application/json": components["schemas"]["Error"];
|
|
18068
|
+
};
|
|
18069
|
+
};
|
|
18070
|
+
};
|
|
18071
|
+
};
|
|
18072
|
+
setSandboxEgress: {
|
|
18073
|
+
parameters: {
|
|
18074
|
+
query?: never;
|
|
18075
|
+
header?: never;
|
|
18076
|
+
path: {
|
|
18077
|
+
id: string;
|
|
18078
|
+
};
|
|
18079
|
+
cookie?: never;
|
|
18080
|
+
};
|
|
18081
|
+
requestBody: {
|
|
18082
|
+
content: {
|
|
18083
|
+
"application/json": components["schemas"]["EgressInput"];
|
|
18084
|
+
};
|
|
18085
|
+
};
|
|
18086
|
+
responses: {
|
|
18087
|
+
/** @description Where its web traffic leaves from now on. */
|
|
18088
|
+
200: {
|
|
18089
|
+
headers: {
|
|
18090
|
+
[name: string]: unknown;
|
|
18091
|
+
};
|
|
18092
|
+
content: {
|
|
18093
|
+
"application/json": components["schemas"]["Egress"];
|
|
18094
|
+
};
|
|
18095
|
+
};
|
|
18096
|
+
/** @description invalid_request: residential without country, or country or session with box. Nothing was changed. */
|
|
18097
|
+
400: {
|
|
18098
|
+
headers: {
|
|
18099
|
+
[name: string]: unknown;
|
|
18100
|
+
};
|
|
18101
|
+
content: {
|
|
18102
|
+
"application/json": components["schemas"]["Error"];
|
|
18103
|
+
};
|
|
18104
|
+
};
|
|
18105
|
+
/** @description Missing or invalid API key. */
|
|
18106
|
+
401: {
|
|
18107
|
+
headers: {
|
|
18108
|
+
[name: string]: unknown;
|
|
18109
|
+
};
|
|
18110
|
+
content: {
|
|
18111
|
+
"application/json": components["schemas"]["Error"];
|
|
18112
|
+
};
|
|
18113
|
+
};
|
|
18114
|
+
/** @description egress_not_enabled: the account may not go out residential yet, and missing says what it lacks (GET /v1/egress). egress_refused: we refused it. Nothing was changed. */
|
|
18115
|
+
403: {
|
|
18116
|
+
headers: {
|
|
18117
|
+
[name: string]: unknown;
|
|
18118
|
+
};
|
|
18119
|
+
content: {
|
|
18120
|
+
"application/json": components["schemas"]["Error"];
|
|
18121
|
+
};
|
|
18122
|
+
};
|
|
18123
|
+
/** @description Not found. */
|
|
18124
|
+
404: {
|
|
18125
|
+
headers: {
|
|
18126
|
+
[name: string]: unknown;
|
|
18127
|
+
};
|
|
18128
|
+
content: {
|
|
18129
|
+
"application/json": components["schemas"]["Error"];
|
|
18130
|
+
};
|
|
18131
|
+
};
|
|
18132
|
+
/** @description residential_egress_unavailable: residential was asked for where GET /v1/policy says residentialEgress is false. Nothing was changed. */
|
|
18133
|
+
501: {
|
|
18134
|
+
headers: {
|
|
18135
|
+
[name: string]: unknown;
|
|
18136
|
+
};
|
|
18137
|
+
content: {
|
|
18138
|
+
"application/json": components["schemas"]["Error"];
|
|
18139
|
+
};
|
|
18140
|
+
};
|
|
18141
|
+
};
|
|
18142
|
+
};
|
|
18143
|
+
getTemplateEgress: {
|
|
18144
|
+
parameters: {
|
|
18145
|
+
query?: never;
|
|
18146
|
+
header?: never;
|
|
18147
|
+
path: {
|
|
18148
|
+
id: string;
|
|
18149
|
+
};
|
|
18150
|
+
cookie?: never;
|
|
18151
|
+
};
|
|
18152
|
+
requestBody?: never;
|
|
18153
|
+
responses: {
|
|
18154
|
+
/** @description Where a new sandbox's web traffic leaves. */
|
|
18155
|
+
200: {
|
|
18156
|
+
headers: {
|
|
18157
|
+
[name: string]: unknown;
|
|
18158
|
+
};
|
|
18159
|
+
content: {
|
|
18160
|
+
"application/json": components["schemas"]["Egress"];
|
|
18161
|
+
};
|
|
18162
|
+
};
|
|
18163
|
+
/** @description Missing or invalid API key. */
|
|
18164
|
+
401: {
|
|
18165
|
+
headers: {
|
|
18166
|
+
[name: string]: unknown;
|
|
18167
|
+
};
|
|
18168
|
+
content: {
|
|
18169
|
+
"application/json": components["schemas"]["Error"];
|
|
18170
|
+
};
|
|
18171
|
+
};
|
|
18172
|
+
/** @description Not found. */
|
|
18173
|
+
404: {
|
|
18174
|
+
headers: {
|
|
18175
|
+
[name: string]: unknown;
|
|
18176
|
+
};
|
|
18177
|
+
content: {
|
|
18178
|
+
"application/json": components["schemas"]["Error"];
|
|
18179
|
+
};
|
|
18180
|
+
};
|
|
18181
|
+
};
|
|
18182
|
+
};
|
|
18183
|
+
setTemplateEgress: {
|
|
18184
|
+
parameters: {
|
|
18185
|
+
query?: never;
|
|
18186
|
+
header?: never;
|
|
18187
|
+
path: {
|
|
18188
|
+
id: string;
|
|
18189
|
+
};
|
|
18190
|
+
cookie?: never;
|
|
18191
|
+
};
|
|
18192
|
+
requestBody: {
|
|
18193
|
+
content: {
|
|
18194
|
+
"application/json": components["schemas"]["EgressInput"];
|
|
18195
|
+
};
|
|
18196
|
+
};
|
|
18197
|
+
responses: {
|
|
18198
|
+
/** @description Where a new sandbox's web traffic leaves from now on. */
|
|
18199
|
+
200: {
|
|
18200
|
+
headers: {
|
|
18201
|
+
[name: string]: unknown;
|
|
18202
|
+
};
|
|
18203
|
+
content: {
|
|
18204
|
+
"application/json": components["schemas"]["Egress"];
|
|
18205
|
+
};
|
|
18206
|
+
};
|
|
18207
|
+
/** @description invalid_request: residential without country, or country or session with box. Nothing was changed. */
|
|
18208
|
+
400: {
|
|
18209
|
+
headers: {
|
|
18210
|
+
[name: string]: unknown;
|
|
18211
|
+
};
|
|
18212
|
+
content: {
|
|
18213
|
+
"application/json": components["schemas"]["Error"];
|
|
18214
|
+
};
|
|
18215
|
+
};
|
|
18216
|
+
/** @description Missing or invalid API key. */
|
|
18217
|
+
401: {
|
|
18218
|
+
headers: {
|
|
18219
|
+
[name: string]: unknown;
|
|
18220
|
+
};
|
|
18221
|
+
content: {
|
|
18222
|
+
"application/json": components["schemas"]["Error"];
|
|
18223
|
+
};
|
|
18224
|
+
};
|
|
18225
|
+
/** @description egress_not_enabled: the account may not go out residential yet, and missing says what it lacks (GET /v1/egress). egress_refused: we refused it. Nothing was changed. */
|
|
18226
|
+
403: {
|
|
18227
|
+
headers: {
|
|
18228
|
+
[name: string]: unknown;
|
|
18229
|
+
};
|
|
18230
|
+
content: {
|
|
18231
|
+
"application/json": components["schemas"]["Error"];
|
|
18232
|
+
};
|
|
18233
|
+
};
|
|
18234
|
+
/** @description Not found. */
|
|
18235
|
+
404: {
|
|
18236
|
+
headers: {
|
|
18237
|
+
[name: string]: unknown;
|
|
18238
|
+
};
|
|
18239
|
+
content: {
|
|
18240
|
+
"application/json": components["schemas"]["Error"];
|
|
18241
|
+
};
|
|
18242
|
+
};
|
|
18243
|
+
/** @description residential_egress_unavailable: residential was asked for where GET /v1/policy says residentialEgress is false. Nothing was changed. */
|
|
18244
|
+
501: {
|
|
18245
|
+
headers: {
|
|
18246
|
+
[name: string]: unknown;
|
|
18247
|
+
};
|
|
18248
|
+
content: {
|
|
18249
|
+
"application/json": components["schemas"]["Error"];
|
|
18250
|
+
};
|
|
18251
|
+
};
|
|
18252
|
+
};
|
|
18253
|
+
};
|
|
17691
18254
|
}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, as package.json says it. A test holds the two to the same. */
|
|
2
|
-
export declare const VERSION = "0.2.
|
|
2
|
+
export declare const VERSION = "0.2.1";
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, as package.json says it. A test holds the two to the same. */
|
|
2
|
-
export const VERSION = "0.2.
|
|
2
|
+
export const VERSION = "0.2.1";
|
package/package.json
CHANGED