@hypelabs-llc/ts-sdk 0.1.5 → 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/README.md +18 -14
- package/dist/apiKeyAuthenticationProvider.d.ts +1 -1
- package/dist/apiKeyAuthenticationProvider.js +1 -1
- package/dist/{partnerClient.d.ts → connectClient.d.ts} +4 -4
- package/dist/{partnerClient.js → connectClient.js} +6 -6
- package/dist/generated/catalog/capabilities/index.d.ts +44 -0
- package/dist/generated/catalog/capabilities/index.js +22 -0
- package/dist/generated/catalog/datacenters/index.d.ts +45 -0
- package/dist/generated/catalog/datacenters/index.js +25 -0
- package/dist/generated/catalog/index.d.ts +39 -0
- package/dist/generated/catalog/index.js +39 -0
- package/dist/generated/{isps → catalog/isps}/index.d.ts +17 -6
- package/dist/generated/{isps → catalog/isps}/index.js +6 -3
- package/dist/generated/{locations → catalog/locations}/index.d.ts +14 -6
- package/dist/generated/{locations → catalog/locations}/index.js +6 -3
- package/dist/generated/{products → catalog/products}/index.d.ts +13 -7
- package/dist/generated/{products → catalog/products}/index.js +2 -2
- package/dist/generated/connectApiClient.d.ts +54 -0
- package/dist/generated/{partnerApiClient.js → connectApiClient.js} +10 -41
- package/dist/generated/customers/authenticate/index.d.ts +23 -8
- package/dist/generated/customers/authenticate/index.js +21 -3
- package/dist/generated/customers/authenticate/oauth/index.d.ts +30 -0
- package/dist/generated/customers/authenticate/oauth/index.js +28 -0
- package/dist/generated/customers/authenticate/telegram/index.d.ts +31 -0
- package/dist/generated/customers/authenticate/telegram/index.js +29 -0
- package/dist/generated/customers/index.d.ts +24 -6
- package/dist/generated/customers/index.js +8 -4
- package/dist/generated/customers/item/billing/index.d.ts +31 -0
- package/dist/generated/customers/item/billing/index.js +29 -0
- package/dist/generated/customers/item/defaults/index.d.ts +30 -0
- package/dist/generated/customers/item/defaults/index.js +28 -0
- package/dist/generated/customers/item/index.d.ts +53 -5
- package/dist/generated/customers/item/index.js +57 -5
- package/dist/generated/customers/item/kyc/index.d.ts +3 -2
- package/dist/generated/customers/item/kyc/index.js +5 -2
- package/dist/generated/customers/item/metadata/index.d.ts +30 -0
- package/dist/generated/customers/item/metadata/index.js +28 -0
- package/dist/generated/customers/item/password/index.d.ts +30 -0
- package/dist/generated/customers/item/password/index.js +28 -0
- package/dist/generated/customers/item/resetPassword/index.d.ts +28 -0
- package/dist/generated/customers/item/resetPassword/index.js +25 -0
- package/dist/generated/customers/item/sendVerification/index.d.ts +31 -0
- package/dist/generated/customers/item/sendVerification/index.js +29 -0
- package/dist/generated/incidents/index.d.ts +20 -6
- package/dist/generated/incidents/index.js +8 -4
- package/dist/generated/{organizations/item/members/item → incidents/item/dismiss}/index.d.ts +10 -8
- package/dist/generated/incidents/item/dismiss/index.js +25 -0
- package/dist/generated/incidents/item/index.d.ts +19 -11
- package/dist/generated/incidents/item/index.js +25 -8
- package/dist/generated/incidents/item/metadata/index.d.ts +30 -0
- package/dist/generated/incidents/item/metadata/index.js +28 -0
- package/dist/generated/incidents/item/resolve/index.d.ts +30 -0
- package/dist/generated/incidents/item/resolve/index.js +28 -0
- package/dist/generated/models/index.d.ts +1509 -983
- package/dist/generated/models/index.js +1341 -951
- package/dist/generated/orders/index.d.ts +28 -8
- package/dist/generated/orders/index.js +10 -4
- package/dist/generated/orders/item/extend/index.d.ts +8 -5
- package/dist/generated/orders/item/extend/index.js +8 -3
- package/dist/generated/orders/item/index.d.ts +39 -1
- package/dist/generated/orders/item/index.js +33 -0
- package/dist/generated/{activities → orders/item/proxies}/index.d.ts +10 -7
- package/dist/generated/orders/item/proxies/index.js +25 -0
- package/dist/generated/orders/preview/index.d.ts +7 -5
- package/dist/generated/orders/preview/index.js +7 -3
- package/dist/generated/orders/trial/index.d.ts +9 -6
- package/dist/generated/orders/trial/index.js +9 -4
- package/dist/generated/proxies/index.d.ts +5 -5
- package/dist/generated/proxies/item/annotations/index.d.ts +29 -0
- package/dist/generated/{organizations/item/pricing → proxies/item/annotations}/index.js +6 -6
- package/dist/generated/proxies/item/credentials/index.d.ts +10 -10
- package/dist/generated/proxies/item/credentials/index.js +4 -5
- package/dist/generated/proxies/item/index.d.ts +17 -2
- package/dist/generated/proxies/item/index.js +15 -0
- package/dist/generated/proxies/item/ipInfo/index.d.ts +29 -0
- package/dist/generated/proxies/item/ipInfo/index.js +26 -0
- package/dist/generated/proxies/item/ipRotation/index.d.ts +11 -6
- package/dist/generated/proxies/item/ipRotation/index.js +5 -0
- package/dist/generated/{systemAlert → proxies/item/ipRotation/link}/index.d.ts +9 -9
- package/dist/generated/proxies/item/ipRotation/link/index.js +22 -0
- package/dist/generated/proxies/item/ipRotation/trigger/index.d.ts +2 -2
- package/dist/generated/proxies/item/options/index.d.ts +42 -0
- package/dist/generated/proxies/item/options/index.js +34 -0
- package/dist/generated/proxies/item/ping/index.d.ts +4 -2
- package/dist/generated/proxies/item/ping/index.js +6 -2
- package/dist/generated/reviews/index.d.ts +4 -3
- package/dist/generated/reviews/index.js +5 -2
- package/dist/generated/reviews/item/approve/index.d.ts +1 -0
- package/dist/generated/reviews/item/approve/index.js +5 -2
- package/dist/generated/reviews/item/index.d.ts +7 -2
- package/dist/generated/reviews/item/index.js +12 -2
- package/dist/generated/reviews/item/metadata/index.d.ts +30 -0
- package/dist/generated/reviews/item/metadata/index.js +28 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +2 -2
- package/dist/generated/activities/index.js +0 -22
- package/dist/generated/organizations/index.d.ts +0 -52
- package/dist/generated/organizations/index.js +0 -43
- package/dist/generated/organizations/item/balance/deposit/index.d.ts +0 -29
- package/dist/generated/organizations/item/balance/deposit/index.js +0 -25
- package/dist/generated/organizations/item/balance/index.d.ts +0 -36
- package/dist/generated/organizations/item/balance/index.js +0 -32
- package/dist/generated/organizations/item/billing/index.d.ts +0 -41
- package/dist/generated/organizations/item/billing/index.js +0 -31
- package/dist/generated/organizations/item/branding/index.d.ts +0 -29
- package/dist/generated/organizations/item/branding/index.js +0 -25
- package/dist/generated/organizations/item/email/index.d.ts +0 -41
- package/dist/generated/organizations/item/email/index.js +0 -31
- package/dist/generated/organizations/item/index.d.ts +0 -92
- package/dist/generated/organizations/item/index.js +0 -79
- package/dist/generated/organizations/item/infrastructure/dnsCheck/index.d.ts +0 -33
- package/dist/generated/organizations/item/infrastructure/dnsCheck/index.js +0 -22
- package/dist/generated/organizations/item/infrastructure/index.d.ts +0 -50
- package/dist/generated/organizations/item/infrastructure/index.js +0 -41
- package/dist/generated/organizations/item/members/index.d.ts +0 -38
- package/dist/generated/organizations/item/members/index.js +0 -33
- package/dist/generated/organizations/item/members/item/index.js +0 -16
- package/dist/generated/organizations/item/pricing/index.d.ts +0 -29
- package/dist/generated/partnerApiClient.d.ts +0 -84
- package/dist/generated/paymentProcessors/index.d.ts +0 -65
- package/dist/generated/paymentProcessors/index.js +0 -36
- package/dist/generated/systemAlert/index.js +0 -22
|
@@ -1,118 +1,197 @@
|
|
|
1
|
-
import { type AdditionalDataHolder, type Guid, type Parsable, type ParseNode, type SerializationWriter } from '@microsoft/kiota-abstractions';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
apiKeyId?: Guid | null;
|
|
1
|
+
import { type AdditionalDataHolder, type ApiError, type Guid, type Parsable, type ParseNode, type SerializationWriter, type UntypedNode } from '@microsoft/kiota-abstractions';
|
|
2
|
+
/**
|
|
3
|
+
* A promotional card shown to organizations in the dashboard: a headline with an optional image, body and link.Only AnnouncementStatuses.Published ones are shown, most recent first.
|
|
4
|
+
*/
|
|
5
|
+
export interface Announcement extends AdditionalDataHolder, Parsable {
|
|
7
6
|
/**
|
|
8
|
-
*
|
|
7
|
+
* Body text of the announcement, shown under the title.
|
|
9
8
|
*/
|
|
10
|
-
|
|
9
|
+
body?: string | null;
|
|
11
10
|
/**
|
|
12
11
|
* The id property
|
|
13
12
|
*/
|
|
14
13
|
id?: Guid | null;
|
|
15
14
|
/**
|
|
16
|
-
*
|
|
15
|
+
* URL of the image displayed on the card.
|
|
17
16
|
*/
|
|
18
|
-
|
|
17
|
+
imageUrl?: string | null;
|
|
19
18
|
/**
|
|
20
|
-
*
|
|
19
|
+
* True when the announcement is published and currently visible.
|
|
21
20
|
*/
|
|
22
|
-
|
|
21
|
+
isLive?: boolean | null;
|
|
23
22
|
/**
|
|
24
|
-
*
|
|
23
|
+
* Label of the link's call-to-action button (e.g. "Learn more").
|
|
25
24
|
*/
|
|
26
|
-
|
|
25
|
+
linkLabel?: string | null;
|
|
27
26
|
/**
|
|
28
|
-
*
|
|
27
|
+
* Destination URL opened when the card is clicked.
|
|
29
28
|
*/
|
|
30
|
-
|
|
29
|
+
linkUrl?: string | null;
|
|
30
|
+
/**
|
|
31
|
+
* The metadata property
|
|
32
|
+
*/
|
|
33
|
+
metadata?: Announcement_metadata | null;
|
|
34
|
+
/**
|
|
35
|
+
* Publication state of the announcement: only Published ones are shown.
|
|
36
|
+
*/
|
|
37
|
+
status?: AnnouncementStatuses | null;
|
|
38
|
+
/**
|
|
39
|
+
* Headline displayed at the top of the card.
|
|
40
|
+
*/
|
|
41
|
+
title?: string | null;
|
|
31
42
|
}
|
|
32
|
-
export interface
|
|
43
|
+
export interface Announcement_metadata extends AdditionalDataHolder, Parsable {
|
|
44
|
+
}
|
|
45
|
+
export type AnnouncementStatuses = (typeof AnnouncementStatusesObject)[keyof typeof AnnouncementStatusesObject];
|
|
46
|
+
export interface ApiError extends AdditionalDataHolder, Parsable {
|
|
33
47
|
/**
|
|
34
|
-
* The
|
|
48
|
+
* The code property
|
|
35
49
|
*/
|
|
36
|
-
|
|
50
|
+
code?: string | null;
|
|
37
51
|
/**
|
|
38
|
-
* The
|
|
52
|
+
* The description property
|
|
39
53
|
*/
|
|
40
|
-
|
|
54
|
+
description?: string | null;
|
|
55
|
+
}
|
|
56
|
+
export interface ApiResponse extends AdditionalDataHolder, ApiError, Parsable {
|
|
41
57
|
/**
|
|
42
|
-
* The
|
|
58
|
+
* The data property
|
|
43
59
|
*/
|
|
44
|
-
|
|
60
|
+
data?: UntypedNode | null;
|
|
45
61
|
/**
|
|
46
|
-
* The
|
|
62
|
+
* The errors property
|
|
47
63
|
*/
|
|
48
|
-
|
|
64
|
+
errors?: ApiError[] | null;
|
|
49
65
|
/**
|
|
50
|
-
* The
|
|
66
|
+
* The message property
|
|
51
67
|
*/
|
|
52
|
-
|
|
68
|
+
messageEscaped?: string | null;
|
|
53
69
|
/**
|
|
54
|
-
* The
|
|
70
|
+
* The requestDetails property
|
|
55
71
|
*/
|
|
56
|
-
|
|
72
|
+
requestDetails?: RequestDetails | null;
|
|
57
73
|
/**
|
|
58
|
-
* The
|
|
74
|
+
* The statusCode property
|
|
59
75
|
*/
|
|
60
|
-
|
|
76
|
+
statusCode?: number | null;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Identity attested by an external provider (Google, GitHub, Apple, ...) after the organization's own front-end(or app) completed the OAuth sign-in. The Connect API trusts the attested identity — it never talks to theprovider itself — and finds or creates the matching customer, scoped to the calling organization.
|
|
80
|
+
*/
|
|
81
|
+
export interface AuthenticateCustomerOAuthRequest extends AdditionalDataHolder, Parsable {
|
|
61
82
|
/**
|
|
62
|
-
*
|
|
83
|
+
* Display name reported by the provider, used when creating the customer. Null when the provider gives none.
|
|
63
84
|
*/
|
|
64
|
-
|
|
85
|
+
displayName?: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* Email address attested by the provider, used to link the sign-in to an existing customer or create one. Optional: Apple only returns it on the first authorization, so later sign-ins match by the provider link alone. Required when no customer matches yet (a first-time sign-in with no email cannot create an account).
|
|
88
|
+
*/
|
|
89
|
+
email?: string | null;
|
|
90
|
+
/**
|
|
91
|
+
* Preferred locale (e.g. `en-US`) reported by the provider. Refreshed on each sign-in; ignored when null.
|
|
92
|
+
*/
|
|
93
|
+
locale?: string | null;
|
|
94
|
+
/**
|
|
95
|
+
* Provider key the customer signed in through, e.g. `google`, `apple`, `discord`. A free string, not an enum: an organization can wire up any provider without Connect needing a new release.
|
|
96
|
+
*/
|
|
97
|
+
provider?: string | null;
|
|
98
|
+
/**
|
|
99
|
+
* Stable identifier of the customer at the provider (the provider's account id).
|
|
100
|
+
*/
|
|
101
|
+
providerId?: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* Device push-notification token (e.g. the app's APNs token), sent at sign-in. Refreshed when provided; ignored when null.
|
|
104
|
+
*/
|
|
105
|
+
pushNotificationsToken?: string | null;
|
|
65
106
|
}
|
|
66
|
-
|
|
107
|
+
/**
|
|
108
|
+
* Credentials to authenticate one of the organization's customers.
|
|
109
|
+
*/
|
|
67
110
|
export interface AuthenticateCustomerRequest extends AdditionalDataHolder, Parsable {
|
|
68
111
|
/**
|
|
69
|
-
* The email
|
|
112
|
+
* The customer's email address.
|
|
70
113
|
*/
|
|
71
114
|
email?: string | null;
|
|
72
115
|
/**
|
|
73
|
-
* The
|
|
116
|
+
* The customer's one-time password (2FA code), when they have it enabled. Omit otherwise.
|
|
74
117
|
*/
|
|
75
118
|
otp?: string | null;
|
|
76
119
|
/**
|
|
77
|
-
* The password
|
|
120
|
+
* The customer's password.
|
|
78
121
|
*/
|
|
79
122
|
password?: string | null;
|
|
80
123
|
}
|
|
81
|
-
|
|
124
|
+
/**
|
|
125
|
+
* Identity attested by Telegram after a customer started the organization's bot. The Telegram user id is trustedas-is (Telegram authenticates it; it cannot be forged), and the Connect API resolves the customer alreadylinked to it. No customer is created here: the link is established elsewhere, by a signed-in customer addingtheir Telegram account, so an unlinked user is rejected rather than silently given a fresh account.
|
|
126
|
+
*/
|
|
127
|
+
export interface AuthenticateCustomerTelegramRequest extends AdditionalDataHolder, Parsable {
|
|
82
128
|
/**
|
|
83
|
-
* The
|
|
129
|
+
* The Telegram user id (the person's `from.id`) of the account talking to the bot, as the Bot API reports it.
|
|
84
130
|
*/
|
|
85
|
-
|
|
131
|
+
telegramUserId?: string | null;
|
|
132
|
+
}
|
|
133
|
+
export type BillingCycles = (typeof BillingCyclesObject)[keyof typeof BillingCyclesObject];
|
|
134
|
+
/**
|
|
135
|
+
* Cancels an order: how to end its billing and whether to refund.
|
|
136
|
+
*/
|
|
137
|
+
export interface CancelOrderRequest extends AdditionalDataHolder, Parsable {
|
|
86
138
|
/**
|
|
87
|
-
*
|
|
139
|
+
* Request a refund of the latest payment, granted only when the order is still within its refund window. Defaults to false.
|
|
88
140
|
*/
|
|
89
|
-
|
|
141
|
+
askRefund?: boolean | null;
|
|
90
142
|
/**
|
|
91
|
-
*
|
|
143
|
+
* End the order now instead of at the end of its paid period. False (the default) keeps it live until its current expiry, then it lapses normally; true expires it immediately and releases its proxies.
|
|
92
144
|
*/
|
|
93
|
-
|
|
145
|
+
immediateCancellation?: boolean | null;
|
|
94
146
|
}
|
|
95
|
-
|
|
96
|
-
|
|
147
|
+
/**
|
|
148
|
+
* A catalog capability that proxies can expose (IPv6, IP scoring, and similar features).
|
|
149
|
+
*/
|
|
150
|
+
export interface Capability extends AdditionalDataHolder, Parsable {
|
|
97
151
|
/**
|
|
98
|
-
*
|
|
152
|
+
* Count of proxies currently available (active and unallocated) behind this option.
|
|
99
153
|
*/
|
|
100
|
-
|
|
154
|
+
availableProxies?: number | null;
|
|
101
155
|
/**
|
|
102
|
-
*
|
|
156
|
+
* Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
|
|
103
157
|
*/
|
|
104
|
-
|
|
158
|
+
basePrice?: number | null;
|
|
105
159
|
/**
|
|
106
|
-
*
|
|
160
|
+
* Human-readable explanation of what the capability provides. Null when none is set.
|
|
107
161
|
*/
|
|
108
|
-
|
|
162
|
+
description?: string | null;
|
|
163
|
+
/**
|
|
164
|
+
* Unique identifier of the catalog option.
|
|
165
|
+
*/
|
|
166
|
+
id?: Guid | null;
|
|
167
|
+
/**
|
|
168
|
+
* Whether the current organization has hidden this option from its storefront.
|
|
169
|
+
*/
|
|
170
|
+
isDisabled?: boolean | null;
|
|
171
|
+
/**
|
|
172
|
+
* Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
|
|
173
|
+
*/
|
|
174
|
+
name?: string | null;
|
|
175
|
+
/**
|
|
176
|
+
* Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
|
|
177
|
+
*/
|
|
178
|
+
price?: number | null;
|
|
179
|
+
/**
|
|
180
|
+
* Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
|
|
181
|
+
*/
|
|
182
|
+
retailPrice?: number | null;
|
|
183
|
+
/**
|
|
184
|
+
* Which capability this option is (e.g. IPv6, IP scoring).
|
|
185
|
+
*/
|
|
186
|
+
type?: CapabilityTypes | null;
|
|
109
187
|
}
|
|
188
|
+
export type CapabilityTypes = (typeof CapabilityTypesObject)[keyof typeof CapabilityTypesObject];
|
|
110
189
|
/**
|
|
111
190
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
112
191
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
113
|
-
* @returns {
|
|
192
|
+
* @returns {Announcement_metadata}
|
|
114
193
|
*/
|
|
115
|
-
export declare function
|
|
194
|
+
export declare function createAnnouncement_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
116
195
|
/**
|
|
117
196
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
118
197
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -122,39 +201,51 @@ export declare function createAnnouncementFromDiscriminatorValue(parseNode: Pars
|
|
|
122
201
|
/**
|
|
123
202
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
124
203
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
125
|
-
* @returns {
|
|
204
|
+
* @returns {ApiError}
|
|
126
205
|
*/
|
|
127
|
-
export declare function
|
|
206
|
+
export declare function createApiErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
207
|
+
/**
|
|
208
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
209
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
210
|
+
* @returns {ApiResponse}
|
|
211
|
+
*/
|
|
212
|
+
export declare function createApiResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
128
213
|
/**
|
|
129
214
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
130
215
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
131
|
-
* @returns {
|
|
216
|
+
* @returns {AuthenticateCustomerOAuthRequest}
|
|
132
217
|
*/
|
|
133
|
-
export declare function
|
|
218
|
+
export declare function createAuthenticateCustomerOAuthRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
134
219
|
/**
|
|
135
220
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
136
221
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
137
|
-
* @returns {
|
|
222
|
+
* @returns {AuthenticateCustomerRequest}
|
|
138
223
|
*/
|
|
139
|
-
export declare function
|
|
224
|
+
export declare function createAuthenticateCustomerRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
140
225
|
/**
|
|
141
226
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
142
227
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
143
|
-
* @returns {
|
|
228
|
+
* @returns {AuthenticateCustomerTelegramRequest}
|
|
144
229
|
*/
|
|
145
|
-
export declare function
|
|
230
|
+
export declare function createAuthenticateCustomerTelegramRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
146
231
|
/**
|
|
147
232
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
148
233
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
149
|
-
* @returns {
|
|
234
|
+
* @returns {CancelOrderRequest}
|
|
150
235
|
*/
|
|
151
|
-
export declare function
|
|
236
|
+
export declare function createCancelOrderRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
237
|
+
/**
|
|
238
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
239
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
240
|
+
* @returns {Capability}
|
|
241
|
+
*/
|
|
242
|
+
export declare function createCapabilityFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
152
243
|
/**
|
|
153
244
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
154
245
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
155
|
-
* @returns {
|
|
246
|
+
* @returns {CreateCustomerRequest}
|
|
156
247
|
*/
|
|
157
|
-
export declare function
|
|
248
|
+
export declare function createCreateCustomerRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
158
249
|
/**
|
|
159
250
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
160
251
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -176,33 +267,39 @@ export declare function createCreateOrderResponseFromDiscriminatorValue(parseNod
|
|
|
176
267
|
/**
|
|
177
268
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
178
269
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
179
|
-
* @returns {
|
|
270
|
+
* @returns {CreateReviewRequest}
|
|
180
271
|
*/
|
|
181
|
-
export declare function
|
|
272
|
+
export declare function createCreateReviewRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
182
273
|
/**
|
|
183
274
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
184
275
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
185
|
-
* @returns {
|
|
276
|
+
* @returns {CreateTrialResponse}
|
|
186
277
|
*/
|
|
187
|
-
export declare function
|
|
278
|
+
export declare function createCreateTrialResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
188
279
|
/**
|
|
189
280
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
190
281
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
191
|
-
* @returns {
|
|
282
|
+
* @returns {Customer_externalLogins}
|
|
192
283
|
*/
|
|
193
|
-
export declare function
|
|
284
|
+
export declare function createCustomer_externalLoginsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
194
285
|
/**
|
|
195
286
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
196
287
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
197
|
-
* @returns {
|
|
288
|
+
* @returns {Customer_metadata}
|
|
198
289
|
*/
|
|
199
|
-
export declare function
|
|
290
|
+
export declare function createCustomer_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
200
291
|
/**
|
|
201
292
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
202
293
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
203
|
-
* @returns {
|
|
294
|
+
* @returns {CustomerAuthResponse}
|
|
204
295
|
*/
|
|
205
|
-
export declare function
|
|
296
|
+
export declare function createCustomerAuthResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
297
|
+
/**
|
|
298
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
299
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
300
|
+
* @returns {CustomerBilling}
|
|
301
|
+
*/
|
|
302
|
+
export declare function createCustomerBillingFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
206
303
|
/**
|
|
207
304
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
208
305
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -215,86 +312,106 @@ export declare function createCustomerFromDiscriminatorValue(parseNode: ParseNod
|
|
|
215
312
|
* @returns {CustomerKyc}
|
|
216
313
|
*/
|
|
217
314
|
export declare function createCustomerKycFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
315
|
+
/**
|
|
316
|
+
* Payload to create a customer (your organization's own end user).
|
|
317
|
+
*/
|
|
218
318
|
export interface CreateCustomerRequest extends AdditionalDataHolder, Parsable {
|
|
219
319
|
/**
|
|
220
|
-
* The
|
|
320
|
+
* The billing property
|
|
221
321
|
*/
|
|
222
|
-
|
|
322
|
+
billing?: CustomerBilling | null;
|
|
223
323
|
/**
|
|
224
|
-
*
|
|
324
|
+
* Name shown for the customer in the dashboard and emails.
|
|
225
325
|
*/
|
|
226
326
|
displayName?: string | null;
|
|
227
327
|
/**
|
|
228
|
-
*
|
|
328
|
+
* Email address of the customer. Must be unique within your organization.
|
|
229
329
|
*/
|
|
230
330
|
email?: string | null;
|
|
231
331
|
/**
|
|
232
|
-
*
|
|
332
|
+
* Identifier of the customer in your own system. Matches records across systems and makes creation idempotent.
|
|
233
333
|
*/
|
|
234
334
|
externalId?: string | null;
|
|
235
335
|
/**
|
|
236
|
-
*
|
|
336
|
+
* Preferred locale (e.g. "en", "fr") for emails and OTP messages.
|
|
237
337
|
*/
|
|
238
338
|
locale?: string | null;
|
|
239
339
|
/**
|
|
240
|
-
*
|
|
340
|
+
* Initial password of the customer, stored hashed. Omit for an OAuth-only or passwordless user.
|
|
241
341
|
*/
|
|
242
342
|
password?: string | null;
|
|
243
343
|
/**
|
|
244
|
-
*
|
|
344
|
+
* Phone number of the customer.
|
|
245
345
|
*/
|
|
246
346
|
phoneNumber?: string | null;
|
|
247
|
-
}
|
|
248
|
-
export interface CreateCustomerRequest_billingDetails extends AdditionalDataHolder, Parsable {
|
|
249
|
-
}
|
|
250
|
-
export interface CreateDepositRequest extends AdditionalDataHolder, Parsable {
|
|
251
347
|
/**
|
|
252
|
-
*
|
|
348
|
+
* Page (your own) linked in the verification email sent on creation, with the token appended as a query parameter. Omit to leave the email unverified and skip the email.
|
|
253
349
|
*/
|
|
254
|
-
|
|
350
|
+
verificationUrl?: string | null;
|
|
255
351
|
}
|
|
256
352
|
/**
|
|
257
353
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
258
354
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
259
|
-
* @returns {
|
|
355
|
+
* @returns {Datacenter}
|
|
356
|
+
*/
|
|
357
|
+
export declare function createDatacenterFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
358
|
+
/**
|
|
359
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
360
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
361
|
+
* @returns {ExtendOrderRequest}
|
|
260
362
|
*/
|
|
261
|
-
export declare function
|
|
363
|
+
export declare function createExtendOrderRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
262
364
|
/**
|
|
263
365
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
264
366
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
265
|
-
* @returns {
|
|
367
|
+
* @returns {ExtendOrderResponse}
|
|
266
368
|
*/
|
|
267
|
-
export declare function
|
|
369
|
+
export declare function createExtendOrderResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
268
370
|
/**
|
|
269
371
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
270
372
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
271
|
-
* @returns {
|
|
373
|
+
* @returns {Incident_metadata}
|
|
272
374
|
*/
|
|
273
|
-
export declare function
|
|
375
|
+
export declare function createIncident_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
274
376
|
/**
|
|
275
377
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
276
378
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
277
379
|
* @returns {Incident}
|
|
278
380
|
*/
|
|
279
381
|
export declare function createIncidentFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
382
|
+
/**
|
|
383
|
+
* Payload to open a new incident.
|
|
384
|
+
*/
|
|
280
385
|
export interface CreateIncidentRequest extends AdditionalDataHolder, Parsable {
|
|
281
386
|
/**
|
|
282
|
-
*
|
|
387
|
+
* Free-form details about the incident.
|
|
283
388
|
*/
|
|
284
389
|
description?: string | null;
|
|
285
390
|
/**
|
|
286
|
-
*
|
|
391
|
+
* Email address of the person reporting the incident.
|
|
287
392
|
*/
|
|
288
393
|
reporterEmail?: string | null;
|
|
289
394
|
/**
|
|
290
|
-
*
|
|
395
|
+
* Short title summarizing the incident.
|
|
291
396
|
*/
|
|
292
397
|
subject?: string | null;
|
|
293
398
|
/**
|
|
294
|
-
*
|
|
399
|
+
* Identifier of the affected resource.
|
|
295
400
|
*/
|
|
296
401
|
target?: string | null;
|
|
297
402
|
}
|
|
403
|
+
/**
|
|
404
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
405
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
406
|
+
* @returns {IpInformation}
|
|
407
|
+
*/
|
|
408
|
+
export declare function createIpInformationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
409
|
+
/**
|
|
410
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
411
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
412
|
+
* @returns {IpRotationLinkResponse}
|
|
413
|
+
*/
|
|
414
|
+
export declare function createIpRotationLinkResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
298
415
|
/**
|
|
299
416
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
300
417
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -310,15 +427,15 @@ export declare function createLocationFromDiscriminatorValue(parseNode: ParseNod
|
|
|
310
427
|
/**
|
|
311
428
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
312
429
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
313
|
-
* @returns {
|
|
430
|
+
* @returns {Order_metadata}
|
|
314
431
|
*/
|
|
315
|
-
export declare function
|
|
432
|
+
export declare function createOrder_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
316
433
|
/**
|
|
317
434
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
318
435
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
319
|
-
* @returns {
|
|
436
|
+
* @returns {OrderCriteria}
|
|
320
437
|
*/
|
|
321
|
-
export declare function
|
|
438
|
+
export declare function createOrderCriteriaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
322
439
|
/**
|
|
323
440
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
324
441
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -328,193 +445,213 @@ export declare function createOrderFromDiscriminatorValue(parseNode: ParseNode |
|
|
|
328
445
|
/**
|
|
329
446
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
330
447
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
331
|
-
* @returns {
|
|
448
|
+
* @returns {OrderItem_metadata}
|
|
449
|
+
*/
|
|
450
|
+
export declare function createOrderItem_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
451
|
+
/**
|
|
452
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
453
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
454
|
+
* @returns {OrderItem}
|
|
455
|
+
*/
|
|
456
|
+
export declare function createOrderItemFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
457
|
+
/**
|
|
458
|
+
* Order request: the same selection as a price preview, plus whether it auto-renews.
|
|
332
459
|
*/
|
|
333
|
-
export declare function createOrderPreviewResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
334
460
|
export interface CreateOrderRequest extends AdditionalDataHolder, Parsable {
|
|
335
461
|
/**
|
|
336
|
-
*
|
|
337
|
-
*/
|
|
338
|
-
billingCycle?: NullableOfBillingCycles | null;
|
|
339
|
-
/**
|
|
340
|
-
* The consumerRef property
|
|
462
|
+
* Priced selection the order is placed against.
|
|
341
463
|
*/
|
|
342
|
-
|
|
464
|
+
criteria?: OrderCriteria | null;
|
|
343
465
|
/**
|
|
344
|
-
* The
|
|
466
|
+
* The organization's end customer this order is for. Required for a retail order (it bills that customer on the organization's connected account); must be null for wholesale (the organization itself is billed).
|
|
345
467
|
*/
|
|
346
|
-
|
|
468
|
+
customerId?: Guid | null;
|
|
347
469
|
/**
|
|
348
|
-
*
|
|
470
|
+
* Your own reference for this order, unique within your organization. Attach it to make creation idempotent: a request that times out can be safely retried with the same reference and returns the order that was already placed instead of creating a duplicate. Optional.
|
|
349
471
|
*/
|
|
350
|
-
|
|
472
|
+
externalReference?: string | null;
|
|
351
473
|
/**
|
|
352
|
-
* The
|
|
474
|
+
* The intent property
|
|
353
475
|
*/
|
|
354
|
-
|
|
476
|
+
intent?: OrderIntents | null;
|
|
355
477
|
/**
|
|
356
|
-
*
|
|
478
|
+
* Whether the order renews itself for another billing cycle at expiry instead of lapsing. Defaults to false.
|
|
357
479
|
*/
|
|
358
|
-
|
|
480
|
+
isAutoRenew?: boolean | null;
|
|
359
481
|
/**
|
|
360
|
-
*
|
|
482
|
+
* Number of units to order. Defaults to 1.
|
|
361
483
|
*/
|
|
362
484
|
quantity?: number | null;
|
|
363
485
|
}
|
|
364
486
|
/**
|
|
365
|
-
*
|
|
366
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
367
|
-
* @returns {OrderRequirements}
|
|
487
|
+
* The order that was placed: its id, and the checkout URL to follow when a hosted payment is needed.
|
|
368
488
|
*/
|
|
369
|
-
export declare function createOrderRequirementsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
370
489
|
export interface CreateOrderResponse extends AdditionalDataHolder, Parsable {
|
|
371
490
|
/**
|
|
372
|
-
*
|
|
373
|
-
*/
|
|
374
|
-
currency?: string | null;
|
|
375
|
-
/**
|
|
376
|
-
* The isTrial property
|
|
377
|
-
*/
|
|
378
|
-
isTrial?: boolean | null;
|
|
379
|
-
/**
|
|
380
|
-
* The orderId property
|
|
491
|
+
* Unique order identifier.
|
|
381
492
|
*/
|
|
382
493
|
orderId?: Guid | null;
|
|
383
494
|
/**
|
|
384
|
-
*
|
|
385
|
-
*/
|
|
386
|
-
quantity?: number | null;
|
|
387
|
-
/**
|
|
388
|
-
* The returnUrl property
|
|
495
|
+
* Checkout URL the caller should send the customer to, or null when none is needed.
|
|
389
496
|
*/
|
|
390
497
|
returnUrl?: string | null;
|
|
391
|
-
/**
|
|
392
|
-
* The total property
|
|
393
|
-
*/
|
|
394
|
-
total?: number | null;
|
|
395
|
-
/**
|
|
396
|
-
* The unitPrice property
|
|
397
|
-
*/
|
|
398
|
-
unitPrice?: number | null;
|
|
399
498
|
}
|
|
400
499
|
/**
|
|
401
500
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
402
501
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
403
|
-
* @returns {
|
|
502
|
+
* @returns {PatchCustomerBillingRequest}
|
|
404
503
|
*/
|
|
405
|
-
export declare function
|
|
504
|
+
export declare function createPatchCustomerBillingRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
406
505
|
/**
|
|
407
506
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
408
507
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
409
|
-
* @returns {
|
|
508
|
+
* @returns {PatchCustomerDefaultsRequest}
|
|
410
509
|
*/
|
|
411
|
-
export declare function
|
|
510
|
+
export declare function createPatchCustomerDefaultsRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
412
511
|
/**
|
|
413
512
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
414
513
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
415
|
-
* @returns {
|
|
514
|
+
* @returns {PatchCustomerRequest}
|
|
416
515
|
*/
|
|
417
|
-
export declare function
|
|
516
|
+
export declare function createPatchCustomerRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
418
517
|
/**
|
|
419
518
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
420
519
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
421
|
-
* @returns {
|
|
520
|
+
* @returns {PatchMetadataRequest_metadata}
|
|
422
521
|
*/
|
|
423
|
-
export declare function
|
|
522
|
+
export declare function createPatchMetadataRequest_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
424
523
|
/**
|
|
425
524
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
426
525
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
427
|
-
* @returns {
|
|
526
|
+
* @returns {PatchMetadataRequest}
|
|
428
527
|
*/
|
|
429
|
-
export declare function
|
|
528
|
+
export declare function createPatchMetadataRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
430
529
|
/**
|
|
431
530
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
432
531
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
433
|
-
* @returns {
|
|
532
|
+
* @returns {PatchPasswordRequest}
|
|
434
533
|
*/
|
|
435
|
-
export declare function
|
|
534
|
+
export declare function createPatchPasswordRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
436
535
|
/**
|
|
437
536
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
438
537
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
439
|
-
* @returns {
|
|
538
|
+
* @returns {PatchProxyAnnotationRequest}
|
|
440
539
|
*/
|
|
441
|
-
export declare function
|
|
540
|
+
export declare function createPatchProxyAnnotationRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
442
541
|
/**
|
|
443
542
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
444
543
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
445
|
-
* @returns {
|
|
544
|
+
* @returns {PreviewOrderRequest}
|
|
446
545
|
*/
|
|
447
|
-
export declare function
|
|
448
|
-
export interface CreateOrganizationRequest extends AdditionalDataHolder, Parsable {
|
|
449
|
-
/**
|
|
450
|
-
* The companyName property
|
|
451
|
-
*/
|
|
452
|
-
companyName?: string | null;
|
|
453
|
-
/**
|
|
454
|
-
* The name property
|
|
455
|
-
*/
|
|
456
|
-
name?: string | null;
|
|
457
|
-
}
|
|
546
|
+
export declare function createPreviewOrderRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
458
547
|
/**
|
|
459
548
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
460
549
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
461
|
-
* @returns {
|
|
550
|
+
* @returns {PreviewOrderResponse}
|
|
462
551
|
*/
|
|
463
|
-
export declare function
|
|
552
|
+
export declare function createPreviewOrderResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
464
553
|
/**
|
|
465
554
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
466
555
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
467
|
-
* @returns {
|
|
556
|
+
* @returns {Product}
|
|
468
557
|
*/
|
|
469
|
-
export declare function
|
|
558
|
+
export declare function createProductFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
470
559
|
/**
|
|
471
560
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
472
561
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
473
|
-
* @returns {
|
|
562
|
+
* @returns {ProxyCredentialResponse}
|
|
474
563
|
*/
|
|
475
|
-
export declare function
|
|
564
|
+
export declare function createProxyCredentialResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
476
565
|
/**
|
|
477
566
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
478
567
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
479
|
-
* @returns {
|
|
568
|
+
* @returns {ProxyDatacenter}
|
|
480
569
|
*/
|
|
481
|
-
export declare function
|
|
570
|
+
export declare function createProxyDatacenterFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
482
571
|
/**
|
|
483
572
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
484
573
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
485
|
-
* @returns {
|
|
574
|
+
* @returns {ProxyFeatures}
|
|
486
575
|
*/
|
|
487
|
-
export declare function
|
|
576
|
+
export declare function createProxyFeaturesFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
488
577
|
/**
|
|
489
578
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
490
579
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
491
|
-
* @returns {
|
|
580
|
+
* @returns {Proxy}
|
|
492
581
|
*/
|
|
493
|
-
export declare function
|
|
582
|
+
export declare function createProxyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
494
583
|
/**
|
|
495
584
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
496
585
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
497
|
-
* @returns {
|
|
586
|
+
* @returns {ProxyIpRotationFeature}
|
|
498
587
|
*/
|
|
499
|
-
export declare function
|
|
588
|
+
export declare function createProxyIpRotationFeatureFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
500
589
|
/**
|
|
501
590
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
502
591
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
503
|
-
* @returns {
|
|
592
|
+
* @returns {ProxyIpRotationResponse}
|
|
504
593
|
*/
|
|
505
|
-
export declare function
|
|
594
|
+
export declare function createProxyIpRotationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
506
595
|
/**
|
|
507
596
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
508
597
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
509
|
-
* @returns {
|
|
598
|
+
* @returns {ProxyIsp}
|
|
510
599
|
*/
|
|
511
|
-
export declare function
|
|
600
|
+
export declare function createProxyIspFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
601
|
+
/**
|
|
602
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
603
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
604
|
+
* @returns {ProxyLocation}
|
|
605
|
+
*/
|
|
606
|
+
export declare function createProxyLocationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
607
|
+
/**
|
|
608
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
609
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
610
|
+
* @returns {ProxyOptions_metadata}
|
|
611
|
+
*/
|
|
612
|
+
export declare function createProxyOptions_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
613
|
+
/**
|
|
614
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
615
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
616
|
+
* @returns {ProxyOptions}
|
|
617
|
+
*/
|
|
618
|
+
export declare function createProxyOptionsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
512
619
|
/**
|
|
513
620
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
514
621
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
515
622
|
* @returns {ProxyPingResponse}
|
|
516
623
|
*/
|
|
517
624
|
export declare function createProxyPingResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
625
|
+
/**
|
|
626
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
627
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
628
|
+
* @returns {ProxyProduct}
|
|
629
|
+
*/
|
|
630
|
+
export declare function createProxyProductFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
631
|
+
/**
|
|
632
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
633
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
634
|
+
* @returns {RequestDetails}
|
|
635
|
+
*/
|
|
636
|
+
export declare function createRequestDetailsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
637
|
+
/**
|
|
638
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
639
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
640
|
+
* @returns {ResetPasswordResponse}
|
|
641
|
+
*/
|
|
642
|
+
export declare function createResetPasswordResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
643
|
+
/**
|
|
644
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
645
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
646
|
+
* @returns {ResolveIncidentRequest}
|
|
647
|
+
*/
|
|
648
|
+
export declare function createResolveIncidentRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
649
|
+
/**
|
|
650
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
651
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
652
|
+
* @returns {Review_metadata}
|
|
653
|
+
*/
|
|
654
|
+
export declare function createReview_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
518
655
|
/**
|
|
519
656
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
520
657
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -527,272 +664,394 @@ export declare function createReviewFromDiscriminatorValue(parseNode: ParseNode
|
|
|
527
664
|
* @returns {ReviewKycRequest}
|
|
528
665
|
*/
|
|
529
666
|
export declare function createReviewKycRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
667
|
+
/**
|
|
668
|
+
* Payload to create a customer review.
|
|
669
|
+
*/
|
|
530
670
|
export interface CreateReviewRequest extends AdditionalDataHolder, Parsable {
|
|
531
671
|
/**
|
|
532
|
-
*
|
|
672
|
+
* Body text of the review.
|
|
533
673
|
*/
|
|
534
674
|
content?: string | null;
|
|
535
675
|
/**
|
|
536
|
-
*
|
|
676
|
+
* Display name for the reviewer, overriding the customer name or standing in for an anonymous review.
|
|
537
677
|
*/
|
|
538
678
|
customAuthorName?: string | null;
|
|
539
679
|
/**
|
|
540
|
-
*
|
|
680
|
+
* Identifier of the customer who left the review. Null for anonymous reviews.
|
|
541
681
|
*/
|
|
542
682
|
customerId?: Guid | null;
|
|
543
683
|
/**
|
|
544
|
-
*
|
|
684
|
+
* Whether the review is highlighted (for example pinned on a landing page). Defaults to false.
|
|
545
685
|
*/
|
|
546
686
|
isFeatured?: boolean | null;
|
|
547
687
|
/**
|
|
548
|
-
* The rating
|
|
688
|
+
* The star rating, from 1 to 5.
|
|
549
689
|
*/
|
|
550
690
|
rating?: number | null;
|
|
551
691
|
}
|
|
552
692
|
/**
|
|
553
693
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
554
694
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
555
|
-
* @returns {
|
|
695
|
+
* @returns {SendVerificationRequest}
|
|
556
696
|
*/
|
|
557
|
-
export declare function
|
|
697
|
+
export declare function createSendVerificationRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
558
698
|
/**
|
|
559
699
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
560
700
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
561
|
-
* @returns {
|
|
701
|
+
* @returns {TrialOrderRequest}
|
|
562
702
|
*/
|
|
563
|
-
export declare function
|
|
703
|
+
export declare function createTrialOrderRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
564
704
|
/**
|
|
565
|
-
*
|
|
566
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
567
|
-
* @returns {UpdateCustomerRequest}
|
|
705
|
+
* Result of starting a free trial: what was provisioned and when it expires (no price, since trials are free).
|
|
568
706
|
*/
|
|
569
|
-
export
|
|
707
|
+
export interface CreateTrialResponse extends AdditionalDataHolder, Parsable {
|
|
708
|
+
/**
|
|
709
|
+
* When the trial expires. Null if the trial has no expiry.
|
|
710
|
+
*/
|
|
711
|
+
expiresAt?: Date | null;
|
|
712
|
+
/**
|
|
713
|
+
* Identifier of the order created for the trial.
|
|
714
|
+
*/
|
|
715
|
+
orderId?: Guid | null;
|
|
716
|
+
/**
|
|
717
|
+
* Number of proxies provisioned for the trial.
|
|
718
|
+
*/
|
|
719
|
+
quantity?: number | null;
|
|
720
|
+
}
|
|
570
721
|
/**
|
|
571
722
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
572
723
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
573
|
-
* @returns {
|
|
724
|
+
* @returns {UpdateCustomerRequest_externalLogins}
|
|
574
725
|
*/
|
|
575
|
-
export declare function
|
|
726
|
+
export declare function createUpdateCustomerRequest_externalLoginsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
576
727
|
/**
|
|
577
728
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
578
729
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
579
|
-
* @returns {
|
|
730
|
+
* @returns {UpdateCustomerRequest}
|
|
580
731
|
*/
|
|
581
|
-
export declare function
|
|
732
|
+
export declare function createUpdateCustomerRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
582
733
|
/**
|
|
583
734
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
584
735
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
585
|
-
* @returns {
|
|
736
|
+
* @returns {UpdateProxyCredentialsRequest}
|
|
586
737
|
*/
|
|
587
|
-
export declare function
|
|
738
|
+
export declare function createUpdateProxyCredentialsRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
588
739
|
/**
|
|
589
740
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
590
741
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
591
|
-
* @returns {
|
|
742
|
+
* @returns {UpdateProxyIpRotationRequest}
|
|
592
743
|
*/
|
|
593
|
-
export declare function
|
|
744
|
+
export declare function createUpdateProxyIpRotationRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
594
745
|
/**
|
|
595
746
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
596
747
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
597
|
-
* @returns {
|
|
748
|
+
* @returns {UpdateProxyOptionsRequest}
|
|
598
749
|
*/
|
|
599
|
-
export declare function
|
|
750
|
+
export declare function createUpdateProxyOptionsRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
600
751
|
/**
|
|
601
|
-
*
|
|
602
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
603
|
-
* @returns {UpdateOrganizationRequest}
|
|
604
|
-
*/
|
|
605
|
-
export declare function createUpdateOrganizationRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
606
|
-
/**
|
|
607
|
-
* Creates a new instance of the appropriate class based on discriminator value
|
|
608
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
609
|
-
* @returns {UpdatePaymentProcessorRequest_values}
|
|
610
|
-
*/
|
|
611
|
-
export declare function createUpdatePaymentProcessorRequest_valuesFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
612
|
-
/**
|
|
613
|
-
* Creates a new instance of the appropriate class based on discriminator value
|
|
614
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
615
|
-
* @returns {UpdatePaymentProcessorRequest}
|
|
616
|
-
*/
|
|
617
|
-
export declare function createUpdatePaymentProcessorRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
618
|
-
/**
|
|
619
|
-
* Creates a new instance of the appropriate class based on discriminator value
|
|
620
|
-
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
621
|
-
* @returns {UpdateProxyIpRotationRequest}
|
|
752
|
+
* An end user that an Organization? Customer.Organization manages through its API, scoped to that organization so twoorgs can hold the same email without collision. Not an ASP.NET Identity user (that is the platform's ownUser): customers never enter the auth pipeline.
|
|
622
753
|
*/
|
|
623
|
-
export
|
|
624
|
-
export interface CurrencyAmount extends AdditionalDataHolder, Parsable {
|
|
625
|
-
/**
|
|
626
|
-
* The amount property
|
|
627
|
-
*/
|
|
628
|
-
amount?: number | null;
|
|
754
|
+
export interface Customer extends AdditionalDataHolder, Parsable {
|
|
629
755
|
/**
|
|
630
|
-
*
|
|
756
|
+
* Domains the customer's proxies authorize by default. Empty means no domain restriction set here; `*` allows all.
|
|
631
757
|
*/
|
|
632
|
-
|
|
758
|
+
allowedDomains?: string[] | null;
|
|
633
759
|
/**
|
|
634
|
-
*
|
|
760
|
+
* IP addresses the customer's proxies authorize by default. Empty means no IP restriction set here.
|
|
635
761
|
*/
|
|
636
|
-
|
|
637
|
-
}
|
|
638
|
-
export interface Customer extends AdditionalDataHolder, Parsable {
|
|
762
|
+
allowedIps?: string[] | null;
|
|
639
763
|
/**
|
|
640
|
-
* The
|
|
764
|
+
* The user's Gravatar avatar URL, derived from their email (falls back to a neutral silhouette when the address has no Gravatar). Computed, not stored.
|
|
641
765
|
*/
|
|
642
766
|
avatarUrl?: string | null;
|
|
643
767
|
/**
|
|
644
|
-
*
|
|
768
|
+
* When the customer was banned. Null while active: banning disables access without deleting the record, so the value is kept for the audit trail.
|
|
645
769
|
*/
|
|
646
770
|
bannedAt?: Date | null;
|
|
647
771
|
/**
|
|
648
|
-
* The
|
|
772
|
+
* The billing property
|
|
773
|
+
*/
|
|
774
|
+
billing?: CustomerBilling | null;
|
|
775
|
+
/**
|
|
776
|
+
* The customer's ISO 3166-1 alpha-2 country code (uppercase): their billing country when set, otherwise the region of their locale (e.g. `en-US` → `US`). Computed, not persisted.
|
|
649
777
|
*/
|
|
650
|
-
|
|
778
|
+
countryCode?: string | null;
|
|
651
779
|
/**
|
|
652
|
-
*
|
|
780
|
+
* Display name shown for the customer. Null when none was provided.
|
|
653
781
|
*/
|
|
654
782
|
displayName?: string | null;
|
|
655
783
|
/**
|
|
656
|
-
* The email
|
|
784
|
+
* The customer's email. Unique within the owning organization.
|
|
657
785
|
*/
|
|
658
786
|
email?: string | null;
|
|
659
787
|
/**
|
|
660
|
-
*
|
|
788
|
+
* Whether the email has been verified, set true when the customer follows the verification link (see `CustomerService.VerifyEmailAsync`). Defaults to false.
|
|
661
789
|
*/
|
|
662
790
|
emailVerified?: boolean | null;
|
|
663
791
|
/**
|
|
664
|
-
*
|
|
792
|
+
* Identifier this customer has in the organization's own system, matched to keep creation idempotent. Null when the organization supplies none.
|
|
665
793
|
*/
|
|
666
794
|
externalId?: string | null;
|
|
667
795
|
/**
|
|
668
|
-
* The
|
|
796
|
+
* The user's external OAuth logins, keyed by provider (e.g. "apple", "google") with the provider's user identifier as the value. Stored as JSON. Null when the user has no linked social logins.
|
|
669
797
|
*/
|
|
670
798
|
externalLogins?: Customer_externalLogins | null;
|
|
799
|
+
/**
|
|
800
|
+
* The gracePeriodPolicy property
|
|
801
|
+
*/
|
|
802
|
+
gracePeriodPolicy?: GracePeriodPolicies | null;
|
|
671
803
|
/**
|
|
672
804
|
* The id property
|
|
673
805
|
*/
|
|
674
806
|
id?: Guid | null;
|
|
675
807
|
/**
|
|
676
|
-
*
|
|
808
|
+
* Whether the user is allowed to authenticate. False = banned; set DateTimeOffset? Customer.BannedAt too. Defaults to true.
|
|
677
809
|
*/
|
|
678
810
|
isActive?: boolean | null;
|
|
811
|
+
/**
|
|
812
|
+
* Whether this customer is a company (B2B) rather than an individual. True only when billing says so; a customer with no billing is treated as an individual. Computed, not persisted — the `isCompany` query filter runs on this in memory, so a missing billing correctly counts as a person.
|
|
813
|
+
*/
|
|
814
|
+
isCompany?: boolean | null;
|
|
679
815
|
/**
|
|
680
816
|
* The kyc property
|
|
681
817
|
*/
|
|
682
818
|
kyc?: CustomerKyc | null;
|
|
683
819
|
/**
|
|
684
|
-
*
|
|
820
|
+
* When the user last signed in, if ever. Null until their first login.
|
|
685
821
|
*/
|
|
686
822
|
lastLoginAt?: Date | null;
|
|
687
823
|
/**
|
|
688
|
-
* The locale
|
|
824
|
+
* The user's preferred locale (e.g. "en", "fr") for localized emails and OTP messages. Null until set.
|
|
689
825
|
*/
|
|
690
826
|
locale?: string | null;
|
|
691
827
|
/**
|
|
692
|
-
* The
|
|
828
|
+
* The metadata property
|
|
829
|
+
*/
|
|
830
|
+
metadata?: Customer_metadata | null;
|
|
831
|
+
/**
|
|
832
|
+
* Scheme that produced string? Customer.PasswordHash, defaulting to BCrypt. A Legacy hash is an import from a previous system, verified as-is and upgraded to BCrypt on the next successful login. The scheme is exposed to clients (the admin surface shows it) even though the hash itself never is.
|
|
693
833
|
*/
|
|
694
|
-
|
|
834
|
+
passwordHashScheme?: PasswordHashSchemes | null;
|
|
695
835
|
/**
|
|
696
|
-
* The
|
|
836
|
+
* The user's id with the payment processor (e.g. a Stripe customer id), if one has been created for them. Generic across processors; null until set.
|
|
697
837
|
*/
|
|
698
838
|
paymentCustomerId?: string | null;
|
|
699
839
|
/**
|
|
700
|
-
* The
|
|
840
|
+
* The user's phone number, if provided. Null until set.
|
|
701
841
|
*/
|
|
702
842
|
phoneNumber?: string | null;
|
|
703
843
|
/**
|
|
704
|
-
* The
|
|
844
|
+
* The device token used to send this user push notifications, if one has been registered. Null until set.
|
|
705
845
|
*/
|
|
706
846
|
pushNotificationsToken?: string | null;
|
|
707
847
|
}
|
|
708
|
-
|
|
709
|
-
|
|
848
|
+
/**
|
|
849
|
+
* The user's external OAuth logins, keyed by provider (e.g. "apple", "google") with the provider's user identifier as the value. Stored as JSON. Null when the user has no linked social logins.
|
|
850
|
+
*/
|
|
710
851
|
export interface Customer_externalLogins extends AdditionalDataHolder, Parsable {
|
|
711
852
|
}
|
|
853
|
+
export interface Customer_metadata extends AdditionalDataHolder, Parsable {
|
|
854
|
+
}
|
|
855
|
+
/**
|
|
856
|
+
* The result of a successful customer sign-in (password or OAuth): the inherited bearer token and expiry, plus the identity the front-end needs.
|
|
857
|
+
*/
|
|
858
|
+
export interface CustomerAuthResponse extends AdditionalDataHolder, Parsable {
|
|
859
|
+
/**
|
|
860
|
+
* JWT bearer token to send in the Authorization header.
|
|
861
|
+
*/
|
|
862
|
+
accessToken?: string | null;
|
|
863
|
+
/**
|
|
864
|
+
* The customer's avatar URL (their Gravatar, falling back to a neutral silhouette).
|
|
865
|
+
*/
|
|
866
|
+
avatar?: string | null;
|
|
867
|
+
/**
|
|
868
|
+
* The customer's email address.
|
|
869
|
+
*/
|
|
870
|
+
email?: string | null;
|
|
871
|
+
/**
|
|
872
|
+
* Instant the access token stops being valid.
|
|
873
|
+
*/
|
|
874
|
+
expiresAt?: Date | null;
|
|
875
|
+
/**
|
|
876
|
+
* Whether the customer is banned (suspended). False for an active account.
|
|
877
|
+
*/
|
|
878
|
+
isBanned?: boolean | null;
|
|
879
|
+
/**
|
|
880
|
+
* The customer's preferred locale (e.g. `en-US`), when set.
|
|
881
|
+
*/
|
|
882
|
+
locale?: string | null;
|
|
883
|
+
/**
|
|
884
|
+
* The customer's display name, when set.
|
|
885
|
+
*/
|
|
886
|
+
name?: string | null;
|
|
887
|
+
/**
|
|
888
|
+
* The customer's unique identifier.
|
|
889
|
+
*/
|
|
890
|
+
userId?: Guid | null;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* Legal billing address and tax identifiers shown on a customer's invoices. Value object owned byCustomer with no identity of its own; all fields are optional.
|
|
894
|
+
*/
|
|
895
|
+
export interface CustomerBilling extends AdditionalDataHolder, Parsable {
|
|
896
|
+
/**
|
|
897
|
+
* Street address (line 1).
|
|
898
|
+
*/
|
|
899
|
+
addressLine?: string | null;
|
|
900
|
+
/**
|
|
901
|
+
* City.
|
|
902
|
+
*/
|
|
903
|
+
city?: string | null;
|
|
904
|
+
/**
|
|
905
|
+
* The company's legal name, when bool CustomerBilling.IsCompany is true.
|
|
906
|
+
*/
|
|
907
|
+
companyName?: string | null;
|
|
908
|
+
/**
|
|
909
|
+
* Country (ISO 3166-1 alpha-2 code or name).
|
|
910
|
+
*/
|
|
911
|
+
country?: string | null;
|
|
912
|
+
/**
|
|
913
|
+
* Whether the customer is billed as a company (B2B) rather than an individual (B2C). When true, string? CustomerBilling.CompanyName and string? CustomerBilling.TaxId apply.
|
|
914
|
+
*/
|
|
915
|
+
isCompany?: boolean | null;
|
|
916
|
+
/**
|
|
917
|
+
* Postal / ZIP code.
|
|
918
|
+
*/
|
|
919
|
+
postalCode?: string | null;
|
|
920
|
+
/**
|
|
921
|
+
* Company registration number (e.g. SIREN/SIRET, Companies House number), distinct from the VAT/tax number in string? CustomerBilling.TaxId. Applies when bool CustomerBilling.IsCompany is true.
|
|
922
|
+
*/
|
|
923
|
+
registrationNumber?: string | null;
|
|
924
|
+
/**
|
|
925
|
+
* VAT / tax identification number.
|
|
926
|
+
*/
|
|
927
|
+
taxId?: string | null;
|
|
928
|
+
}
|
|
929
|
+
/**
|
|
930
|
+
* Know-your-customer details a customer submits before their first order: intended proxy usage, acceptable-usepolicy acknowledgement, and the submitted/approved state. Stored as JSON on the Customer.
|
|
931
|
+
*/
|
|
712
932
|
export interface CustomerKyc extends AdditionalDataHolder, Parsable {
|
|
713
933
|
/**
|
|
714
|
-
*
|
|
934
|
+
* Whether the submitted KYC has been approved by HypeLabs.
|
|
715
935
|
*/
|
|
716
936
|
approved?: boolean | null;
|
|
717
937
|
/**
|
|
718
|
-
*
|
|
938
|
+
* Free-text description of how the customer intends to use the proxies.
|
|
719
939
|
*/
|
|
720
940
|
description?: string | null;
|
|
721
941
|
/**
|
|
722
|
-
*
|
|
942
|
+
* Whether the customer acknowledged the acceptable-use policy when submitting.
|
|
723
943
|
*/
|
|
724
944
|
policyAcknowledged?: boolean | null;
|
|
725
945
|
/**
|
|
726
|
-
*
|
|
946
|
+
* Domain area the customer selected for their proxy usage (e.g. "ad-verification", "seo").
|
|
727
947
|
*/
|
|
728
948
|
scopeOfUse?: string | null;
|
|
729
949
|
/**
|
|
730
|
-
*
|
|
950
|
+
* Whether the customer has submitted their KYC details.
|
|
731
951
|
*/
|
|
732
952
|
submitted?: boolean | null;
|
|
733
953
|
}
|
|
734
|
-
|
|
954
|
+
/**
|
|
955
|
+
* Catalog option for a single datacenter: a physical site proxies can be provisioned in.
|
|
956
|
+
*/
|
|
957
|
+
export interface Datacenter extends AdditionalDataHolder, Parsable {
|
|
735
958
|
/**
|
|
736
|
-
*
|
|
959
|
+
* Count of proxies currently available (active and unallocated) behind this option.
|
|
737
960
|
*/
|
|
738
|
-
|
|
961
|
+
availableProxies?: number | null;
|
|
739
962
|
/**
|
|
740
|
-
*
|
|
963
|
+
* Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
|
|
741
964
|
*/
|
|
742
|
-
|
|
965
|
+
basePrice?: number | null;
|
|
966
|
+
/**
|
|
967
|
+
* ISO 3166-1 alpha-2 country code of the site, if known.
|
|
968
|
+
*/
|
|
969
|
+
countryCode?: string | null;
|
|
743
970
|
/**
|
|
744
|
-
*
|
|
971
|
+
* Unique identifier of the catalog option.
|
|
745
972
|
*/
|
|
746
|
-
|
|
973
|
+
id?: Guid | null;
|
|
974
|
+
/**
|
|
975
|
+
* Whether the current organization has hidden this option from its storefront.
|
|
976
|
+
*/
|
|
977
|
+
isDisabled?: boolean | null;
|
|
978
|
+
/**
|
|
979
|
+
* Free-text location of the site (city/address), if known.
|
|
980
|
+
*/
|
|
981
|
+
location?: string | null;
|
|
982
|
+
/**
|
|
983
|
+
* Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
|
|
984
|
+
*/
|
|
985
|
+
name?: string | null;
|
|
986
|
+
/**
|
|
987
|
+
* Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
|
|
988
|
+
*/
|
|
989
|
+
price?: number | null;
|
|
990
|
+
/**
|
|
991
|
+
* Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
|
|
992
|
+
*/
|
|
993
|
+
retailPrice?: number | null;
|
|
747
994
|
}
|
|
748
995
|
/**
|
|
749
996
|
* The deserialization information for the current model
|
|
750
|
-
* @param
|
|
997
|
+
* @param Announcement The instance to deserialize into.
|
|
998
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
999
|
+
*/
|
|
1000
|
+
export declare function deserializeIntoAnnouncement(announcement?: Partial<Announcement> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1001
|
+
/**
|
|
1002
|
+
* The deserialization information for the current model
|
|
1003
|
+
* @param Announcement_metadata The instance to deserialize into.
|
|
751
1004
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
752
1005
|
*/
|
|
753
|
-
export declare function
|
|
1006
|
+
export declare function deserializeIntoAnnouncement_metadata(announcement_metadata?: Partial<Announcement_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
754
1007
|
/**
|
|
755
1008
|
* The deserialization information for the current model
|
|
756
|
-
* @param
|
|
1009
|
+
* @param ApiError The instance to deserialize into.
|
|
757
1010
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
758
1011
|
*/
|
|
759
|
-
export declare function
|
|
1012
|
+
export declare function deserializeIntoApiError(apiError?: Partial<ApiError> | undefined): Record<string, (node: ParseNode) => void>;
|
|
760
1013
|
/**
|
|
761
1014
|
* The deserialization information for the current model
|
|
762
|
-
* @param
|
|
1015
|
+
* @param ApiResponse The instance to deserialize into.
|
|
763
1016
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
764
1017
|
*/
|
|
765
|
-
export declare function
|
|
1018
|
+
export declare function deserializeIntoApiResponse(apiResponse?: Partial<ApiResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
766
1019
|
/**
|
|
767
1020
|
* The deserialization information for the current model
|
|
768
|
-
* @param
|
|
1021
|
+
* @param AuthenticateCustomerOAuthRequest The instance to deserialize into.
|
|
769
1022
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
770
1023
|
*/
|
|
771
|
-
export declare function
|
|
1024
|
+
export declare function deserializeIntoAuthenticateCustomerOAuthRequest(authenticateCustomerOAuthRequest?: Partial<AuthenticateCustomerOAuthRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
772
1025
|
/**
|
|
773
1026
|
* The deserialization information for the current model
|
|
774
|
-
* @param
|
|
1027
|
+
* @param AuthenticateCustomerRequest The instance to deserialize into.
|
|
775
1028
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
776
1029
|
*/
|
|
777
|
-
export declare function
|
|
1030
|
+
export declare function deserializeIntoAuthenticateCustomerRequest(authenticateCustomerRequest?: Partial<AuthenticateCustomerRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
778
1031
|
/**
|
|
779
1032
|
* The deserialization information for the current model
|
|
780
|
-
* @param
|
|
1033
|
+
* @param AuthenticateCustomerTelegramRequest The instance to deserialize into.
|
|
781
1034
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
782
1035
|
*/
|
|
783
|
-
export declare function
|
|
1036
|
+
export declare function deserializeIntoAuthenticateCustomerTelegramRequest(authenticateCustomerTelegramRequest?: Partial<AuthenticateCustomerTelegramRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1037
|
+
/**
|
|
1038
|
+
* The deserialization information for the current model
|
|
1039
|
+
* @param CancelOrderRequest The instance to deserialize into.
|
|
1040
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1041
|
+
*/
|
|
1042
|
+
export declare function deserializeIntoCancelOrderRequest(cancelOrderRequest?: Partial<CancelOrderRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
784
1043
|
/**
|
|
785
1044
|
* The deserialization information for the current model
|
|
786
|
-
* @param
|
|
1045
|
+
* @param Capability The instance to deserialize into.
|
|
787
1046
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
788
1047
|
*/
|
|
789
|
-
export declare function
|
|
1048
|
+
export declare function deserializeIntoCapability(capability?: Partial<Capability> | undefined): Record<string, (node: ParseNode) => void>;
|
|
790
1049
|
/**
|
|
791
1050
|
* The deserialization information for the current model
|
|
792
|
-
* @param
|
|
1051
|
+
* @param CreateCustomerRequest The instance to deserialize into.
|
|
793
1052
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
794
1053
|
*/
|
|
795
|
-
export declare function
|
|
1054
|
+
export declare function deserializeIntoCreateCustomerRequest(createCustomerRequest?: Partial<CreateCustomerRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
796
1055
|
/**
|
|
797
1056
|
* The deserialization information for the current model
|
|
798
1057
|
* @param CreateIncidentRequest The instance to deserialize into.
|
|
@@ -811,12 +1070,6 @@ export declare function deserializeIntoCreateOrderRequest(createOrderRequest?: P
|
|
|
811
1070
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
812
1071
|
*/
|
|
813
1072
|
export declare function deserializeIntoCreateOrderResponse(createOrderResponse?: Partial<CreateOrderResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
814
|
-
/**
|
|
815
|
-
* The deserialization information for the current model
|
|
816
|
-
* @param CreateOrganizationRequest The instance to deserialize into.
|
|
817
|
-
* @returns {Record<string, (node: ParseNode) => void>}
|
|
818
|
-
*/
|
|
819
|
-
export declare function deserializeIntoCreateOrganizationRequest(createOrganizationRequest?: Partial<CreateOrganizationRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
820
1073
|
/**
|
|
821
1074
|
* The deserialization information for the current model
|
|
822
1075
|
* @param CreateReviewRequest The instance to deserialize into.
|
|
@@ -825,10 +1078,10 @@ export declare function deserializeIntoCreateOrganizationRequest(createOrganizat
|
|
|
825
1078
|
export declare function deserializeIntoCreateReviewRequest(createReviewRequest?: Partial<CreateReviewRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
826
1079
|
/**
|
|
827
1080
|
* The deserialization information for the current model
|
|
828
|
-
* @param
|
|
1081
|
+
* @param CreateTrialResponse The instance to deserialize into.
|
|
829
1082
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
830
1083
|
*/
|
|
831
|
-
export declare function
|
|
1084
|
+
export declare function deserializeIntoCreateTrialResponse(createTrialResponse?: Partial<CreateTrialResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
832
1085
|
/**
|
|
833
1086
|
* The deserialization information for the current model
|
|
834
1087
|
* @param Customer The instance to deserialize into.
|
|
@@ -837,34 +1090,40 @@ export declare function deserializeIntoCurrencyAmount(currencyAmount?: Partial<C
|
|
|
837
1090
|
export declare function deserializeIntoCustomer(customer?: Partial<Customer> | undefined): Record<string, (node: ParseNode) => void>;
|
|
838
1091
|
/**
|
|
839
1092
|
* The deserialization information for the current model
|
|
840
|
-
* @param
|
|
1093
|
+
* @param Customer_externalLogins The instance to deserialize into.
|
|
1094
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1095
|
+
*/
|
|
1096
|
+
export declare function deserializeIntoCustomer_externalLogins(customer_externalLogins?: Partial<Customer_externalLogins> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1097
|
+
/**
|
|
1098
|
+
* The deserialization information for the current model
|
|
1099
|
+
* @param Customer_metadata The instance to deserialize into.
|
|
841
1100
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
842
1101
|
*/
|
|
843
|
-
export declare function
|
|
1102
|
+
export declare function deserializeIntoCustomer_metadata(customer_metadata?: Partial<Customer_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
844
1103
|
/**
|
|
845
1104
|
* The deserialization information for the current model
|
|
846
|
-
* @param
|
|
1105
|
+
* @param CustomerAuthResponse The instance to deserialize into.
|
|
847
1106
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
848
1107
|
*/
|
|
849
|
-
export declare function
|
|
1108
|
+
export declare function deserializeIntoCustomerAuthResponse(customerAuthResponse?: Partial<CustomerAuthResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
850
1109
|
/**
|
|
851
1110
|
* The deserialization information for the current model
|
|
852
|
-
* @param
|
|
1111
|
+
* @param CustomerBilling The instance to deserialize into.
|
|
853
1112
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
854
1113
|
*/
|
|
855
|
-
export declare function
|
|
1114
|
+
export declare function deserializeIntoCustomerBilling(customerBilling?: Partial<CustomerBilling> | undefined): Record<string, (node: ParseNode) => void>;
|
|
856
1115
|
/**
|
|
857
1116
|
* The deserialization information for the current model
|
|
858
|
-
* @param
|
|
1117
|
+
* @param CustomerKyc The instance to deserialize into.
|
|
859
1118
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
860
1119
|
*/
|
|
861
|
-
export declare function
|
|
1120
|
+
export declare function deserializeIntoCustomerKyc(customerKyc?: Partial<CustomerKyc> | undefined): Record<string, (node: ParseNode) => void>;
|
|
862
1121
|
/**
|
|
863
1122
|
* The deserialization information for the current model
|
|
864
|
-
* @param
|
|
1123
|
+
* @param Datacenter The instance to deserialize into.
|
|
865
1124
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
866
1125
|
*/
|
|
867
|
-
export declare function
|
|
1126
|
+
export declare function deserializeIntoDatacenter(datacenter?: Partial<Datacenter> | undefined): Record<string, (node: ParseNode) => void>;
|
|
868
1127
|
/**
|
|
869
1128
|
* The deserialization information for the current model
|
|
870
1129
|
* @param ExtendOrderRequest The instance to deserialize into.
|
|
@@ -873,118 +1132,118 @@ export declare function deserializeIntoDnsCheckResponse(dnsCheckResponse?: Parti
|
|
|
873
1132
|
export declare function deserializeIntoExtendOrderRequest(extendOrderRequest?: Partial<ExtendOrderRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
874
1133
|
/**
|
|
875
1134
|
* The deserialization information for the current model
|
|
876
|
-
* @param
|
|
1135
|
+
* @param ExtendOrderResponse The instance to deserialize into.
|
|
877
1136
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
878
1137
|
*/
|
|
879
|
-
export declare function
|
|
1138
|
+
export declare function deserializeIntoExtendOrderResponse(extendOrderResponse?: Partial<ExtendOrderResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
880
1139
|
/**
|
|
881
1140
|
* The deserialization information for the current model
|
|
882
|
-
* @param
|
|
1141
|
+
* @param Incident The instance to deserialize into.
|
|
883
1142
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
884
1143
|
*/
|
|
885
|
-
export declare function
|
|
1144
|
+
export declare function deserializeIntoIncident(incident?: Partial<Incident> | undefined): Record<string, (node: ParseNode) => void>;
|
|
886
1145
|
/**
|
|
887
1146
|
* The deserialization information for the current model
|
|
888
|
-
* @param
|
|
1147
|
+
* @param Incident_metadata The instance to deserialize into.
|
|
889
1148
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
890
1149
|
*/
|
|
891
|
-
export declare function
|
|
1150
|
+
export declare function deserializeIntoIncident_metadata(incident_metadata?: Partial<Incident_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
892
1151
|
/**
|
|
893
1152
|
* The deserialization information for the current model
|
|
894
|
-
* @param
|
|
1153
|
+
* @param IpInformation The instance to deserialize into.
|
|
895
1154
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
896
1155
|
*/
|
|
897
|
-
export declare function
|
|
1156
|
+
export declare function deserializeIntoIpInformation(ipInformation?: Partial<IpInformation> | undefined): Record<string, (node: ParseNode) => void>;
|
|
898
1157
|
/**
|
|
899
1158
|
* The deserialization information for the current model
|
|
900
|
-
* @param
|
|
1159
|
+
* @param IpRotationLinkResponse The instance to deserialize into.
|
|
901
1160
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
902
1161
|
*/
|
|
903
|
-
export declare function
|
|
1162
|
+
export declare function deserializeIntoIpRotationLinkResponse(ipRotationLinkResponse?: Partial<IpRotationLinkResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
904
1163
|
/**
|
|
905
1164
|
* The deserialization information for the current model
|
|
906
|
-
* @param
|
|
1165
|
+
* @param Isp The instance to deserialize into.
|
|
907
1166
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
908
1167
|
*/
|
|
909
|
-
export declare function
|
|
1168
|
+
export declare function deserializeIntoIsp(isp?: Partial<Isp> | undefined): Record<string, (node: ParseNode) => void>;
|
|
910
1169
|
/**
|
|
911
1170
|
* The deserialization information for the current model
|
|
912
|
-
* @param
|
|
1171
|
+
* @param Location The instance to deserialize into.
|
|
913
1172
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
914
1173
|
*/
|
|
915
|
-
export declare function
|
|
1174
|
+
export declare function deserializeIntoLocation(location?: Partial<Location> | undefined): Record<string, (node: ParseNode) => void>;
|
|
916
1175
|
/**
|
|
917
1176
|
* The deserialization information for the current model
|
|
918
|
-
* @param
|
|
1177
|
+
* @param Order The instance to deserialize into.
|
|
919
1178
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
920
1179
|
*/
|
|
921
|
-
export declare function
|
|
1180
|
+
export declare function deserializeIntoOrder(order?: Partial<Order> | undefined): Record<string, (node: ParseNode) => void>;
|
|
922
1181
|
/**
|
|
923
1182
|
* The deserialization information for the current model
|
|
924
|
-
* @param
|
|
1183
|
+
* @param Order_metadata The instance to deserialize into.
|
|
925
1184
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
926
1185
|
*/
|
|
927
|
-
export declare function
|
|
1186
|
+
export declare function deserializeIntoOrder_metadata(order_metadata?: Partial<Order_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
928
1187
|
/**
|
|
929
1188
|
* The deserialization information for the current model
|
|
930
|
-
* @param
|
|
1189
|
+
* @param OrderCriteria The instance to deserialize into.
|
|
931
1190
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
932
1191
|
*/
|
|
933
|
-
export declare function
|
|
1192
|
+
export declare function deserializeIntoOrderCriteria(orderCriteria?: Partial<OrderCriteria> | undefined): Record<string, (node: ParseNode) => void>;
|
|
934
1193
|
/**
|
|
935
1194
|
* The deserialization information for the current model
|
|
936
|
-
* @param
|
|
1195
|
+
* @param OrderItem The instance to deserialize into.
|
|
937
1196
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
938
1197
|
*/
|
|
939
|
-
export declare function
|
|
1198
|
+
export declare function deserializeIntoOrderItem(orderItem?: Partial<OrderItem> | undefined): Record<string, (node: ParseNode) => void>;
|
|
940
1199
|
/**
|
|
941
1200
|
* The deserialization information for the current model
|
|
942
|
-
* @param
|
|
1201
|
+
* @param OrderItem_metadata The instance to deserialize into.
|
|
943
1202
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
944
1203
|
*/
|
|
945
|
-
export declare function
|
|
1204
|
+
export declare function deserializeIntoOrderItem_metadata(orderItem_metadata?: Partial<OrderItem_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
946
1205
|
/**
|
|
947
1206
|
* The deserialization information for the current model
|
|
948
|
-
* @param
|
|
1207
|
+
* @param PatchCustomerBillingRequest The instance to deserialize into.
|
|
949
1208
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
950
1209
|
*/
|
|
951
|
-
export declare function
|
|
1210
|
+
export declare function deserializeIntoPatchCustomerBillingRequest(patchCustomerBillingRequest?: Partial<PatchCustomerBillingRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
952
1211
|
/**
|
|
953
1212
|
* The deserialization information for the current model
|
|
954
|
-
* @param
|
|
1213
|
+
* @param PatchCustomerDefaultsRequest The instance to deserialize into.
|
|
955
1214
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
956
1215
|
*/
|
|
957
|
-
export declare function
|
|
1216
|
+
export declare function deserializeIntoPatchCustomerDefaultsRequest(patchCustomerDefaultsRequest?: Partial<PatchCustomerDefaultsRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
958
1217
|
/**
|
|
959
1218
|
* The deserialization information for the current model
|
|
960
|
-
* @param
|
|
1219
|
+
* @param PatchCustomerRequest The instance to deserialize into.
|
|
961
1220
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
962
1221
|
*/
|
|
963
|
-
export declare function
|
|
1222
|
+
export declare function deserializeIntoPatchCustomerRequest(patchCustomerRequest?: Partial<PatchCustomerRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
964
1223
|
/**
|
|
965
1224
|
* The deserialization information for the current model
|
|
966
|
-
* @param
|
|
1225
|
+
* @param PatchMetadataRequest The instance to deserialize into.
|
|
967
1226
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
968
1227
|
*/
|
|
969
|
-
export declare function
|
|
1228
|
+
export declare function deserializeIntoPatchMetadataRequest(patchMetadataRequest?: Partial<PatchMetadataRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
970
1229
|
/**
|
|
971
1230
|
* The deserialization information for the current model
|
|
972
|
-
* @param
|
|
1231
|
+
* @param PatchMetadataRequest_metadata The instance to deserialize into.
|
|
973
1232
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
974
1233
|
*/
|
|
975
|
-
export declare function
|
|
1234
|
+
export declare function deserializeIntoPatchMetadataRequest_metadata(patchMetadataRequest_metadata?: Partial<PatchMetadataRequest_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
976
1235
|
/**
|
|
977
1236
|
* The deserialization information for the current model
|
|
978
|
-
* @param
|
|
1237
|
+
* @param PatchPasswordRequest The instance to deserialize into.
|
|
979
1238
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
980
1239
|
*/
|
|
981
|
-
export declare function
|
|
1240
|
+
export declare function deserializeIntoPatchPasswordRequest(patchPasswordRequest?: Partial<PatchPasswordRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
982
1241
|
/**
|
|
983
1242
|
* The deserialization information for the current model
|
|
984
|
-
* @param
|
|
1243
|
+
* @param PatchProxyAnnotationRequest The instance to deserialize into.
|
|
985
1244
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
986
1245
|
*/
|
|
987
|
-
export declare function
|
|
1246
|
+
export declare function deserializeIntoPatchProxyAnnotationRequest(patchProxyAnnotationRequest?: Partial<PatchProxyAnnotationRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
988
1247
|
/**
|
|
989
1248
|
* The deserialization information for the current model
|
|
990
1249
|
* @param PreviewOrderRequest The instance to deserialize into.
|
|
@@ -993,10 +1252,10 @@ export declare function deserializeIntoPaymentProcessor_values(paymentProcessor_
|
|
|
993
1252
|
export declare function deserializeIntoPreviewOrderRequest(previewOrderRequest?: Partial<PreviewOrderRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
994
1253
|
/**
|
|
995
1254
|
* The deserialization information for the current model
|
|
996
|
-
* @param
|
|
1255
|
+
* @param PreviewOrderResponse The instance to deserialize into.
|
|
997
1256
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
998
1257
|
*/
|
|
999
|
-
export declare function
|
|
1258
|
+
export declare function deserializeIntoPreviewOrderResponse(previewOrderResponse?: Partial<PreviewOrderResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1000
1259
|
/**
|
|
1001
1260
|
* The deserialization information for the current model
|
|
1002
1261
|
* @param Product The instance to deserialize into.
|
|
@@ -1015,6 +1274,24 @@ export declare function deserializeIntoProxy(proxy?: Partial<Proxy> | undefined)
|
|
|
1015
1274
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1016
1275
|
*/
|
|
1017
1276
|
export declare function deserializeIntoProxyCredentialResponse(proxyCredentialResponse?: Partial<ProxyCredentialResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1277
|
+
/**
|
|
1278
|
+
* The deserialization information for the current model
|
|
1279
|
+
* @param ProxyDatacenter The instance to deserialize into.
|
|
1280
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1281
|
+
*/
|
|
1282
|
+
export declare function deserializeIntoProxyDatacenter(proxyDatacenter?: Partial<ProxyDatacenter> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1283
|
+
/**
|
|
1284
|
+
* The deserialization information for the current model
|
|
1285
|
+
* @param ProxyFeatures The instance to deserialize into.
|
|
1286
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1287
|
+
*/
|
|
1288
|
+
export declare function deserializeIntoProxyFeatures(proxyFeatures?: Partial<ProxyFeatures> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1289
|
+
/**
|
|
1290
|
+
* The deserialization information for the current model
|
|
1291
|
+
* @param ProxyIpRotationFeature The instance to deserialize into.
|
|
1292
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1293
|
+
*/
|
|
1294
|
+
export declare function deserializeIntoProxyIpRotationFeature(proxyIpRotationFeature?: Partial<ProxyIpRotationFeature> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1018
1295
|
/**
|
|
1019
1296
|
* The deserialization information for the current model
|
|
1020
1297
|
* @param ProxyIpRotationResponse The instance to deserialize into.
|
|
@@ -1023,113 +1300,151 @@ export declare function deserializeIntoProxyCredentialResponse(proxyCredentialRe
|
|
|
1023
1300
|
export declare function deserializeIntoProxyIpRotationResponse(proxyIpRotationResponse?: Partial<ProxyIpRotationResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1024
1301
|
/**
|
|
1025
1302
|
* The deserialization information for the current model
|
|
1026
|
-
* @param
|
|
1303
|
+
* @param ProxyIsp The instance to deserialize into.
|
|
1027
1304
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1028
1305
|
*/
|
|
1029
|
-
export declare function
|
|
1306
|
+
export declare function deserializeIntoProxyIsp(proxyIsp?: Partial<ProxyIsp> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1030
1307
|
/**
|
|
1031
1308
|
* The deserialization information for the current model
|
|
1032
|
-
* @param
|
|
1309
|
+
* @param ProxyLocation The instance to deserialize into.
|
|
1033
1310
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1034
1311
|
*/
|
|
1035
|
-
export declare function
|
|
1312
|
+
export declare function deserializeIntoProxyLocation(proxyLocation?: Partial<ProxyLocation> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1036
1313
|
/**
|
|
1037
1314
|
* The deserialization information for the current model
|
|
1038
|
-
* @param
|
|
1315
|
+
* @param ProxyOptions The instance to deserialize into.
|
|
1039
1316
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1040
1317
|
*/
|
|
1041
|
-
export declare function
|
|
1318
|
+
export declare function deserializeIntoProxyOptions(proxyOptions?: Partial<ProxyOptions> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1042
1319
|
/**
|
|
1043
1320
|
* The deserialization information for the current model
|
|
1044
|
-
* @param
|
|
1321
|
+
* @param ProxyOptions_metadata The instance to deserialize into.
|
|
1045
1322
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1046
1323
|
*/
|
|
1047
|
-
export declare function
|
|
1324
|
+
export declare function deserializeIntoProxyOptions_metadata(proxyOptions_metadata?: Partial<ProxyOptions_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1048
1325
|
/**
|
|
1049
1326
|
* The deserialization information for the current model
|
|
1050
|
-
* @param
|
|
1327
|
+
* @param ProxyPingResponse The instance to deserialize into.
|
|
1051
1328
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1052
1329
|
*/
|
|
1053
|
-
export declare function
|
|
1330
|
+
export declare function deserializeIntoProxyPingResponse(proxyPingResponse?: Partial<ProxyPingResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1331
|
+
/**
|
|
1332
|
+
* The deserialization information for the current model
|
|
1333
|
+
* @param ProxyProduct The instance to deserialize into.
|
|
1334
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1335
|
+
*/
|
|
1336
|
+
export declare function deserializeIntoProxyProduct(proxyProduct?: Partial<ProxyProduct> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1337
|
+
/**
|
|
1338
|
+
* The deserialization information for the current model
|
|
1339
|
+
* @param RequestDetails The instance to deserialize into.
|
|
1340
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1341
|
+
*/
|
|
1342
|
+
export declare function deserializeIntoRequestDetails(requestDetails?: Partial<RequestDetails> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1054
1343
|
/**
|
|
1055
1344
|
* The deserialization information for the current model
|
|
1056
|
-
* @param
|
|
1345
|
+
* @param ResetPasswordResponse The instance to deserialize into.
|
|
1057
1346
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1058
1347
|
*/
|
|
1059
|
-
export declare function
|
|
1348
|
+
export declare function deserializeIntoResetPasswordResponse(resetPasswordResponse?: Partial<ResetPasswordResponse> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1060
1349
|
/**
|
|
1061
1350
|
* The deserialization information for the current model
|
|
1062
|
-
* @param
|
|
1351
|
+
* @param ResolveIncidentRequest The instance to deserialize into.
|
|
1063
1352
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1064
1353
|
*/
|
|
1065
|
-
export declare function
|
|
1354
|
+
export declare function deserializeIntoResolveIncidentRequest(resolveIncidentRequest?: Partial<ResolveIncidentRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1066
1355
|
/**
|
|
1067
1356
|
* The deserialization information for the current model
|
|
1068
|
-
* @param
|
|
1357
|
+
* @param Review The instance to deserialize into.
|
|
1358
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1359
|
+
*/
|
|
1360
|
+
export declare function deserializeIntoReview(review?: Partial<Review> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1361
|
+
/**
|
|
1362
|
+
* The deserialization information for the current model
|
|
1363
|
+
* @param Review_metadata The instance to deserialize into.
|
|
1069
1364
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1070
1365
|
*/
|
|
1071
|
-
export declare function
|
|
1366
|
+
export declare function deserializeIntoReview_metadata(review_metadata?: Partial<Review_metadata> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1072
1367
|
/**
|
|
1073
1368
|
* The deserialization information for the current model
|
|
1074
|
-
* @param
|
|
1369
|
+
* @param ReviewKycRequest The instance to deserialize into.
|
|
1075
1370
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1076
1371
|
*/
|
|
1077
|
-
export declare function
|
|
1372
|
+
export declare function deserializeIntoReviewKycRequest(reviewKycRequest?: Partial<ReviewKycRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1078
1373
|
/**
|
|
1079
1374
|
* The deserialization information for the current model
|
|
1080
|
-
* @param
|
|
1375
|
+
* @param SendVerificationRequest The instance to deserialize into.
|
|
1081
1376
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1082
1377
|
*/
|
|
1083
|
-
export declare function
|
|
1378
|
+
export declare function deserializeIntoSendVerificationRequest(sendVerificationRequest?: Partial<SendVerificationRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1084
1379
|
/**
|
|
1085
1380
|
* The deserialization information for the current model
|
|
1086
|
-
* @param
|
|
1381
|
+
* @param TrialOrderRequest The instance to deserialize into.
|
|
1087
1382
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1088
1383
|
*/
|
|
1089
|
-
export declare function
|
|
1384
|
+
export declare function deserializeIntoTrialOrderRequest(trialOrderRequest?: Partial<TrialOrderRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1090
1385
|
/**
|
|
1091
1386
|
* The deserialization information for the current model
|
|
1092
|
-
* @param
|
|
1387
|
+
* @param UpdateCustomerRequest The instance to deserialize into.
|
|
1093
1388
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1094
1389
|
*/
|
|
1095
|
-
export declare function
|
|
1390
|
+
export declare function deserializeIntoUpdateCustomerRequest(updateCustomerRequest?: Partial<UpdateCustomerRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1096
1391
|
/**
|
|
1097
1392
|
* The deserialization information for the current model
|
|
1098
|
-
* @param
|
|
1393
|
+
* @param UpdateCustomerRequest_externalLogins The instance to deserialize into.
|
|
1099
1394
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1100
1395
|
*/
|
|
1101
|
-
export declare function
|
|
1396
|
+
export declare function deserializeIntoUpdateCustomerRequest_externalLogins(updateCustomerRequest_externalLogins?: Partial<UpdateCustomerRequest_externalLogins> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1102
1397
|
/**
|
|
1103
1398
|
* The deserialization information for the current model
|
|
1104
|
-
* @param
|
|
1399
|
+
* @param UpdateProxyCredentialsRequest The instance to deserialize into.
|
|
1105
1400
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1106
1401
|
*/
|
|
1107
|
-
export declare function
|
|
1402
|
+
export declare function deserializeIntoUpdateProxyCredentialsRequest(updateProxyCredentialsRequest?: Partial<UpdateProxyCredentialsRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1108
1403
|
/**
|
|
1109
1404
|
* The deserialization information for the current model
|
|
1110
1405
|
* @param UpdateProxyIpRotationRequest The instance to deserialize into.
|
|
1111
1406
|
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1112
1407
|
*/
|
|
1113
1408
|
export declare function deserializeIntoUpdateProxyIpRotationRequest(updateProxyIpRotationRequest?: Partial<UpdateProxyIpRotationRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1409
|
+
/**
|
|
1410
|
+
* The deserialization information for the current model
|
|
1411
|
+
* @param UpdateProxyOptionsRequest The instance to deserialize into.
|
|
1412
|
+
* @returns {Record<string, (node: ParseNode) => void>}
|
|
1413
|
+
*/
|
|
1414
|
+
export declare function deserializeIntoUpdateProxyOptionsRequest(updateProxyOptionsRequest?: Partial<UpdateProxyOptionsRequest> | undefined): Record<string, (node: ParseNode) => void>;
|
|
1415
|
+
/**
|
|
1416
|
+
* Renews an existing order for another billing cycle, optionally on different terms.
|
|
1417
|
+
*/
|
|
1120
1418
|
export interface ExtendOrderRequest extends AdditionalDataHolder, Parsable {
|
|
1121
1419
|
/**
|
|
1122
1420
|
* The billingCycle property
|
|
1123
1421
|
*/
|
|
1124
|
-
billingCycle?:
|
|
1422
|
+
billingCycle?: BillingCycles | null;
|
|
1125
1423
|
/**
|
|
1126
1424
|
* The paymentMethod property
|
|
1127
1425
|
*/
|
|
1128
|
-
paymentMethod?:
|
|
1426
|
+
paymentMethod?: PaymentMethods | null;
|
|
1427
|
+
}
|
|
1428
|
+
/**
|
|
1429
|
+
* The extended order: its id, and the checkout URL to follow when a hosted payment is needed.
|
|
1430
|
+
*/
|
|
1431
|
+
export interface ExtendOrderResponse extends AdditionalDataHolder, Parsable {
|
|
1432
|
+
/**
|
|
1433
|
+
* Unique order identifier.
|
|
1434
|
+
*/
|
|
1435
|
+
orderId?: Guid | null;
|
|
1436
|
+
/**
|
|
1437
|
+
* Checkout URL the caller should send the customer to, or null when none is needed.
|
|
1438
|
+
*/
|
|
1439
|
+
returnUrl?: string | null;
|
|
1129
1440
|
}
|
|
1441
|
+
export type GracePeriodPolicies = (typeof GracePeriodPoliciesObject)[keyof typeof GracePeriodPoliciesObject];
|
|
1442
|
+
/**
|
|
1443
|
+
* A complaint reported about a proxy (or other resource), usually by a customer. string Incident.Target andstring Incident.ReporterEmail are free-form strings until they are linked to their own entities.
|
|
1444
|
+
*/
|
|
1130
1445
|
export interface Incident extends AdditionalDataHolder, Parsable {
|
|
1131
1446
|
/**
|
|
1132
|
-
*
|
|
1447
|
+
* Full text of the complaint, null when none was provided.
|
|
1133
1448
|
*/
|
|
1134
1449
|
description?: string | null;
|
|
1135
1450
|
/**
|
|
@@ -1137,692 +1452,842 @@ export interface Incident extends AdditionalDataHolder, Parsable {
|
|
|
1137
1452
|
*/
|
|
1138
1453
|
id?: Guid | null;
|
|
1139
1454
|
/**
|
|
1140
|
-
*
|
|
1455
|
+
* True when the incident is still open and was created more than TimeSpan Incident.DefaultOverdueAfter ago.
|
|
1456
|
+
*/
|
|
1457
|
+
isOverdue?: boolean | null;
|
|
1458
|
+
/**
|
|
1459
|
+
* The metadata property
|
|
1141
1460
|
*/
|
|
1142
|
-
|
|
1461
|
+
metadata?: Incident_metadata | null;
|
|
1143
1462
|
/**
|
|
1144
|
-
*
|
|
1463
|
+
* Why the target went down, picked from the predefined reasons when the incident is resolved.
|
|
1145
1464
|
*/
|
|
1146
|
-
|
|
1465
|
+
reason?: string | null;
|
|
1147
1466
|
/**
|
|
1148
|
-
*
|
|
1467
|
+
* Email of the customer who reported the incident.
|
|
1149
1468
|
*/
|
|
1150
1469
|
reporterEmail?: string | null;
|
|
1151
1470
|
/**
|
|
1152
|
-
*
|
|
1471
|
+
* Message written for the customer at resolution, surfaced to them (e.g. by email) later.
|
|
1153
1472
|
*/
|
|
1154
1473
|
resolutionNote?: string | null;
|
|
1155
1474
|
/**
|
|
1156
|
-
*
|
|
1475
|
+
* When the incident was resolved, null while it is still open.
|
|
1157
1476
|
*/
|
|
1158
1477
|
resolvedAt?: Date | null;
|
|
1159
1478
|
/**
|
|
1160
|
-
*
|
|
1479
|
+
* Lifecycle state of the incident (open, resolved, etc.).
|
|
1161
1480
|
*/
|
|
1162
1481
|
status?: IncidentStatuses | null;
|
|
1163
1482
|
/**
|
|
1164
|
-
*
|
|
1483
|
+
* Short one-line title of the complaint.
|
|
1165
1484
|
*/
|
|
1166
1485
|
subject?: string | null;
|
|
1167
1486
|
/**
|
|
1168
|
-
*
|
|
1487
|
+
* Identifier of the affected proxy (hostname:port).
|
|
1169
1488
|
*/
|
|
1170
1489
|
target?: string | null;
|
|
1171
1490
|
}
|
|
1491
|
+
export interface Incident_metadata extends AdditionalDataHolder, Parsable {
|
|
1492
|
+
}
|
|
1172
1493
|
export type IncidentStatuses = (typeof IncidentStatusesObject)[keyof typeof IncidentStatusesObject];
|
|
1173
|
-
export interface
|
|
1174
|
-
/**
|
|
1175
|
-
* The availableProxies property
|
|
1176
|
-
*/
|
|
1177
|
-
availableProxies?: number | null;
|
|
1494
|
+
export interface IpInformation extends AdditionalDataHolder, Parsable {
|
|
1178
1495
|
/**
|
|
1179
|
-
* The
|
|
1496
|
+
* The asn property
|
|
1180
1497
|
*/
|
|
1181
|
-
|
|
1498
|
+
asn?: string | null;
|
|
1182
1499
|
/**
|
|
1183
|
-
* The
|
|
1500
|
+
* The asnDomain property
|
|
1184
1501
|
*/
|
|
1185
|
-
|
|
1502
|
+
asnDomain?: string | null;
|
|
1186
1503
|
/**
|
|
1187
|
-
* The
|
|
1504
|
+
* The asnLogo property
|
|
1188
1505
|
*/
|
|
1189
|
-
|
|
1506
|
+
asnLogo?: string | null;
|
|
1190
1507
|
/**
|
|
1191
|
-
* The
|
|
1508
|
+
* The continent property
|
|
1192
1509
|
*/
|
|
1193
|
-
|
|
1510
|
+
continent?: string | null;
|
|
1194
1511
|
/**
|
|
1195
|
-
* The
|
|
1512
|
+
* The continentCode property
|
|
1196
1513
|
*/
|
|
1197
|
-
|
|
1514
|
+
continentCode?: string | null;
|
|
1198
1515
|
/**
|
|
1199
|
-
* The
|
|
1516
|
+
* The country property
|
|
1200
1517
|
*/
|
|
1201
|
-
|
|
1202
|
-
}
|
|
1203
|
-
export interface Location extends AdditionalDataHolder, Parsable {
|
|
1518
|
+
country?: string | null;
|
|
1204
1519
|
/**
|
|
1205
|
-
* The
|
|
1520
|
+
* The countryCode property
|
|
1206
1521
|
*/
|
|
1207
|
-
|
|
1522
|
+
countryCode?: string | null;
|
|
1208
1523
|
/**
|
|
1209
|
-
* The
|
|
1524
|
+
* The countryFlag property
|
|
1210
1525
|
*/
|
|
1211
|
-
|
|
1526
|
+
countryFlag?: string | null;
|
|
1212
1527
|
/**
|
|
1213
|
-
* The
|
|
1528
|
+
* The countryFlagUrl property
|
|
1214
1529
|
*/
|
|
1215
|
-
|
|
1530
|
+
countryFlagUrl?: string | null;
|
|
1216
1531
|
/**
|
|
1217
|
-
* The
|
|
1532
|
+
* The currencyCode property
|
|
1218
1533
|
*/
|
|
1219
|
-
|
|
1534
|
+
currencyCode?: string | null;
|
|
1220
1535
|
/**
|
|
1221
|
-
* The
|
|
1536
|
+
* The currencySymbol property
|
|
1222
1537
|
*/
|
|
1223
|
-
|
|
1538
|
+
currencySymbol?: string | null;
|
|
1224
1539
|
/**
|
|
1225
|
-
* The
|
|
1540
|
+
* The ipAddress property
|
|
1226
1541
|
*/
|
|
1227
|
-
|
|
1542
|
+
ipAddress?: string | null;
|
|
1228
1543
|
/**
|
|
1229
|
-
* The
|
|
1544
|
+
* The isAnycast property
|
|
1230
1545
|
*/
|
|
1231
|
-
|
|
1546
|
+
isAnycast?: boolean | null;
|
|
1232
1547
|
/**
|
|
1233
|
-
* The
|
|
1548
|
+
* The isp property
|
|
1234
1549
|
*/
|
|
1235
|
-
|
|
1550
|
+
isp?: string | null;
|
|
1236
1551
|
}
|
|
1237
|
-
|
|
1238
|
-
|
|
1552
|
+
/**
|
|
1553
|
+
* A self-contained IP rotation link for a proxy: the raw token plus the ready-to-use link.
|
|
1554
|
+
*/
|
|
1555
|
+
export interface IpRotationLinkResponse extends AdditionalDataHolder, Parsable {
|
|
1239
1556
|
/**
|
|
1240
|
-
* The
|
|
1557
|
+
* The IP rotation link served on the organization's IP rotation domain (its own, or the default).
|
|
1241
1558
|
*/
|
|
1242
|
-
|
|
1559
|
+
link?: string | null;
|
|
1243
1560
|
/**
|
|
1244
|
-
* The
|
|
1561
|
+
* The IP rotation token (a protected customer id). Use it to build your own link if needed.
|
|
1245
1562
|
*/
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1563
|
+
token?: string | null;
|
|
1564
|
+
}
|
|
1565
|
+
/**
|
|
1566
|
+
* Internet service provider a proxy routes through.
|
|
1567
|
+
*/
|
|
1568
|
+
export interface Isp extends AdditionalDataHolder, Parsable {
|
|
1251
1569
|
/**
|
|
1252
|
-
*
|
|
1570
|
+
* Count of proxies currently available (active and unallocated) behind this option.
|
|
1253
1571
|
*/
|
|
1254
|
-
|
|
1572
|
+
availableProxies?: number | null;
|
|
1255
1573
|
/**
|
|
1256
|
-
*
|
|
1574
|
+
* Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
|
|
1257
1575
|
*/
|
|
1258
|
-
|
|
1259
|
-
}
|
|
1260
|
-
export interface MembersResponse extends AdditionalDataHolder, Parsable {
|
|
1576
|
+
basePrice?: number | null;
|
|
1261
1577
|
/**
|
|
1262
|
-
*
|
|
1578
|
+
* Unique identifier of the catalog option.
|
|
1263
1579
|
*/
|
|
1264
|
-
|
|
1265
|
-
}
|
|
1266
|
-
export type NullableOfBillingCycles = (typeof NullableOfBillingCyclesObject)[keyof typeof NullableOfBillingCyclesObject];
|
|
1267
|
-
export type NullableOfPaymentMethods = (typeof NullableOfPaymentMethodsObject)[keyof typeof NullableOfPaymentMethodsObject];
|
|
1268
|
-
export interface Order extends AdditionalDataHolder, Parsable {
|
|
1580
|
+
id?: Guid | null;
|
|
1269
1581
|
/**
|
|
1270
|
-
*
|
|
1582
|
+
* Whether the current organization has hidden this option from its storefront.
|
|
1271
1583
|
*/
|
|
1272
|
-
|
|
1584
|
+
isDisabled?: boolean | null;
|
|
1273
1585
|
/**
|
|
1274
|
-
*
|
|
1586
|
+
* Absolute URL of the ISP logo, null when none is set.
|
|
1275
1587
|
*/
|
|
1276
|
-
|
|
1588
|
+
logoUrl?: string | null;
|
|
1277
1589
|
/**
|
|
1278
|
-
*
|
|
1590
|
+
* Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
|
|
1279
1591
|
*/
|
|
1280
|
-
|
|
1592
|
+
name?: string | null;
|
|
1281
1593
|
/**
|
|
1282
|
-
*
|
|
1594
|
+
* Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
|
|
1283
1595
|
*/
|
|
1284
|
-
|
|
1596
|
+
price?: number | null;
|
|
1285
1597
|
/**
|
|
1286
|
-
*
|
|
1598
|
+
* Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
|
|
1287
1599
|
*/
|
|
1288
|
-
|
|
1600
|
+
retailPrice?: number | null;
|
|
1601
|
+
}
|
|
1602
|
+
/**
|
|
1603
|
+
* A geographic location available in the catalog, granular to a city or a country.
|
|
1604
|
+
*/
|
|
1605
|
+
export interface Location extends AdditionalDataHolder, Parsable {
|
|
1289
1606
|
/**
|
|
1290
|
-
*
|
|
1607
|
+
* Number of ISPs that cover this location.
|
|
1291
1608
|
*/
|
|
1292
|
-
|
|
1609
|
+
availableIsps?: number | null;
|
|
1293
1610
|
/**
|
|
1294
|
-
*
|
|
1611
|
+
* Count of proxies currently available (active and unallocated) behind this option.
|
|
1295
1612
|
*/
|
|
1296
|
-
|
|
1613
|
+
availableProxies?: number | null;
|
|
1297
1614
|
/**
|
|
1298
|
-
*
|
|
1615
|
+
* Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
|
|
1299
1616
|
*/
|
|
1300
|
-
|
|
1617
|
+
basePrice?: number | null;
|
|
1301
1618
|
/**
|
|
1302
|
-
*
|
|
1619
|
+
* Name of the city, null when the location is country or region granular.
|
|
1303
1620
|
*/
|
|
1304
|
-
|
|
1621
|
+
city?: string | null;
|
|
1305
1622
|
/**
|
|
1306
|
-
*
|
|
1623
|
+
* ISO 3166-1 alpha-2 country code of the location.
|
|
1307
1624
|
*/
|
|
1308
|
-
|
|
1625
|
+
countryCode?: string | null;
|
|
1309
1626
|
/**
|
|
1310
|
-
*
|
|
1627
|
+
* Unique identifier of the catalog option.
|
|
1311
1628
|
*/
|
|
1312
|
-
|
|
1629
|
+
id?: Guid | null;
|
|
1313
1630
|
/**
|
|
1314
|
-
*
|
|
1631
|
+
* Whether the current organization has hidden this option from its storefront.
|
|
1315
1632
|
*/
|
|
1316
|
-
|
|
1633
|
+
isDisabled?: boolean | null;
|
|
1317
1634
|
/**
|
|
1318
|
-
*
|
|
1635
|
+
* Display name of the location: the city when city-granular, otherwise the country code.
|
|
1319
1636
|
*/
|
|
1320
|
-
|
|
1637
|
+
name?: string | null;
|
|
1321
1638
|
/**
|
|
1322
|
-
*
|
|
1639
|
+
* Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
|
|
1323
1640
|
*/
|
|
1324
|
-
|
|
1641
|
+
price?: number | null;
|
|
1325
1642
|
/**
|
|
1326
|
-
*
|
|
1643
|
+
* Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
|
|
1327
1644
|
*/
|
|
1328
|
-
|
|
1645
|
+
retailPrice?: number | null;
|
|
1329
1646
|
}
|
|
1330
|
-
|
|
1647
|
+
/**
|
|
1648
|
+
* An order placed by an organization, owning its lifecycle: the products it holds (its ICollection<OrderItem> Order.Items),its expiry and its payment link. Live status (active, grace, expired) is computed from DateTimeOffset? Order.ExpiresAtand the organization's grace policy rather than stored.
|
|
1649
|
+
*/
|
|
1650
|
+
export interface Order extends AdditionalDataHolder, Parsable {
|
|
1331
1651
|
/**
|
|
1332
|
-
* The
|
|
1652
|
+
* The billingCycle property
|
|
1333
1653
|
*/
|
|
1334
|
-
|
|
1654
|
+
billingCycle?: BillingCycles | null;
|
|
1335
1655
|
/**
|
|
1336
|
-
*
|
|
1656
|
+
* Organization's own end user the order belongs to, if any.
|
|
1337
1657
|
*/
|
|
1338
|
-
|
|
1658
|
+
customerId?: Guid | null;
|
|
1339
1659
|
/**
|
|
1340
|
-
*
|
|
1660
|
+
* When the order expires. Persisted so the status can be computed from it without a background worker.
|
|
1341
1661
|
*/
|
|
1342
|
-
|
|
1662
|
+
expiresAt?: Date | null;
|
|
1343
1663
|
/**
|
|
1344
|
-
* The
|
|
1664
|
+
* The caller's own reference for this order, unique within its organization when set. Makes creation idempotent: a retry with the same reference returns this order instead of placing a duplicate.
|
|
1345
1665
|
*/
|
|
1346
|
-
|
|
1666
|
+
externalReference?: string | null;
|
|
1347
1667
|
/**
|
|
1348
|
-
* The
|
|
1668
|
+
* The id property
|
|
1349
1669
|
*/
|
|
1350
|
-
|
|
1670
|
+
id?: Guid | null;
|
|
1351
1671
|
/**
|
|
1352
|
-
*
|
|
1672
|
+
* Why the order was placed: wholesale (the organization buying for itself, on our platform account) or retail (reselling to its own customer, on its connected account). Persisted so later actions — cancellation, refund — resolve the same Stripe account the order settled on, instead of re-deriving it from the request.
|
|
1353
1673
|
*/
|
|
1354
|
-
|
|
1674
|
+
intent?: OrderIntents | null;
|
|
1355
1675
|
/**
|
|
1356
|
-
*
|
|
1676
|
+
* Whether the order is still live and holding its proxies: Active, or in its post-expiry grace window. Every other state (pending, provisioning, expired, deleted) does not.
|
|
1357
1677
|
*/
|
|
1358
|
-
|
|
1359
|
-
}
|
|
1360
|
-
export interface OrderRequirements extends AdditionalDataHolder, Parsable {
|
|
1678
|
+
isActive?: boolean | null;
|
|
1361
1679
|
/**
|
|
1362
|
-
*
|
|
1680
|
+
* Recurring subscription (true) or one-shot payment (false). Does not drive expiry: it sets what the customer is told and lets reconciliation skip one-shot orders.
|
|
1363
1681
|
*/
|
|
1364
|
-
|
|
1682
|
+
isAutoRenew?: boolean | null;
|
|
1365
1683
|
/**
|
|
1366
|
-
*
|
|
1684
|
+
* Whether the order needs attention soon: in its grace period, or expiring within a week. An auto-renewing order is never flagged, as it renews itself rather than lapsing, and neither is a trial, which is meant to expire.
|
|
1367
1685
|
*/
|
|
1368
|
-
|
|
1369
|
-
}
|
|
1370
|
-
export type OrderStatuses = (typeof OrderStatusesObject)[keyof typeof OrderStatusesObject];
|
|
1371
|
-
export interface Organization extends AdditionalDataHolder, Parsable {
|
|
1686
|
+
isExpiringSoon?: boolean | null;
|
|
1372
1687
|
/**
|
|
1373
|
-
* The
|
|
1688
|
+
* Whether the order no longer holds its proxies, having handed them back to the stock for a new order: once it is Expired or Deleted. The counterpart of bool Order.IsActive for stock; a never-provisioned order (Pending, Provisioning) sits between the two and frees nothing.
|
|
1374
1689
|
*/
|
|
1375
|
-
|
|
1690
|
+
isInactive?: boolean | null;
|
|
1376
1691
|
/**
|
|
1377
|
-
*
|
|
1692
|
+
* Whether the order is a trial.
|
|
1378
1693
|
*/
|
|
1379
|
-
|
|
1694
|
+
isTrial?: boolean | null;
|
|
1380
1695
|
/**
|
|
1381
|
-
*
|
|
1696
|
+
* Line items the order is made of, one per product bought. Each item carries its product, quantity and the resources delivered for it.
|
|
1382
1697
|
*/
|
|
1383
|
-
|
|
1698
|
+
items?: OrderItem[] | null;
|
|
1384
1699
|
/**
|
|
1385
|
-
*
|
|
1700
|
+
* Reference of the last settlement already applied to this order, provider-prefixed (e.g. `stripe:in_...`, `nowpayments:...`). Webhooks are delivered at least once, so a renewal that carries this same reference has already been applied and is skipped, keeping a redelivered payment from adding a cycle twice. Provider-agnostic so it covers every settlement source, current and future.
|
|
1386
1701
|
*/
|
|
1387
|
-
|
|
1702
|
+
lastSettlementReference?: string | null;
|
|
1388
1703
|
/**
|
|
1389
|
-
* The
|
|
1704
|
+
* The `BalanceTransaction` that last paid this order from the organization's balance (its creation or its most recent extension). Lets a refund credit back exactly that payment without re-deriving its amount. Null for orders paid through a processor (Stripe, crypto) or for trials.
|
|
1390
1705
|
*/
|
|
1391
|
-
|
|
1706
|
+
lastTransactionId?: Guid | null;
|
|
1392
1707
|
/**
|
|
1393
|
-
* The
|
|
1708
|
+
* The metadata property
|
|
1394
1709
|
*/
|
|
1395
|
-
|
|
1710
|
+
metadata?: Order_metadata | null;
|
|
1396
1711
|
/**
|
|
1397
|
-
* The
|
|
1712
|
+
* The paymentMethod property
|
|
1398
1713
|
*/
|
|
1399
|
-
|
|
1714
|
+
paymentMethod?: PaymentMethods | null;
|
|
1400
1715
|
/**
|
|
1401
|
-
* The
|
|
1716
|
+
* The paymentProcessor property
|
|
1402
1717
|
*/
|
|
1403
|
-
|
|
1718
|
+
paymentProcessor?: PaymentProcessors | null;
|
|
1404
1719
|
/**
|
|
1405
|
-
*
|
|
1720
|
+
* Opaque handle at the processor (a Stripe `sub_...` or `pi_...`, a Heleket reference).
|
|
1406
1721
|
*/
|
|
1407
|
-
|
|
1722
|
+
processorReference?: string | null;
|
|
1408
1723
|
/**
|
|
1409
|
-
*
|
|
1724
|
+
* Total units ordered, summed over the items' quantities and not stored. Requires ICollection<OrderItem> Order.Items to be loaded.
|
|
1410
1725
|
*/
|
|
1411
|
-
|
|
1726
|
+
quantity?: number | null;
|
|
1412
1727
|
/**
|
|
1413
|
-
* The
|
|
1728
|
+
* Commercial state of the order. Stored as the source of truth for states that aren't derivable from the dates (`Provisioning`, `Expired` once a worker confirms it, and later cancellations or holds). The transient `GracePeriod` is layered on at read time by `ResolveStatus` from DateTimeOffset? Order.ExpiresAt and the organization's grace policy. Defaults to `Pending` (nothing paid or set up yet); each flow sets the real state through the transition helpers.
|
|
1414
1729
|
*/
|
|
1415
|
-
|
|
1730
|
+
status?: OrderStatuses | null;
|
|
1731
|
+
}
|
|
1732
|
+
export interface Order_metadata extends AdditionalDataHolder, Parsable {
|
|
1733
|
+
}
|
|
1734
|
+
/**
|
|
1735
|
+
* Everything that narrows a product's price and stock: the order-cascade selection (Location → ISP → Datacenter),the required capabilities, and the billing cycle and payment method. Shared by the catalog facets and theorder flow. A null dimension widens the scope; it carries no validation itself. Callers enforce the chain(a level requires all its parents) with the catalog's chain guards.
|
|
1736
|
+
*/
|
|
1737
|
+
export interface OrderCriteria extends AdditionalDataHolder, Parsable {
|
|
1416
1738
|
/**
|
|
1417
|
-
* The
|
|
1739
|
+
* The billingCycle property
|
|
1418
1740
|
*/
|
|
1419
|
-
|
|
1741
|
+
billingCycle?: BillingCycles | null;
|
|
1420
1742
|
/**
|
|
1421
|
-
*
|
|
1743
|
+
* Capabilities the product must provide to match.
|
|
1422
1744
|
*/
|
|
1423
|
-
|
|
1745
|
+
capabilities?: CapabilityTypes[] | null;
|
|
1424
1746
|
/**
|
|
1425
|
-
*
|
|
1747
|
+
* ISO 3166-1 alpha-2 country code of the selected location, resolved from Guid? OrderCriteria.LocationId so a country-level price row can match. Null until resolved.
|
|
1426
1748
|
*/
|
|
1427
|
-
|
|
1749
|
+
countryCode?: string | null;
|
|
1428
1750
|
/**
|
|
1429
|
-
*
|
|
1751
|
+
* Identifier of the selected datacenter in the order cascade.
|
|
1430
1752
|
*/
|
|
1431
|
-
|
|
1432
|
-
}
|
|
1433
|
-
export interface OrganizationBilling extends AdditionalDataHolder, Parsable {
|
|
1753
|
+
datacenterId?: Guid | null;
|
|
1434
1754
|
/**
|
|
1435
|
-
*
|
|
1755
|
+
* Identifier of the selected ISP in the order cascade.
|
|
1436
1756
|
*/
|
|
1437
|
-
|
|
1757
|
+
ispId?: Guid | null;
|
|
1438
1758
|
/**
|
|
1439
|
-
*
|
|
1759
|
+
* Identifier of the selected location in the order cascade.
|
|
1440
1760
|
*/
|
|
1441
|
-
|
|
1761
|
+
locationId?: Guid | null;
|
|
1442
1762
|
/**
|
|
1443
|
-
* The
|
|
1763
|
+
* The paymentMethod property
|
|
1444
1764
|
*/
|
|
1445
|
-
|
|
1765
|
+
paymentMethod?: PaymentMethods | null;
|
|
1446
1766
|
/**
|
|
1447
|
-
*
|
|
1767
|
+
* Identifier of the product being priced or ordered.
|
|
1448
1768
|
*/
|
|
1449
|
-
|
|
1769
|
+
productId?: Guid | null;
|
|
1770
|
+
}
|
|
1771
|
+
export type OrderIntents = (typeof OrderIntentsObject)[keyof typeof OrderIntentsObject];
|
|
1772
|
+
/**
|
|
1773
|
+
* One line of an Order? OrderItem.Order: a product bought in a given quantity, with the resources delivered for it.
|
|
1774
|
+
*/
|
|
1775
|
+
export interface OrderItem extends AdditionalDataHolder, Parsable {
|
|
1450
1776
|
/**
|
|
1451
|
-
* The
|
|
1777
|
+
* The id property
|
|
1452
1778
|
*/
|
|
1453
|
-
|
|
1779
|
+
id?: Guid | null;
|
|
1454
1780
|
/**
|
|
1455
|
-
*
|
|
1781
|
+
* Kind of resource this line's product delivers (proxy or host).
|
|
1456
1782
|
*/
|
|
1457
|
-
|
|
1783
|
+
kind?: ProductKinds | null;
|
|
1784
|
+
/**
|
|
1785
|
+
* The metadata property
|
|
1786
|
+
*/
|
|
1787
|
+
metadata?: OrderItem_metadata | null;
|
|
1788
|
+
/**
|
|
1789
|
+
* Identifier of the product this line orders.
|
|
1790
|
+
*/
|
|
1791
|
+
productId?: Guid | null;
|
|
1792
|
+
/**
|
|
1793
|
+
* Identifiers of the resources delivered for this line (proxy ids today), resolved against the cached stock. Null until the order is placed and its resources are provisioned.
|
|
1794
|
+
*/
|
|
1795
|
+
resourceIds?: Guid[] | null;
|
|
1458
1796
|
}
|
|
1459
|
-
export interface
|
|
1797
|
+
export interface OrderItem_metadata extends AdditionalDataHolder, Parsable {
|
|
1798
|
+
}
|
|
1799
|
+
export type OrderStatuses = (typeof OrderStatusesObject)[keyof typeof OrderStatusesObject];
|
|
1800
|
+
export type PasswordHashSchemes = (typeof PasswordHashSchemesObject)[keyof typeof PasswordHashSchemesObject];
|
|
1801
|
+
/**
|
|
1802
|
+
* Partial update of a customer's billing details: only the provided fields are changed, the rest are left as they are.
|
|
1803
|
+
*/
|
|
1804
|
+
export interface PatchCustomerBillingRequest extends AdditionalDataHolder, Parsable {
|
|
1460
1805
|
/**
|
|
1461
|
-
*
|
|
1806
|
+
* Street address (line 1). Null leaves it unchanged.
|
|
1462
1807
|
*/
|
|
1463
1808
|
addressLine?: string | null;
|
|
1464
1809
|
/**
|
|
1465
|
-
*
|
|
1810
|
+
* City. Null leaves it unchanged.
|
|
1466
1811
|
*/
|
|
1467
1812
|
city?: string | null;
|
|
1468
1813
|
/**
|
|
1469
|
-
* The
|
|
1814
|
+
* The company's legal name. Null leaves it unchanged.
|
|
1815
|
+
*/
|
|
1816
|
+
companyName?: string | null;
|
|
1817
|
+
/**
|
|
1818
|
+
* Country (ISO 3166-1 alpha-2 code or name). Null leaves it unchanged.
|
|
1470
1819
|
*/
|
|
1471
1820
|
country?: string | null;
|
|
1472
1821
|
/**
|
|
1473
|
-
*
|
|
1822
|
+
* Whether the customer is billed as a company (B2B) rather than an individual. Null leaves it unchanged.
|
|
1474
1823
|
*/
|
|
1475
|
-
|
|
1824
|
+
isCompany?: boolean | null;
|
|
1476
1825
|
/**
|
|
1477
|
-
*
|
|
1826
|
+
* Postal or ZIP code. Null leaves it unchanged.
|
|
1478
1827
|
*/
|
|
1479
1828
|
postalCode?: string | null;
|
|
1480
1829
|
/**
|
|
1481
|
-
*
|
|
1830
|
+
* Company registration number, distinct from the tax id. Null leaves it unchanged.
|
|
1831
|
+
*/
|
|
1832
|
+
registrationNumber?: string | null;
|
|
1833
|
+
/**
|
|
1834
|
+
* VAT or tax identification number. Null leaves it unchanged.
|
|
1482
1835
|
*/
|
|
1483
1836
|
taxId?: string | null;
|
|
1484
1837
|
}
|
|
1485
|
-
|
|
1838
|
+
/**
|
|
1839
|
+
* Sets a customer's default allowed IPs and domains for its proxies. Each list is replaced wholesale with what's provided (an empty list clears it).
|
|
1840
|
+
*/
|
|
1841
|
+
export interface PatchCustomerDefaultsRequest extends AdditionalDataHolder, Parsable {
|
|
1486
1842
|
/**
|
|
1487
|
-
*
|
|
1843
|
+
* Domains the customer's proxies authorize by default (`*` allows all).
|
|
1488
1844
|
*/
|
|
1489
|
-
|
|
1845
|
+
allowedDomains?: string[] | null;
|
|
1490
1846
|
/**
|
|
1491
|
-
*
|
|
1847
|
+
* IP addresses the customer's proxies authorize by default.
|
|
1492
1848
|
*/
|
|
1493
|
-
|
|
1849
|
+
allowedIps?: string[] | null;
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* Partial update of a customer: only the provided fields are changed.
|
|
1853
|
+
*/
|
|
1854
|
+
export interface PatchCustomerRequest extends AdditionalDataHolder, Parsable {
|
|
1494
1855
|
/**
|
|
1495
|
-
*
|
|
1856
|
+
* When set, suspends (false) or reinstates (true) the customer.
|
|
1496
1857
|
*/
|
|
1497
|
-
|
|
1858
|
+
isActive?: boolean | null;
|
|
1859
|
+
}
|
|
1860
|
+
/**
|
|
1861
|
+
* Merge-patch of an entity's metadata (RFC 7386 semantics): a present key sets or overwrites its value, a null value removes the key, and any key not listed is left unchanged.
|
|
1862
|
+
*/
|
|
1863
|
+
export interface PatchMetadataRequest extends AdditionalDataHolder, Parsable {
|
|
1498
1864
|
/**
|
|
1499
|
-
*
|
|
1865
|
+
* Metadata keys to merge: a non-null value is written (overwriting any existing one) and a null value removes the key.
|
|
1500
1866
|
*/
|
|
1501
|
-
|
|
1867
|
+
metadata?: PatchMetadataRequest_metadata | null;
|
|
1868
|
+
}
|
|
1869
|
+
/**
|
|
1870
|
+
* Metadata keys to merge: a non-null value is written (overwriting any existing one) and a null value removes the key.
|
|
1871
|
+
*/
|
|
1872
|
+
export interface PatchMetadataRequest_metadata extends AdditionalDataHolder, Parsable {
|
|
1873
|
+
}
|
|
1874
|
+
/**
|
|
1875
|
+
* Sets a customer's password to a new value.
|
|
1876
|
+
*/
|
|
1877
|
+
export interface PatchPasswordRequest extends AdditionalDataHolder, Parsable {
|
|
1502
1878
|
/**
|
|
1503
|
-
* The
|
|
1879
|
+
* The new plaintext password. Stored hashed, never returned.
|
|
1504
1880
|
*/
|
|
1505
|
-
|
|
1881
|
+
password?: string | null;
|
|
1506
1882
|
}
|
|
1507
|
-
|
|
1883
|
+
/**
|
|
1884
|
+
* Patch of an organization's annotation of a proxy: its free-form note and its tags. A null field is left unchanged; an empty string clears the note and an empty array clears the tags.
|
|
1885
|
+
*/
|
|
1886
|
+
export interface PatchProxyAnnotationRequest extends AdditionalDataHolder, Parsable {
|
|
1887
|
+
/**
|
|
1888
|
+
* The free-form note. Null leaves it unchanged; an empty string clears it.
|
|
1889
|
+
*/
|
|
1890
|
+
note?: string | null;
|
|
1508
1891
|
/**
|
|
1509
|
-
* The
|
|
1892
|
+
* The tags. Null leaves them unchanged; an empty array clears them.
|
|
1510
1893
|
*/
|
|
1511
|
-
|
|
1894
|
+
tags?: string[] | null;
|
|
1895
|
+
}
|
|
1896
|
+
export type PaymentMethods = (typeof PaymentMethodsObject)[keyof typeof PaymentMethodsObject];
|
|
1897
|
+
export type PaymentProcessors = (typeof PaymentProcessorsObject)[keyof typeof PaymentProcessorsObject];
|
|
1898
|
+
/**
|
|
1899
|
+
* Payload to preview an order's price for a given selection, before placing it.
|
|
1900
|
+
*/
|
|
1901
|
+
export interface PreviewOrderRequest extends AdditionalDataHolder, Parsable {
|
|
1512
1902
|
/**
|
|
1513
|
-
*
|
|
1903
|
+
* Priced selection the order is placed against.
|
|
1514
1904
|
*/
|
|
1515
|
-
|
|
1905
|
+
criteria?: OrderCriteria | null;
|
|
1516
1906
|
/**
|
|
1517
|
-
* The
|
|
1907
|
+
* The organization's end customer this order is for. Required for a retail order (it bills that customer on the organization's connected account); must be null for wholesale (the organization itself is billed).
|
|
1518
1908
|
*/
|
|
1519
|
-
|
|
1909
|
+
customerId?: Guid | null;
|
|
1520
1910
|
/**
|
|
1521
|
-
* The
|
|
1911
|
+
* The intent property
|
|
1522
1912
|
*/
|
|
1523
|
-
|
|
1913
|
+
intent?: OrderIntents | null;
|
|
1524
1914
|
/**
|
|
1525
|
-
*
|
|
1915
|
+
* Number of units to order. Defaults to 1.
|
|
1526
1916
|
*/
|
|
1527
|
-
|
|
1917
|
+
quantity?: number | null;
|
|
1528
1918
|
}
|
|
1529
|
-
|
|
1919
|
+
/**
|
|
1920
|
+
* The computed price for an order selection, before it is placed.
|
|
1921
|
+
*/
|
|
1922
|
+
export interface PreviewOrderResponse extends AdditionalDataHolder, Parsable {
|
|
1530
1923
|
/**
|
|
1531
|
-
*
|
|
1924
|
+
* How many proxies are available for the selection right now.
|
|
1532
1925
|
*/
|
|
1533
|
-
|
|
1926
|
+
availableProxies?: number | null;
|
|
1534
1927
|
/**
|
|
1535
|
-
*
|
|
1928
|
+
* ISO 4217 currency code the amounts are expressed in.
|
|
1536
1929
|
*/
|
|
1537
|
-
|
|
1930
|
+
currency?: string | null;
|
|
1538
1931
|
/**
|
|
1539
|
-
*
|
|
1932
|
+
* Amount saved versus paying monthly for the same duration. Null when there is no saving.
|
|
1540
1933
|
*/
|
|
1541
|
-
|
|
1934
|
+
discount?: number | null;
|
|
1542
1935
|
/**
|
|
1543
|
-
*
|
|
1936
|
+
* Saving as a percentage of the monthly-rate total, from 0 to 100. Null when there is no saving.
|
|
1544
1937
|
*/
|
|
1545
|
-
|
|
1938
|
+
discountPercent?: number | null;
|
|
1546
1939
|
/**
|
|
1547
|
-
*
|
|
1940
|
+
* Number of units in the selection.
|
|
1548
1941
|
*/
|
|
1549
|
-
|
|
1550
|
-
}
|
|
1551
|
-
export interface OrganizationInfrastructure extends AdditionalDataHolder, Parsable {
|
|
1942
|
+
quantity?: number | null;
|
|
1552
1943
|
/**
|
|
1553
|
-
*
|
|
1944
|
+
* Unit price multiplied by quantity, before any future discounts.
|
|
1554
1945
|
*/
|
|
1555
|
-
|
|
1556
|
-
}
|
|
1557
|
-
export interface OrganizationInfrastructure2 extends AdditionalDataHolder, Parsable {
|
|
1946
|
+
subtotal?: number | null;
|
|
1558
1947
|
/**
|
|
1559
|
-
*
|
|
1948
|
+
* Final amount to charge (equals subtotal until discounts exist).
|
|
1560
1949
|
*/
|
|
1561
|
-
|
|
1950
|
+
total?: number | null;
|
|
1951
|
+
/**
|
|
1952
|
+
* Resolved price for a single unit.
|
|
1953
|
+
*/
|
|
1954
|
+
unitPrice?: number | null;
|
|
1562
1955
|
}
|
|
1563
|
-
export
|
|
1956
|
+
export type PricingTypes = (typeof PricingTypesObject)[keyof typeof PricingTypesObject];
|
|
1957
|
+
/**
|
|
1958
|
+
* A catalog product: the shared catalog-option shape (id, stock, price, availability) plus the product's own metadata. Internal shape (operating modes, price rows, granularity) stays on the `Entities.Product` entity.
|
|
1959
|
+
*/
|
|
1960
|
+
export interface Product extends AdditionalDataHolder, Parsable {
|
|
1564
1961
|
/**
|
|
1565
|
-
*
|
|
1962
|
+
* Count of proxies currently available (active and unallocated) behind this option.
|
|
1566
1963
|
*/
|
|
1567
|
-
|
|
1964
|
+
availableProxies?: number | null;
|
|
1568
1965
|
/**
|
|
1569
|
-
*
|
|
1966
|
+
* Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
|
|
1570
1967
|
*/
|
|
1571
|
-
|
|
1968
|
+
basePrice?: number | null;
|
|
1572
1969
|
/**
|
|
1573
|
-
*
|
|
1970
|
+
* Short marketing description of the product shown in the catalog.
|
|
1574
1971
|
*/
|
|
1575
|
-
|
|
1972
|
+
description?: string | null;
|
|
1576
1973
|
/**
|
|
1577
|
-
*
|
|
1974
|
+
* Unique identifier of the catalog option.
|
|
1578
1975
|
*/
|
|
1579
|
-
|
|
1976
|
+
id?: Guid | null;
|
|
1580
1977
|
/**
|
|
1581
|
-
*
|
|
1978
|
+
* Whether the current organization has hidden this option from its storefront.
|
|
1582
1979
|
*/
|
|
1583
|
-
|
|
1584
|
-
}
|
|
1585
|
-
export type OrganizationTypes = (typeof OrganizationTypesObject)[keyof typeof OrganizationTypesObject];
|
|
1586
|
-
export type PaymentMethods = (typeof PaymentMethodsObject)[keyof typeof PaymentMethodsObject];
|
|
1587
|
-
export interface PaymentProcessor extends AdditionalDataHolder, Parsable {
|
|
1980
|
+
isDisabled?: boolean | null;
|
|
1588
1981
|
/**
|
|
1589
|
-
*
|
|
1982
|
+
* Kind of resource this product delivers (proxy, host).
|
|
1590
1983
|
*/
|
|
1591
|
-
|
|
1984
|
+
kind?: ProductKinds | null;
|
|
1592
1985
|
/**
|
|
1593
|
-
*
|
|
1986
|
+
* Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
|
|
1594
1987
|
*/
|
|
1595
|
-
|
|
1988
|
+
name?: string | null;
|
|
1596
1989
|
/**
|
|
1597
|
-
*
|
|
1990
|
+
* Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
|
|
1598
1991
|
*/
|
|
1599
|
-
|
|
1992
|
+
price?: number | null;
|
|
1600
1993
|
/**
|
|
1601
|
-
*
|
|
1994
|
+
* How the product is billed.
|
|
1602
1995
|
*/
|
|
1603
|
-
|
|
1996
|
+
pricingType?: PricingTypes | null;
|
|
1604
1997
|
/**
|
|
1605
|
-
*
|
|
1998
|
+
* Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
|
|
1606
1999
|
*/
|
|
1607
|
-
|
|
2000
|
+
retailPrice?: number | null;
|
|
2001
|
+
}
|
|
2002
|
+
export type ProductKinds = (typeof ProductKindsObject)[keyof typeof ProductKindsObject];
|
|
2003
|
+
/**
|
|
2004
|
+
* Connection details for a proxy an organization owns (one of its allocations).
|
|
2005
|
+
*/
|
|
2006
|
+
export interface Proxy extends AdditionalDataHolder, Parsable {
|
|
1608
2007
|
/**
|
|
1609
|
-
* The
|
|
2008
|
+
* The optional capabilities the proxy exposes (e.g. IPv6, IP scoring).
|
|
1610
2009
|
*/
|
|
1611
|
-
|
|
2010
|
+
capabilities?: CapabilityTypes[] | null;
|
|
1612
2011
|
/**
|
|
1613
|
-
* The
|
|
2012
|
+
* The datacenter property
|
|
1614
2013
|
*/
|
|
1615
|
-
|
|
1616
|
-
}
|
|
1617
|
-
export interface PaymentProcessor_values extends AdditionalDataHolder, Parsable {
|
|
1618
|
-
}
|
|
1619
|
-
export type PaymentProcessors = (typeof PaymentProcessorsObject)[keyof typeof PaymentProcessorsObject];
|
|
1620
|
-
export interface PreviewOrderRequest extends AdditionalDataHolder, Parsable {
|
|
2014
|
+
datacenter?: ProxyDatacenter | null;
|
|
1621
2015
|
/**
|
|
1622
|
-
* The
|
|
2016
|
+
* The optional features configured on the proxy (IP rotation, ...).
|
|
1623
2017
|
*/
|
|
1624
|
-
|
|
2018
|
+
features?: ProxyFeatures | null;
|
|
1625
2019
|
/**
|
|
1626
|
-
*
|
|
2020
|
+
* Hostname to connect to, with the reseller-facing datacenter label (e.g. `fr3.acme.com`).
|
|
1627
2021
|
*/
|
|
1628
|
-
|
|
2022
|
+
host?: string | null;
|
|
1629
2023
|
/**
|
|
1630
|
-
*
|
|
2024
|
+
* Identifier of the proxy.
|
|
1631
2025
|
*/
|
|
1632
|
-
|
|
2026
|
+
id?: Guid | null;
|
|
1633
2027
|
/**
|
|
1634
|
-
*
|
|
2028
|
+
* Resolved IP address.
|
|
1635
2029
|
*/
|
|
1636
|
-
|
|
2030
|
+
ip?: string | null;
|
|
1637
2031
|
/**
|
|
1638
|
-
* The
|
|
2032
|
+
* The isp property
|
|
1639
2033
|
*/
|
|
1640
|
-
|
|
2034
|
+
isp?: ProxyIsp | null;
|
|
1641
2035
|
/**
|
|
1642
|
-
* The
|
|
2036
|
+
* The location property
|
|
1643
2037
|
*/
|
|
1644
|
-
|
|
1645
|
-
}
|
|
1646
|
-
export type PricingTypes = (typeof PricingTypesObject)[keyof typeof PricingTypesObject];
|
|
1647
|
-
export interface ProcessorFieldSchema extends AdditionalDataHolder, Parsable {
|
|
2038
|
+
location?: ProxyLocation | null;
|
|
1648
2039
|
/**
|
|
1649
|
-
* The
|
|
2040
|
+
* The organization's free-form note for this proxy, when it has annotated it.
|
|
1650
2041
|
*/
|
|
1651
|
-
|
|
2042
|
+
note?: string | null;
|
|
1652
2043
|
/**
|
|
1653
|
-
*
|
|
2044
|
+
* Connection port.
|
|
1654
2045
|
*/
|
|
1655
|
-
|
|
2046
|
+
port?: number | null;
|
|
1656
2047
|
/**
|
|
1657
|
-
* The
|
|
2048
|
+
* The product property
|
|
1658
2049
|
*/
|
|
1659
|
-
|
|
2050
|
+
product?: ProxyProduct | null;
|
|
1660
2051
|
/**
|
|
1661
|
-
* The
|
|
2052
|
+
* The organization's tags for this proxy (empty when none).
|
|
1662
2053
|
*/
|
|
1663
|
-
|
|
2054
|
+
tags?: string[] | null;
|
|
2055
|
+
}
|
|
2056
|
+
/**
|
|
2057
|
+
* The credentials in effect on a proxy: the username and password to authenticate with, the IPs and domainsallowed to use it, and when they were applied. Stored in and read from Vault.
|
|
2058
|
+
*/
|
|
2059
|
+
export interface ProxyCredentialResponse extends AdditionalDataHolder, Parsable {
|
|
2060
|
+
/**
|
|
2061
|
+
* Domains the proxy is permitted to reach. Empty when no domain allowlist applies.
|
|
2062
|
+
*/
|
|
2063
|
+
allowedDomains?: string[] | null;
|
|
1664
2064
|
/**
|
|
1665
|
-
*
|
|
2065
|
+
* IP addresses allowed to connect through the proxy. Empty when access is not restricted by IP.
|
|
1666
2066
|
*/
|
|
1667
|
-
|
|
2067
|
+
allowedIps?: string[] | null;
|
|
1668
2068
|
/**
|
|
1669
|
-
*
|
|
2069
|
+
* Instant these credentials were applied to the proxy in Vault.
|
|
1670
2070
|
*/
|
|
1671
|
-
|
|
2071
|
+
appliedAt?: Date | null;
|
|
2072
|
+
/**
|
|
2073
|
+
* Password used to authenticate against the proxy. Null when no credentials are stored yet.
|
|
2074
|
+
*/
|
|
2075
|
+
password?: string | null;
|
|
2076
|
+
/**
|
|
2077
|
+
* Username used to authenticate against the proxy. Null when no credentials are stored yet.
|
|
2078
|
+
*/
|
|
2079
|
+
username?: string | null;
|
|
1672
2080
|
}
|
|
1673
|
-
|
|
2081
|
+
/**
|
|
2082
|
+
* The datacenter a proxy lives in.
|
|
2083
|
+
*/
|
|
2084
|
+
export interface ProxyDatacenter extends AdditionalDataHolder, Parsable {
|
|
1674
2085
|
/**
|
|
1675
|
-
*
|
|
2086
|
+
* Identifier of the datacenter, to refetch or reorder it.
|
|
1676
2087
|
*/
|
|
1677
|
-
|
|
2088
|
+
id?: Guid | null;
|
|
1678
2089
|
/**
|
|
1679
|
-
*
|
|
2090
|
+
* Name of the datacenter, when known.
|
|
1680
2091
|
*/
|
|
1681
|
-
|
|
2092
|
+
name?: string | null;
|
|
2093
|
+
}
|
|
2094
|
+
/**
|
|
2095
|
+
* The optional features configured on a proxy. A feature is null when it isn't active.
|
|
2096
|
+
*/
|
|
2097
|
+
export interface ProxyFeatures extends AdditionalDataHolder, Parsable {
|
|
1682
2098
|
/**
|
|
1683
|
-
* The
|
|
2099
|
+
* The ipRotation property
|
|
1684
2100
|
*/
|
|
1685
|
-
|
|
2101
|
+
ipRotation?: ProxyIpRotationFeature | null;
|
|
2102
|
+
}
|
|
2103
|
+
/**
|
|
2104
|
+
* An active IP-rotation schedule on a proxy.
|
|
2105
|
+
*/
|
|
2106
|
+
export interface ProxyIpRotationFeature extends AdditionalDataHolder, Parsable {
|
|
1686
2107
|
/**
|
|
1687
|
-
*
|
|
2108
|
+
* Rotation interval in whole minutes.
|
|
1688
2109
|
*/
|
|
1689
|
-
|
|
2110
|
+
intervalMinutes?: number | null;
|
|
1690
2111
|
/**
|
|
1691
|
-
*
|
|
2112
|
+
* Rotation interval in whole seconds.
|
|
1692
2113
|
*/
|
|
1693
|
-
|
|
2114
|
+
intervalSeconds?: number | null;
|
|
2115
|
+
}
|
|
2116
|
+
/**
|
|
2117
|
+
* The IP rotation configured on a proxy: how often its IP rotates, in seconds and whole minutes. Fetched livefrom the Manager; a 404 means no rotation is configured.
|
|
2118
|
+
*/
|
|
2119
|
+
export interface ProxyIpRotationResponse extends AdditionalDataHolder, Parsable {
|
|
1694
2120
|
/**
|
|
1695
|
-
*
|
|
2121
|
+
* Interval between IP rotations, in whole minutes.
|
|
1696
2122
|
*/
|
|
1697
|
-
|
|
2123
|
+
intervalMinutes?: number | null;
|
|
1698
2124
|
/**
|
|
1699
|
-
*
|
|
2125
|
+
* Interval between IP rotations, in seconds.
|
|
1700
2126
|
*/
|
|
1701
|
-
|
|
2127
|
+
intervalSeconds?: number | null;
|
|
2128
|
+
}
|
|
2129
|
+
/**
|
|
2130
|
+
* A proxy's ISP.
|
|
2131
|
+
*/
|
|
2132
|
+
export interface ProxyIsp extends AdditionalDataHolder, Parsable {
|
|
1702
2133
|
/**
|
|
1703
|
-
*
|
|
2134
|
+
* Identifier of the ISP, to refetch or reorder it.
|
|
1704
2135
|
*/
|
|
1705
|
-
|
|
2136
|
+
id?: Guid | null;
|
|
1706
2137
|
/**
|
|
1707
|
-
*
|
|
2138
|
+
* Logo URL of the ISP, when known.
|
|
1708
2139
|
*/
|
|
1709
|
-
|
|
2140
|
+
logoUrl?: string | null;
|
|
2141
|
+
/**
|
|
2142
|
+
* Name of the ISP, when known.
|
|
2143
|
+
*/
|
|
2144
|
+
name?: string | null;
|
|
1710
2145
|
}
|
|
1711
|
-
|
|
2146
|
+
/**
|
|
2147
|
+
* Where a proxy is located.
|
|
2148
|
+
*/
|
|
2149
|
+
export interface ProxyLocation extends AdditionalDataHolder, Parsable {
|
|
1712
2150
|
/**
|
|
1713
|
-
*
|
|
2151
|
+
* City, when known.
|
|
1714
2152
|
*/
|
|
1715
2153
|
city?: string | null;
|
|
1716
2154
|
/**
|
|
1717
|
-
*
|
|
2155
|
+
* ISO 3166-1 alpha-2 country code (e.g. `FR`), when known.
|
|
1718
2156
|
*/
|
|
1719
2157
|
countryCode?: string | null;
|
|
1720
2158
|
/**
|
|
1721
|
-
*
|
|
2159
|
+
* Identifier of the location, to refetch or reorder it.
|
|
1722
2160
|
*/
|
|
1723
|
-
|
|
2161
|
+
id?: Guid | null;
|
|
2162
|
+
}
|
|
2163
|
+
/**
|
|
2164
|
+
* Feature options for an inventory proxy: settings toggled on the proxy, such as the resolution mode. There is noproxy table (proxies live in the Manager), so this references the proxy by id only; at most one options row perproxy. Options that need a capability are only valid on a proxy exposing it.
|
|
2165
|
+
*/
|
|
2166
|
+
export interface ProxyOptions extends AdditionalDataHolder, Parsable {
|
|
1724
2167
|
/**
|
|
1725
2168
|
* The id property
|
|
1726
2169
|
*/
|
|
1727
|
-
id?:
|
|
2170
|
+
id?: Guid | null;
|
|
1728
2171
|
/**
|
|
1729
|
-
* The
|
|
2172
|
+
* The metadata property
|
|
1730
2173
|
*/
|
|
1731
|
-
|
|
2174
|
+
metadata?: ProxyOptions_metadata | null;
|
|
1732
2175
|
/**
|
|
1733
|
-
* The
|
|
2176
|
+
* The inventory proxy these options are about. No foreign key: proxies aren't stored locally.
|
|
1734
2177
|
*/
|
|
1735
|
-
|
|
2178
|
+
proxyId?: Guid | null;
|
|
1736
2179
|
/**
|
|
1737
|
-
* The
|
|
2180
|
+
* How the proxy resolves addresses. The non-default modes need the proxy's IPv6 capability.
|
|
1738
2181
|
*/
|
|
1739
|
-
|
|
2182
|
+
resolutionMode?: ResolutionModes | null;
|
|
2183
|
+
}
|
|
2184
|
+
export interface ProxyOptions_metadata extends AdditionalDataHolder, Parsable {
|
|
2185
|
+
}
|
|
2186
|
+
/**
|
|
2187
|
+
* The result of testing a proxy through a real request: whether it answered, the round-trip latency, the HTTP status the request came back with, and the exit IP the proxy routed through.
|
|
2188
|
+
*/
|
|
2189
|
+
export interface ProxyPingResponse extends AdditionalDataHolder, Parsable {
|
|
1740
2190
|
/**
|
|
1741
|
-
* The
|
|
2191
|
+
* The public IP the proxy routed the request through, as reported by the reach target; null when unreachable or the target didn't return one.
|
|
1742
2192
|
*/
|
|
1743
|
-
|
|
2193
|
+
exitIp?: string | null;
|
|
1744
2194
|
/**
|
|
1745
|
-
*
|
|
2195
|
+
* Round-trip latency in milliseconds when reachable; null otherwise.
|
|
1746
2196
|
*/
|
|
1747
|
-
|
|
2197
|
+
latencyMilliseconds?: number | null;
|
|
1748
2198
|
/**
|
|
1749
|
-
*
|
|
2199
|
+
* Whether the proxy answered the request.
|
|
1750
2200
|
*/
|
|
1751
|
-
|
|
2201
|
+
reachable?: boolean | null;
|
|
1752
2202
|
/**
|
|
1753
|
-
* The
|
|
2203
|
+
* The HTTP status code the request came back with; null when the proxy couldn't be reached.
|
|
1754
2204
|
*/
|
|
1755
|
-
|
|
2205
|
+
statusCode?: number | null;
|
|
2206
|
+
}
|
|
2207
|
+
/**
|
|
2208
|
+
* The catalog product a proxy was ordered as: the head of the cascade down to location, ISP and datacenter.
|
|
2209
|
+
*/
|
|
2210
|
+
export interface ProxyProduct extends AdditionalDataHolder, Parsable {
|
|
1756
2211
|
/**
|
|
1757
|
-
*
|
|
2212
|
+
* Identifier of the product, to refetch or reorder it.
|
|
1758
2213
|
*/
|
|
1759
|
-
|
|
1760
|
-
}
|
|
1761
|
-
export interface ProxyCredentialResponse extends AdditionalDataHolder, Parsable {
|
|
2214
|
+
id?: Guid | null;
|
|
1762
2215
|
/**
|
|
1763
|
-
*
|
|
2216
|
+
* Kind of resource the product delivers (proxy, host).
|
|
1764
2217
|
*/
|
|
1765
|
-
|
|
2218
|
+
kind?: ProductKinds | null;
|
|
2219
|
+
/**
|
|
2220
|
+
* Name of the product.
|
|
2221
|
+
*/
|
|
2222
|
+
name?: string | null;
|
|
2223
|
+
}
|
|
2224
|
+
export interface RequestDetails extends AdditionalDataHolder, Parsable {
|
|
1766
2225
|
/**
|
|
1767
|
-
* The
|
|
2226
|
+
* The clientIp property
|
|
1768
2227
|
*/
|
|
1769
|
-
|
|
2228
|
+
clientIp?: string | null;
|
|
1770
2229
|
/**
|
|
1771
|
-
* The
|
|
2230
|
+
* The correlationId property
|
|
1772
2231
|
*/
|
|
1773
|
-
|
|
2232
|
+
correlationId?: string | null;
|
|
1774
2233
|
/**
|
|
1775
|
-
* The
|
|
2234
|
+
* The date property
|
|
1776
2235
|
*/
|
|
1777
|
-
|
|
2236
|
+
date?: Date | null;
|
|
1778
2237
|
/**
|
|
1779
|
-
* The
|
|
2238
|
+
* The endpoint property
|
|
1780
2239
|
*/
|
|
1781
|
-
|
|
1782
|
-
}
|
|
1783
|
-
export interface ProxyIpRotationResponse extends AdditionalDataHolder, Parsable {
|
|
2240
|
+
endpoint?: string | null;
|
|
1784
2241
|
/**
|
|
1785
|
-
* The
|
|
2242
|
+
* The timestamp property
|
|
1786
2243
|
*/
|
|
1787
|
-
|
|
2244
|
+
timestamp?: number | null;
|
|
1788
2245
|
/**
|
|
1789
|
-
* The
|
|
2246
|
+
* The userAgent property
|
|
1790
2247
|
*/
|
|
1791
|
-
|
|
2248
|
+
userAgent?: string | null;
|
|
1792
2249
|
}
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
exitIp?: string | null;
|
|
2250
|
+
/**
|
|
2251
|
+
* The result of resetting a customer's password: the generated temporary password, also emailed to the customer.
|
|
2252
|
+
*/
|
|
2253
|
+
export interface ResetPasswordResponse extends AdditionalDataHolder, Parsable {
|
|
1798
2254
|
/**
|
|
1799
|
-
* The
|
|
2255
|
+
* The generated temporary password the customer can sign in with.
|
|
1800
2256
|
*/
|
|
1801
|
-
|
|
2257
|
+
temporaryPassword?: string | null;
|
|
2258
|
+
}
|
|
2259
|
+
export type ResolutionModes = (typeof ResolutionModesObject)[keyof typeof ResolutionModesObject];
|
|
2260
|
+
/**
|
|
2261
|
+
* Payload to resolve an open incident on a target.
|
|
2262
|
+
*/
|
|
2263
|
+
export interface ResolveIncidentRequest extends AdditionalDataHolder, Parsable {
|
|
1802
2264
|
/**
|
|
1803
|
-
*
|
|
2265
|
+
* Predefined reason the target went down.
|
|
1804
2266
|
*/
|
|
1805
|
-
|
|
2267
|
+
reason?: string | null;
|
|
1806
2268
|
/**
|
|
1807
|
-
*
|
|
2269
|
+
* Note for the customer, stored on the incident and shown to them later. Null when no note is provided.
|
|
1808
2270
|
*/
|
|
1809
|
-
|
|
2271
|
+
resolutionNote?: string | null;
|
|
1810
2272
|
}
|
|
2273
|
+
/**
|
|
2274
|
+
* A review left by one of an organization's customers: review text plus a star rating, owned by and scoped tothe Organization? Review.Organization. Tied to a known Customer? Review.Customer via Guid? Review.CustomerId when thereis one, otherwise left anonymous with a string? Review.CustomAuthorName.
|
|
2275
|
+
*/
|
|
1811
2276
|
export interface Review extends AdditionalDataHolder, Parsable {
|
|
1812
2277
|
/**
|
|
1813
|
-
* The
|
|
2278
|
+
* The name to show for the reviewer: the explicit string? Review.CustomAuthorName if set, otherwise the linked customer's display name or email, falling back to "Anonymous". Requires the customer to be loaded (see the reads that `Include` it).
|
|
1814
2279
|
*/
|
|
1815
2280
|
authorName?: string | null;
|
|
1816
2281
|
/**
|
|
1817
|
-
* The
|
|
2282
|
+
* The review text.
|
|
1818
2283
|
*/
|
|
1819
2284
|
content?: string | null;
|
|
1820
2285
|
/**
|
|
1821
|
-
*
|
|
2286
|
+
* Display name for the reviewer when no customer is tied to the review, or an override of the linked customer's name. Null falls back to the Customer? Review.Customer's name.
|
|
1822
2287
|
*/
|
|
1823
2288
|
customAuthorName?: string | null;
|
|
1824
2289
|
/**
|
|
1825
|
-
*
|
|
2290
|
+
* Id of the customer who left the review when it is tied to a known one, or null for anonymous reviews.
|
|
1826
2291
|
*/
|
|
1827
2292
|
customerId?: Guid | null;
|
|
1828
2293
|
/**
|
|
@@ -1830,84 +2295,112 @@ export interface Review extends AdditionalDataHolder, Parsable {
|
|
|
1830
2295
|
*/
|
|
1831
2296
|
id?: Guid | null;
|
|
1832
2297
|
/**
|
|
1833
|
-
*
|
|
2298
|
+
* Whether the review is highlighted (e.g. pinned on a landing page). Defaults to false.
|
|
1834
2299
|
*/
|
|
1835
2300
|
isFeatured?: boolean | null;
|
|
1836
2301
|
/**
|
|
1837
|
-
*
|
|
2302
|
+
* Whether the review awaits moderation: true until approved, and only non-pending reviews show publicly (rejecting one deletes it).
|
|
1838
2303
|
*/
|
|
1839
2304
|
isPending?: boolean | null;
|
|
1840
2305
|
/**
|
|
1841
|
-
* The
|
|
2306
|
+
* The metadata property
|
|
1842
2307
|
*/
|
|
1843
|
-
|
|
2308
|
+
metadata?: Review_metadata | null;
|
|
1844
2309
|
/**
|
|
1845
|
-
* The rating
|
|
2310
|
+
* The star rating, from 1 to 5.
|
|
1846
2311
|
*/
|
|
1847
2312
|
rating?: number | null;
|
|
1848
2313
|
}
|
|
2314
|
+
export interface Review_metadata extends AdditionalDataHolder, Parsable {
|
|
2315
|
+
}
|
|
2316
|
+
/**
|
|
2317
|
+
* An admin's review decision on a customer's submitted KYC.
|
|
2318
|
+
*/
|
|
1849
2319
|
export interface ReviewKycRequest extends AdditionalDataHolder, Parsable {
|
|
1850
2320
|
/**
|
|
1851
|
-
*
|
|
2321
|
+
* Whether the KYC is approved (true) or rejected (false).
|
|
1852
2322
|
*/
|
|
1853
2323
|
approved?: boolean | null;
|
|
1854
2324
|
}
|
|
2325
|
+
/**
|
|
2326
|
+
* Request to send a customer an email verification link. The reseller hosts the page that reads the appended token and confirms it against the verify-email endpoint.
|
|
2327
|
+
*/
|
|
2328
|
+
export interface SendVerificationRequest extends AdditionalDataHolder, Parsable {
|
|
2329
|
+
/**
|
|
2330
|
+
* The reseller page the verification link points at; the token is appended as a query parameter.
|
|
2331
|
+
*/
|
|
2332
|
+
verificationUrl?: string | null;
|
|
2333
|
+
}
|
|
1855
2334
|
/**
|
|
1856
2335
|
* Serializes information the current object
|
|
1857
|
-
* @param
|
|
2336
|
+
* @param Announcement The instance to serialize from.
|
|
1858
2337
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1859
2338
|
* @param writer Serialization writer to use to serialize this model
|
|
1860
2339
|
*/
|
|
1861
|
-
export declare function
|
|
2340
|
+
export declare function serializeAnnouncement(writer: SerializationWriter, announcement?: Partial<Announcement> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1862
2341
|
/**
|
|
1863
2342
|
* Serializes information the current object
|
|
1864
|
-
* @param
|
|
2343
|
+
* @param Announcement_metadata The instance to serialize from.
|
|
1865
2344
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1866
2345
|
* @param writer Serialization writer to use to serialize this model
|
|
1867
2346
|
*/
|
|
1868
|
-
export declare function
|
|
2347
|
+
export declare function serializeAnnouncement_metadata(writer: SerializationWriter, announcement_metadata?: Partial<Announcement_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1869
2348
|
/**
|
|
1870
2349
|
* Serializes information the current object
|
|
1871
|
-
* @param
|
|
2350
|
+
* @param ApiError The instance to serialize from.
|
|
1872
2351
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1873
2352
|
* @param writer Serialization writer to use to serialize this model
|
|
1874
2353
|
*/
|
|
1875
|
-
export declare function
|
|
2354
|
+
export declare function serializeApiError(writer: SerializationWriter, apiError?: Partial<ApiError> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1876
2355
|
/**
|
|
1877
2356
|
* Serializes information the current object
|
|
1878
|
-
* @param
|
|
2357
|
+
* @param ApiResponse The instance to serialize from.
|
|
1879
2358
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1880
2359
|
* @param writer Serialization writer to use to serialize this model
|
|
1881
2360
|
*/
|
|
1882
|
-
export declare function
|
|
2361
|
+
export declare function serializeApiResponse(writer: SerializationWriter, apiResponse?: Partial<ApiResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1883
2362
|
/**
|
|
1884
2363
|
* Serializes information the current object
|
|
1885
|
-
* @param
|
|
2364
|
+
* @param AuthenticateCustomerOAuthRequest The instance to serialize from.
|
|
1886
2365
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1887
2366
|
* @param writer Serialization writer to use to serialize this model
|
|
1888
2367
|
*/
|
|
1889
|
-
export declare function
|
|
2368
|
+
export declare function serializeAuthenticateCustomerOAuthRequest(writer: SerializationWriter, authenticateCustomerOAuthRequest?: Partial<AuthenticateCustomerOAuthRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1890
2369
|
/**
|
|
1891
2370
|
* Serializes information the current object
|
|
1892
|
-
* @param
|
|
2371
|
+
* @param AuthenticateCustomerRequest The instance to serialize from.
|
|
1893
2372
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1894
2373
|
* @param writer Serialization writer to use to serialize this model
|
|
1895
2374
|
*/
|
|
1896
|
-
export declare function
|
|
2375
|
+
export declare function serializeAuthenticateCustomerRequest(writer: SerializationWriter, authenticateCustomerRequest?: Partial<AuthenticateCustomerRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2376
|
+
/**
|
|
2377
|
+
* Serializes information the current object
|
|
2378
|
+
* @param AuthenticateCustomerTelegramRequest The instance to serialize from.
|
|
2379
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2380
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2381
|
+
*/
|
|
2382
|
+
export declare function serializeAuthenticateCustomerTelegramRequest(writer: SerializationWriter, authenticateCustomerTelegramRequest?: Partial<AuthenticateCustomerTelegramRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2383
|
+
/**
|
|
2384
|
+
* Serializes information the current object
|
|
2385
|
+
* @param CancelOrderRequest The instance to serialize from.
|
|
2386
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2387
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2388
|
+
*/
|
|
2389
|
+
export declare function serializeCancelOrderRequest(writer: SerializationWriter, cancelOrderRequest?: Partial<CancelOrderRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1897
2390
|
/**
|
|
1898
2391
|
* Serializes information the current object
|
|
1899
|
-
* @param
|
|
2392
|
+
* @param Capability The instance to serialize from.
|
|
1900
2393
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1901
2394
|
* @param writer Serialization writer to use to serialize this model
|
|
1902
2395
|
*/
|
|
1903
|
-
export declare function
|
|
2396
|
+
export declare function serializeCapability(writer: SerializationWriter, capability?: Partial<Capability> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1904
2397
|
/**
|
|
1905
2398
|
* Serializes information the current object
|
|
1906
|
-
* @param
|
|
2399
|
+
* @param CreateCustomerRequest The instance to serialize from.
|
|
1907
2400
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1908
2401
|
* @param writer Serialization writer to use to serialize this model
|
|
1909
2402
|
*/
|
|
1910
|
-
export declare function
|
|
2403
|
+
export declare function serializeCreateCustomerRequest(writer: SerializationWriter, createCustomerRequest?: Partial<CreateCustomerRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1911
2404
|
/**
|
|
1912
2405
|
* Serializes information the current object
|
|
1913
2406
|
* @param CreateIncidentRequest The instance to serialize from.
|
|
@@ -1931,67 +2424,67 @@ export declare function serializeCreateOrderRequest(writer: SerializationWriter,
|
|
|
1931
2424
|
export declare function serializeCreateOrderResponse(writer: SerializationWriter, createOrderResponse?: Partial<CreateOrderResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1932
2425
|
/**
|
|
1933
2426
|
* Serializes information the current object
|
|
1934
|
-
* @param
|
|
2427
|
+
* @param CreateReviewRequest The instance to serialize from.
|
|
1935
2428
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1936
2429
|
* @param writer Serialization writer to use to serialize this model
|
|
1937
2430
|
*/
|
|
1938
|
-
export declare function
|
|
2431
|
+
export declare function serializeCreateReviewRequest(writer: SerializationWriter, createReviewRequest?: Partial<CreateReviewRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1939
2432
|
/**
|
|
1940
2433
|
* Serializes information the current object
|
|
1941
|
-
* @param
|
|
2434
|
+
* @param CreateTrialResponse The instance to serialize from.
|
|
1942
2435
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1943
2436
|
* @param writer Serialization writer to use to serialize this model
|
|
1944
2437
|
*/
|
|
1945
|
-
export declare function
|
|
2438
|
+
export declare function serializeCreateTrialResponse(writer: SerializationWriter, createTrialResponse?: Partial<CreateTrialResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1946
2439
|
/**
|
|
1947
2440
|
* Serializes information the current object
|
|
1948
|
-
* @param
|
|
2441
|
+
* @param Customer The instance to serialize from.
|
|
1949
2442
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1950
2443
|
* @param writer Serialization writer to use to serialize this model
|
|
1951
2444
|
*/
|
|
1952
|
-
export declare function
|
|
2445
|
+
export declare function serializeCustomer(writer: SerializationWriter, customer?: Partial<Customer> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1953
2446
|
/**
|
|
1954
2447
|
* Serializes information the current object
|
|
1955
|
-
* @param
|
|
2448
|
+
* @param Customer_externalLogins The instance to serialize from.
|
|
1956
2449
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1957
2450
|
* @param writer Serialization writer to use to serialize this model
|
|
1958
2451
|
*/
|
|
1959
|
-
export declare function
|
|
2452
|
+
export declare function serializeCustomer_externalLogins(writer: SerializationWriter, customer_externalLogins?: Partial<Customer_externalLogins> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1960
2453
|
/**
|
|
1961
2454
|
* Serializes information the current object
|
|
1962
|
-
* @param
|
|
2455
|
+
* @param Customer_metadata The instance to serialize from.
|
|
1963
2456
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1964
2457
|
* @param writer Serialization writer to use to serialize this model
|
|
1965
2458
|
*/
|
|
1966
|
-
export declare function
|
|
2459
|
+
export declare function serializeCustomer_metadata(writer: SerializationWriter, customer_metadata?: Partial<Customer_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1967
2460
|
/**
|
|
1968
2461
|
* Serializes information the current object
|
|
1969
|
-
* @param
|
|
2462
|
+
* @param CustomerAuthResponse The instance to serialize from.
|
|
1970
2463
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1971
2464
|
* @param writer Serialization writer to use to serialize this model
|
|
1972
2465
|
*/
|
|
1973
|
-
export declare function
|
|
2466
|
+
export declare function serializeCustomerAuthResponse(writer: SerializationWriter, customerAuthResponse?: Partial<CustomerAuthResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1974
2467
|
/**
|
|
1975
2468
|
* Serializes information the current object
|
|
1976
|
-
* @param
|
|
2469
|
+
* @param CustomerBilling The instance to serialize from.
|
|
1977
2470
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1978
2471
|
* @param writer Serialization writer to use to serialize this model
|
|
1979
2472
|
*/
|
|
1980
|
-
export declare function
|
|
2473
|
+
export declare function serializeCustomerBilling(writer: SerializationWriter, customerBilling?: Partial<CustomerBilling> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1981
2474
|
/**
|
|
1982
2475
|
* Serializes information the current object
|
|
1983
|
-
* @param
|
|
2476
|
+
* @param CustomerKyc The instance to serialize from.
|
|
1984
2477
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1985
2478
|
* @param writer Serialization writer to use to serialize this model
|
|
1986
2479
|
*/
|
|
1987
|
-
export declare function
|
|
2480
|
+
export declare function serializeCustomerKyc(writer: SerializationWriter, customerKyc?: Partial<CustomerKyc> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1988
2481
|
/**
|
|
1989
2482
|
* Serializes information the current object
|
|
1990
|
-
* @param
|
|
2483
|
+
* @param Datacenter The instance to serialize from.
|
|
1991
2484
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
1992
2485
|
* @param writer Serialization writer to use to serialize this model
|
|
1993
2486
|
*/
|
|
1994
|
-
export declare function
|
|
2487
|
+
export declare function serializeDatacenter(writer: SerializationWriter, datacenter?: Partial<Datacenter> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
1995
2488
|
/**
|
|
1996
2489
|
* Serializes information the current object
|
|
1997
2490
|
* @param ExtendOrderRequest The instance to serialize from.
|
|
@@ -2001,137 +2494,137 @@ export declare function serializeDnsCheckResponse(writer: SerializationWriter, d
|
|
|
2001
2494
|
export declare function serializeExtendOrderRequest(writer: SerializationWriter, extendOrderRequest?: Partial<ExtendOrderRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2002
2495
|
/**
|
|
2003
2496
|
* Serializes information the current object
|
|
2004
|
-
* @param
|
|
2497
|
+
* @param ExtendOrderResponse The instance to serialize from.
|
|
2005
2498
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2006
2499
|
* @param writer Serialization writer to use to serialize this model
|
|
2007
2500
|
*/
|
|
2008
|
-
export declare function
|
|
2501
|
+
export declare function serializeExtendOrderResponse(writer: SerializationWriter, extendOrderResponse?: Partial<ExtendOrderResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2009
2502
|
/**
|
|
2010
2503
|
* Serializes information the current object
|
|
2011
|
-
* @param
|
|
2504
|
+
* @param Incident The instance to serialize from.
|
|
2012
2505
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2013
2506
|
* @param writer Serialization writer to use to serialize this model
|
|
2014
2507
|
*/
|
|
2015
|
-
export declare function
|
|
2508
|
+
export declare function serializeIncident(writer: SerializationWriter, incident?: Partial<Incident> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2016
2509
|
/**
|
|
2017
2510
|
* Serializes information the current object
|
|
2511
|
+
* @param Incident_metadata The instance to serialize from.
|
|
2018
2512
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2019
|
-
* @param Location The instance to serialize from.
|
|
2020
2513
|
* @param writer Serialization writer to use to serialize this model
|
|
2021
2514
|
*/
|
|
2022
|
-
export declare function
|
|
2515
|
+
export declare function serializeIncident_metadata(writer: SerializationWriter, incident_metadata?: Partial<Incident_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2023
2516
|
/**
|
|
2024
2517
|
* Serializes information the current object
|
|
2518
|
+
* @param IpInformation The instance to serialize from.
|
|
2025
2519
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2026
|
-
* @param Member The instance to serialize from.
|
|
2027
2520
|
* @param writer Serialization writer to use to serialize this model
|
|
2028
2521
|
*/
|
|
2029
|
-
export declare function
|
|
2522
|
+
export declare function serializeIpInformation(writer: SerializationWriter, ipInformation?: Partial<IpInformation> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2030
2523
|
/**
|
|
2031
2524
|
* Serializes information the current object
|
|
2525
|
+
* @param IpRotationLinkResponse The instance to serialize from.
|
|
2032
2526
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2033
|
-
* @param MembersResponse The instance to serialize from.
|
|
2034
2527
|
* @param writer Serialization writer to use to serialize this model
|
|
2035
2528
|
*/
|
|
2036
|
-
export declare function
|
|
2529
|
+
export declare function serializeIpRotationLinkResponse(writer: SerializationWriter, ipRotationLinkResponse?: Partial<IpRotationLinkResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2037
2530
|
/**
|
|
2038
2531
|
* Serializes information the current object
|
|
2532
|
+
* @param Isp The instance to serialize from.
|
|
2039
2533
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2040
|
-
* @param Order The instance to serialize from.
|
|
2041
2534
|
* @param writer Serialization writer to use to serialize this model
|
|
2042
2535
|
*/
|
|
2043
|
-
export declare function
|
|
2536
|
+
export declare function serializeIsp(writer: SerializationWriter, isp?: Partial<Isp> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2044
2537
|
/**
|
|
2045
2538
|
* Serializes information the current object
|
|
2046
2539
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2047
|
-
* @param
|
|
2540
|
+
* @param Location The instance to serialize from.
|
|
2048
2541
|
* @param writer Serialization writer to use to serialize this model
|
|
2049
2542
|
*/
|
|
2050
|
-
export declare function
|
|
2543
|
+
export declare function serializeLocation(writer: SerializationWriter, location?: Partial<Location> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2051
2544
|
/**
|
|
2052
2545
|
* Serializes information the current object
|
|
2053
2546
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2054
|
-
* @param
|
|
2547
|
+
* @param Order The instance to serialize from.
|
|
2055
2548
|
* @param writer Serialization writer to use to serialize this model
|
|
2056
2549
|
*/
|
|
2057
|
-
export declare function
|
|
2550
|
+
export declare function serializeOrder(writer: SerializationWriter, order?: Partial<Order> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2058
2551
|
/**
|
|
2059
2552
|
* Serializes information the current object
|
|
2060
2553
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2061
|
-
* @param
|
|
2554
|
+
* @param Order_metadata The instance to serialize from.
|
|
2062
2555
|
* @param writer Serialization writer to use to serialize this model
|
|
2063
2556
|
*/
|
|
2064
|
-
export declare function
|
|
2557
|
+
export declare function serializeOrder_metadata(writer: SerializationWriter, order_metadata?: Partial<Order_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2065
2558
|
/**
|
|
2066
2559
|
* Serializes information the current object
|
|
2067
2560
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2068
|
-
* @param
|
|
2561
|
+
* @param OrderCriteria The instance to serialize from.
|
|
2069
2562
|
* @param writer Serialization writer to use to serialize this model
|
|
2070
2563
|
*/
|
|
2071
|
-
export declare function
|
|
2564
|
+
export declare function serializeOrderCriteria(writer: SerializationWriter, orderCriteria?: Partial<OrderCriteria> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2072
2565
|
/**
|
|
2073
2566
|
* Serializes information the current object
|
|
2074
2567
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2075
|
-
* @param
|
|
2568
|
+
* @param OrderItem The instance to serialize from.
|
|
2076
2569
|
* @param writer Serialization writer to use to serialize this model
|
|
2077
2570
|
*/
|
|
2078
|
-
export declare function
|
|
2571
|
+
export declare function serializeOrderItem(writer: SerializationWriter, orderItem?: Partial<OrderItem> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2079
2572
|
/**
|
|
2080
2573
|
* Serializes information the current object
|
|
2081
2574
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2082
|
-
* @param
|
|
2575
|
+
* @param OrderItem_metadata The instance to serialize from.
|
|
2083
2576
|
* @param writer Serialization writer to use to serialize this model
|
|
2084
2577
|
*/
|
|
2085
|
-
export declare function
|
|
2578
|
+
export declare function serializeOrderItem_metadata(writer: SerializationWriter, orderItem_metadata?: Partial<OrderItem_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2086
2579
|
/**
|
|
2087
2580
|
* Serializes information the current object
|
|
2088
2581
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2089
|
-
* @param
|
|
2582
|
+
* @param PatchCustomerBillingRequest The instance to serialize from.
|
|
2090
2583
|
* @param writer Serialization writer to use to serialize this model
|
|
2091
2584
|
*/
|
|
2092
|
-
export declare function
|
|
2585
|
+
export declare function serializePatchCustomerBillingRequest(writer: SerializationWriter, patchCustomerBillingRequest?: Partial<PatchCustomerBillingRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2093
2586
|
/**
|
|
2094
2587
|
* Serializes information the current object
|
|
2095
2588
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2096
|
-
* @param
|
|
2589
|
+
* @param PatchCustomerDefaultsRequest The instance to serialize from.
|
|
2097
2590
|
* @param writer Serialization writer to use to serialize this model
|
|
2098
2591
|
*/
|
|
2099
|
-
export declare function
|
|
2592
|
+
export declare function serializePatchCustomerDefaultsRequest(writer: SerializationWriter, patchCustomerDefaultsRequest?: Partial<PatchCustomerDefaultsRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2100
2593
|
/**
|
|
2101
2594
|
* Serializes information the current object
|
|
2102
2595
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2103
|
-
* @param
|
|
2596
|
+
* @param PatchCustomerRequest The instance to serialize from.
|
|
2104
2597
|
* @param writer Serialization writer to use to serialize this model
|
|
2105
2598
|
*/
|
|
2106
|
-
export declare function
|
|
2599
|
+
export declare function serializePatchCustomerRequest(writer: SerializationWriter, patchCustomerRequest?: Partial<PatchCustomerRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2107
2600
|
/**
|
|
2108
2601
|
* Serializes information the current object
|
|
2109
2602
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2110
|
-
* @param
|
|
2603
|
+
* @param PatchMetadataRequest The instance to serialize from.
|
|
2111
2604
|
* @param writer Serialization writer to use to serialize this model
|
|
2112
2605
|
*/
|
|
2113
|
-
export declare function
|
|
2606
|
+
export declare function serializePatchMetadataRequest(writer: SerializationWriter, patchMetadataRequest?: Partial<PatchMetadataRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2114
2607
|
/**
|
|
2115
2608
|
* Serializes information the current object
|
|
2116
2609
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2117
|
-
* @param
|
|
2610
|
+
* @param PatchMetadataRequest_metadata The instance to serialize from.
|
|
2118
2611
|
* @param writer Serialization writer to use to serialize this model
|
|
2119
2612
|
*/
|
|
2120
|
-
export declare function
|
|
2613
|
+
export declare function serializePatchMetadataRequest_metadata(writer: SerializationWriter, patchMetadataRequest_metadata?: Partial<PatchMetadataRequest_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2121
2614
|
/**
|
|
2122
2615
|
* Serializes information the current object
|
|
2123
2616
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2124
|
-
* @param
|
|
2617
|
+
* @param PatchPasswordRequest The instance to serialize from.
|
|
2125
2618
|
* @param writer Serialization writer to use to serialize this model
|
|
2126
2619
|
*/
|
|
2127
|
-
export declare function
|
|
2620
|
+
export declare function serializePatchPasswordRequest(writer: SerializationWriter, patchPasswordRequest?: Partial<PatchPasswordRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2128
2621
|
/**
|
|
2129
2622
|
* Serializes information the current object
|
|
2130
2623
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2131
|
-
* @param
|
|
2624
|
+
* @param PatchProxyAnnotationRequest The instance to serialize from.
|
|
2132
2625
|
* @param writer Serialization writer to use to serialize this model
|
|
2133
2626
|
*/
|
|
2134
|
-
export declare function
|
|
2627
|
+
export declare function serializePatchProxyAnnotationRequest(writer: SerializationWriter, patchProxyAnnotationRequest?: Partial<PatchProxyAnnotationRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2135
2628
|
/**
|
|
2136
2629
|
* Serializes information the current object
|
|
2137
2630
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -2142,10 +2635,10 @@ export declare function serializePreviewOrderRequest(writer: SerializationWriter
|
|
|
2142
2635
|
/**
|
|
2143
2636
|
* Serializes information the current object
|
|
2144
2637
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2145
|
-
* @param
|
|
2638
|
+
* @param PreviewOrderResponse The instance to serialize from.
|
|
2146
2639
|
* @param writer Serialization writer to use to serialize this model
|
|
2147
2640
|
*/
|
|
2148
|
-
export declare function
|
|
2641
|
+
export declare function serializePreviewOrderResponse(writer: SerializationWriter, previewOrderResponse?: Partial<PreviewOrderResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2149
2642
|
/**
|
|
2150
2643
|
* Serializes information the current object
|
|
2151
2644
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -2167,6 +2660,27 @@ export declare function serializeProxy(writer: SerializationWriter, proxy?: Part
|
|
|
2167
2660
|
* @param writer Serialization writer to use to serialize this model
|
|
2168
2661
|
*/
|
|
2169
2662
|
export declare function serializeProxyCredentialResponse(writer: SerializationWriter, proxyCredentialResponse?: Partial<ProxyCredentialResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2663
|
+
/**
|
|
2664
|
+
* Serializes information the current object
|
|
2665
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2666
|
+
* @param ProxyDatacenter The instance to serialize from.
|
|
2667
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2668
|
+
*/
|
|
2669
|
+
export declare function serializeProxyDatacenter(writer: SerializationWriter, proxyDatacenter?: Partial<ProxyDatacenter> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2670
|
+
/**
|
|
2671
|
+
* Serializes information the current object
|
|
2672
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2673
|
+
* @param ProxyFeatures The instance to serialize from.
|
|
2674
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2675
|
+
*/
|
|
2676
|
+
export declare function serializeProxyFeatures(writer: SerializationWriter, proxyFeatures?: Partial<ProxyFeatures> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2677
|
+
/**
|
|
2678
|
+
* Serializes information the current object
|
|
2679
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2680
|
+
* @param ProxyIpRotationFeature The instance to serialize from.
|
|
2681
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2682
|
+
*/
|
|
2683
|
+
export declare function serializeProxyIpRotationFeature(writer: SerializationWriter, proxyIpRotationFeature?: Partial<ProxyIpRotationFeature> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2170
2684
|
/**
|
|
2171
2685
|
* Serializes information the current object
|
|
2172
2686
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -2177,101 +2691,122 @@ export declare function serializeProxyIpRotationResponse(writer: SerializationWr
|
|
|
2177
2691
|
/**
|
|
2178
2692
|
* Serializes information the current object
|
|
2179
2693
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2180
|
-
* @param
|
|
2694
|
+
* @param ProxyIsp The instance to serialize from.
|
|
2181
2695
|
* @param writer Serialization writer to use to serialize this model
|
|
2182
2696
|
*/
|
|
2183
|
-
export declare function
|
|
2697
|
+
export declare function serializeProxyIsp(writer: SerializationWriter, proxyIsp?: Partial<ProxyIsp> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2184
2698
|
/**
|
|
2185
2699
|
* Serializes information the current object
|
|
2186
2700
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2187
|
-
* @param
|
|
2701
|
+
* @param ProxyLocation The instance to serialize from.
|
|
2188
2702
|
* @param writer Serialization writer to use to serialize this model
|
|
2189
2703
|
*/
|
|
2190
|
-
export declare function
|
|
2704
|
+
export declare function serializeProxyLocation(writer: SerializationWriter, proxyLocation?: Partial<ProxyLocation> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2191
2705
|
/**
|
|
2192
2706
|
* Serializes information the current object
|
|
2193
2707
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2194
|
-
* @param
|
|
2708
|
+
* @param ProxyOptions The instance to serialize from.
|
|
2195
2709
|
* @param writer Serialization writer to use to serialize this model
|
|
2196
2710
|
*/
|
|
2197
|
-
export declare function
|
|
2711
|
+
export declare function serializeProxyOptions(writer: SerializationWriter, proxyOptions?: Partial<ProxyOptions> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2198
2712
|
/**
|
|
2199
2713
|
* Serializes information the current object
|
|
2200
2714
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2201
|
-
* @param
|
|
2715
|
+
* @param ProxyOptions_metadata The instance to serialize from.
|
|
2202
2716
|
* @param writer Serialization writer to use to serialize this model
|
|
2203
2717
|
*/
|
|
2204
|
-
export declare function
|
|
2718
|
+
export declare function serializeProxyOptions_metadata(writer: SerializationWriter, proxyOptions_metadata?: Partial<ProxyOptions_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2205
2719
|
/**
|
|
2206
2720
|
* Serializes information the current object
|
|
2207
2721
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2208
|
-
* @param
|
|
2722
|
+
* @param ProxyPingResponse The instance to serialize from.
|
|
2209
2723
|
* @param writer Serialization writer to use to serialize this model
|
|
2210
2724
|
*/
|
|
2211
|
-
export declare function
|
|
2725
|
+
export declare function serializeProxyPingResponse(writer: SerializationWriter, proxyPingResponse?: Partial<ProxyPingResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2726
|
+
/**
|
|
2727
|
+
* Serializes information the current object
|
|
2728
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2729
|
+
* @param ProxyProduct The instance to serialize from.
|
|
2730
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2731
|
+
*/
|
|
2732
|
+
export declare function serializeProxyProduct(writer: SerializationWriter, proxyProduct?: Partial<ProxyProduct> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2733
|
+
/**
|
|
2734
|
+
* Serializes information the current object
|
|
2735
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2736
|
+
* @param RequestDetails The instance to serialize from.
|
|
2737
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2738
|
+
*/
|
|
2739
|
+
export declare function serializeRequestDetails(writer: SerializationWriter, requestDetails?: Partial<RequestDetails> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2740
|
+
/**
|
|
2741
|
+
* Serializes information the current object
|
|
2742
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2743
|
+
* @param ResetPasswordResponse The instance to serialize from.
|
|
2744
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2745
|
+
*/
|
|
2746
|
+
export declare function serializeResetPasswordResponse(writer: SerializationWriter, resetPasswordResponse?: Partial<ResetPasswordResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2212
2747
|
/**
|
|
2213
2748
|
* Serializes information the current object
|
|
2214
2749
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2215
|
-
* @param
|
|
2750
|
+
* @param ResolveIncidentRequest The instance to serialize from.
|
|
2216
2751
|
* @param writer Serialization writer to use to serialize this model
|
|
2217
2752
|
*/
|
|
2218
|
-
export declare function
|
|
2753
|
+
export declare function serializeResolveIncidentRequest(writer: SerializationWriter, resolveIncidentRequest?: Partial<ResolveIncidentRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2219
2754
|
/**
|
|
2220
2755
|
* Serializes information the current object
|
|
2221
2756
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2222
|
-
* @param
|
|
2757
|
+
* @param Review The instance to serialize from.
|
|
2223
2758
|
* @param writer Serialization writer to use to serialize this model
|
|
2224
2759
|
*/
|
|
2225
|
-
export declare function
|
|
2760
|
+
export declare function serializeReview(writer: SerializationWriter, review?: Partial<Review> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2226
2761
|
/**
|
|
2227
2762
|
* Serializes information the current object
|
|
2228
2763
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2229
|
-
* @param
|
|
2764
|
+
* @param Review_metadata The instance to serialize from.
|
|
2230
2765
|
* @param writer Serialization writer to use to serialize this model
|
|
2231
2766
|
*/
|
|
2232
|
-
export declare function
|
|
2767
|
+
export declare function serializeReview_metadata(writer: SerializationWriter, review_metadata?: Partial<Review_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2233
2768
|
/**
|
|
2234
2769
|
* Serializes information the current object
|
|
2235
2770
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2236
|
-
* @param
|
|
2771
|
+
* @param ReviewKycRequest The instance to serialize from.
|
|
2237
2772
|
* @param writer Serialization writer to use to serialize this model
|
|
2238
2773
|
*/
|
|
2239
|
-
export declare function
|
|
2774
|
+
export declare function serializeReviewKycRequest(writer: SerializationWriter, reviewKycRequest?: Partial<ReviewKycRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2240
2775
|
/**
|
|
2241
2776
|
* Serializes information the current object
|
|
2242
2777
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2243
|
-
* @param
|
|
2778
|
+
* @param SendVerificationRequest The instance to serialize from.
|
|
2244
2779
|
* @param writer Serialization writer to use to serialize this model
|
|
2245
2780
|
*/
|
|
2246
|
-
export declare function
|
|
2781
|
+
export declare function serializeSendVerificationRequest(writer: SerializationWriter, sendVerificationRequest?: Partial<SendVerificationRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2247
2782
|
/**
|
|
2248
2783
|
* Serializes information the current object
|
|
2249
2784
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2250
|
-
* @param
|
|
2785
|
+
* @param TrialOrderRequest The instance to serialize from.
|
|
2251
2786
|
* @param writer Serialization writer to use to serialize this model
|
|
2252
2787
|
*/
|
|
2253
|
-
export declare function
|
|
2788
|
+
export declare function serializeTrialOrderRequest(writer: SerializationWriter, trialOrderRequest?: Partial<TrialOrderRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2254
2789
|
/**
|
|
2255
2790
|
* Serializes information the current object
|
|
2256
2791
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2257
|
-
* @param
|
|
2792
|
+
* @param UpdateCustomerRequest The instance to serialize from.
|
|
2258
2793
|
* @param writer Serialization writer to use to serialize this model
|
|
2259
2794
|
*/
|
|
2260
|
-
export declare function
|
|
2795
|
+
export declare function serializeUpdateCustomerRequest(writer: SerializationWriter, updateCustomerRequest?: Partial<UpdateCustomerRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2261
2796
|
/**
|
|
2262
2797
|
* Serializes information the current object
|
|
2263
2798
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2264
|
-
* @param
|
|
2799
|
+
* @param UpdateCustomerRequest_externalLogins The instance to serialize from.
|
|
2265
2800
|
* @param writer Serialization writer to use to serialize this model
|
|
2266
2801
|
*/
|
|
2267
|
-
export declare function
|
|
2802
|
+
export declare function serializeUpdateCustomerRequest_externalLogins(writer: SerializationWriter, updateCustomerRequest_externalLogins?: Partial<UpdateCustomerRequest_externalLogins> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2268
2803
|
/**
|
|
2269
2804
|
* Serializes information the current object
|
|
2270
2805
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2271
|
-
* @param
|
|
2806
|
+
* @param UpdateProxyCredentialsRequest The instance to serialize from.
|
|
2272
2807
|
* @param writer Serialization writer to use to serialize this model
|
|
2273
2808
|
*/
|
|
2274
|
-
export declare function
|
|
2809
|
+
export declare function serializeUpdateProxyCredentialsRequest(writer: SerializationWriter, updateProxyCredentialsRequest?: Partial<UpdateProxyCredentialsRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2275
2810
|
/**
|
|
2276
2811
|
* Serializes information the current object
|
|
2277
2812
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -2279,223 +2814,214 @@ export declare function serializeUpdatePaymentProcessorRequest_values(writer: Se
|
|
|
2279
2814
|
* @param writer Serialization writer to use to serialize this model
|
|
2280
2815
|
*/
|
|
2281
2816
|
export declare function serializeUpdateProxyIpRotationRequest(writer: SerializationWriter, updateProxyIpRotationRequest?: Partial<UpdateProxyIpRotationRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2282
|
-
|
|
2283
|
-
|
|
2817
|
+
/**
|
|
2818
|
+
* Serializes information the current object
|
|
2819
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
2820
|
+
* @param UpdateProxyOptionsRequest The instance to serialize from.
|
|
2821
|
+
* @param writer Serialization writer to use to serialize this model
|
|
2822
|
+
*/
|
|
2823
|
+
export declare function serializeUpdateProxyOptionsRequest(writer: SerializationWriter, updateProxyOptionsRequest?: Partial<UpdateProxyOptionsRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
2824
|
+
/**
|
|
2825
|
+
* Trial order request: the same selection as a paid order, but free and time-boxed, so it carries no billing cycle, payment method or auto-renewal.
|
|
2826
|
+
*/
|
|
2827
|
+
export interface TrialOrderRequest extends AdditionalDataHolder, Parsable {
|
|
2828
|
+
/**
|
|
2829
|
+
* Priced selection the order is placed against.
|
|
2830
|
+
*/
|
|
2831
|
+
criteria?: OrderCriteria | null;
|
|
2284
2832
|
/**
|
|
2285
|
-
* The
|
|
2833
|
+
* The organization's end customer this order is for. Required for a retail order (it bills that customer on the organization's connected account); must be null for wholesale (the organization itself is billed).
|
|
2286
2834
|
*/
|
|
2287
|
-
|
|
2835
|
+
customerId?: Guid | null;
|
|
2288
2836
|
/**
|
|
2289
|
-
* The
|
|
2837
|
+
* The intent property
|
|
2290
2838
|
*/
|
|
2291
|
-
|
|
2839
|
+
intent?: OrderIntents | null;
|
|
2292
2840
|
/**
|
|
2293
|
-
*
|
|
2841
|
+
* Number of units to order. Defaults to 1.
|
|
2294
2842
|
*/
|
|
2295
|
-
|
|
2843
|
+
quantity?: number | null;
|
|
2296
2844
|
}
|
|
2845
|
+
/**
|
|
2846
|
+
* Payload to update a customer. Null fields are left unchanged.
|
|
2847
|
+
*/
|
|
2297
2848
|
export interface UpdateCustomerRequest extends AdditionalDataHolder, Parsable {
|
|
2298
2849
|
/**
|
|
2299
|
-
* The
|
|
2850
|
+
* The billing property
|
|
2300
2851
|
*/
|
|
2301
|
-
|
|
2852
|
+
billing?: CustomerBilling | null;
|
|
2302
2853
|
/**
|
|
2303
|
-
*
|
|
2854
|
+
* New display name. Null leaves it unchanged.
|
|
2304
2855
|
*/
|
|
2305
2856
|
displayName?: string | null;
|
|
2306
2857
|
/**
|
|
2307
|
-
*
|
|
2858
|
+
* New email. Null leaves it unchanged.
|
|
2308
2859
|
*/
|
|
2309
2860
|
email?: string | null;
|
|
2310
2861
|
/**
|
|
2311
|
-
*
|
|
2862
|
+
* New external id. Null leaves it unchanged.
|
|
2312
2863
|
*/
|
|
2313
2864
|
externalId?: string | null;
|
|
2314
|
-
}
|
|
2315
|
-
export interface UpdateCustomerRequest_billingDetails extends AdditionalDataHolder, Parsable {
|
|
2316
|
-
}
|
|
2317
|
-
export interface UpdateOrganizationBillingRequest extends AdditionalDataHolder, Parsable {
|
|
2318
|
-
/**
|
|
2319
|
-
* The addressLine property
|
|
2320
|
-
*/
|
|
2321
|
-
addressLine?: string | null;
|
|
2322
|
-
/**
|
|
2323
|
-
* The city property
|
|
2324
|
-
*/
|
|
2325
|
-
city?: string | null;
|
|
2326
|
-
/**
|
|
2327
|
-
* The country property
|
|
2328
|
-
*/
|
|
2329
|
-
country?: string | null;
|
|
2330
|
-
/**
|
|
2331
|
-
* The email property
|
|
2332
|
-
*/
|
|
2333
|
-
email?: string | null;
|
|
2334
|
-
/**
|
|
2335
|
-
* The postalCode property
|
|
2336
|
-
*/
|
|
2337
|
-
postalCode?: string | null;
|
|
2338
|
-
/**
|
|
2339
|
-
* The taxId property
|
|
2340
|
-
*/
|
|
2341
|
-
taxId?: string | null;
|
|
2342
|
-
}
|
|
2343
|
-
export interface UpdateOrganizationBrandingRequest extends AdditionalDataHolder, Parsable {
|
|
2344
|
-
/**
|
|
2345
|
-
* The accentColor property
|
|
2346
|
-
*/
|
|
2347
|
-
accentColor?: string | null;
|
|
2348
|
-
/**
|
|
2349
|
-
* The iconUrl property
|
|
2350
|
-
*/
|
|
2351
|
-
iconUrl?: string | null;
|
|
2352
|
-
/**
|
|
2353
|
-
* The logoDarkUrl property
|
|
2354
|
-
*/
|
|
2355
|
-
logoDarkUrl?: string | null;
|
|
2356
|
-
/**
|
|
2357
|
-
* The logoLightUrl property
|
|
2358
|
-
*/
|
|
2359
|
-
logoLightUrl?: string | null;
|
|
2360
|
-
}
|
|
2361
|
-
export interface UpdateOrganizationEmailRequest extends AdditionalDataHolder, Parsable {
|
|
2362
|
-
/**
|
|
2363
|
-
* The fromAddress property
|
|
2364
|
-
*/
|
|
2365
|
-
fromAddress?: string | null;
|
|
2366
2865
|
/**
|
|
2367
|
-
*
|
|
2866
|
+
* Replacement external logins (OAuth provider -> subject). Null leaves them unchanged.
|
|
2368
2867
|
*/
|
|
2369
|
-
|
|
2868
|
+
externalLogins?: UpdateCustomerRequest_externalLogins | null;
|
|
2370
2869
|
/**
|
|
2371
|
-
*
|
|
2870
|
+
* New locale (BCP-47 tag). Null leaves it unchanged.
|
|
2372
2871
|
*/
|
|
2373
|
-
|
|
2872
|
+
locale?: string | null;
|
|
2374
2873
|
/**
|
|
2375
|
-
*
|
|
2874
|
+
* New phone number. Null leaves it unchanged.
|
|
2376
2875
|
*/
|
|
2377
|
-
|
|
2876
|
+
phoneNumber?: string | null;
|
|
2378
2877
|
/**
|
|
2379
|
-
*
|
|
2878
|
+
* New push-notifications token. Null leaves it unchanged.
|
|
2380
2879
|
*/
|
|
2381
|
-
|
|
2880
|
+
pushNotificationsToken?: string | null;
|
|
2382
2881
|
}
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
proxyDomain?: string | null;
|
|
2882
|
+
/**
|
|
2883
|
+
* Replacement external logins (OAuth provider -> subject). Null leaves them unchanged.
|
|
2884
|
+
*/
|
|
2885
|
+
export interface UpdateCustomerRequest_externalLogins extends AdditionalDataHolder, Parsable {
|
|
2388
2886
|
}
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
amount?: number | null;
|
|
2394
|
-
/**
|
|
2395
|
-
* The disabled property
|
|
2396
|
-
*/
|
|
2397
|
-
disabled?: boolean | null;
|
|
2398
|
-
/**
|
|
2399
|
-
* The ispId property
|
|
2400
|
-
*/
|
|
2401
|
-
ispId?: Guid | null;
|
|
2402
|
-
/**
|
|
2403
|
-
* The locationId property
|
|
2404
|
-
*/
|
|
2405
|
-
locationId?: Guid | null;
|
|
2887
|
+
/**
|
|
2888
|
+
* Request to change an allocated proxy's credentials. A null username or password is generated from the organization's default formats.
|
|
2889
|
+
*/
|
|
2890
|
+
export interface UpdateProxyCredentialsRequest extends AdditionalDataHolder, Parsable {
|
|
2406
2891
|
/**
|
|
2407
|
-
*
|
|
2892
|
+
* IP addresses allowed to use the proxy.
|
|
2408
2893
|
*/
|
|
2409
|
-
|
|
2410
|
-
}
|
|
2411
|
-
export interface UpdateOrganizationRequest extends AdditionalDataHolder, Parsable {
|
|
2894
|
+
allowedIps?: string[] | null;
|
|
2412
2895
|
/**
|
|
2413
|
-
*
|
|
2896
|
+
* New authentication password. Generated from the organization's default format when null.
|
|
2414
2897
|
*/
|
|
2415
|
-
|
|
2898
|
+
password?: string | null;
|
|
2416
2899
|
/**
|
|
2417
|
-
*
|
|
2900
|
+
* New authentication username. Generated from the organization's default format when null.
|
|
2418
2901
|
*/
|
|
2419
|
-
|
|
2902
|
+
username?: string | null;
|
|
2420
2903
|
}
|
|
2421
|
-
|
|
2904
|
+
/**
|
|
2905
|
+
* Request to configure a proxy's IP rotation. An interval of 0 disables rotation.
|
|
2906
|
+
*/
|
|
2907
|
+
export interface UpdateProxyIpRotationRequest extends AdditionalDataHolder, Parsable {
|
|
2422
2908
|
/**
|
|
2423
|
-
*
|
|
2909
|
+
* How often the proxy rotates its IP, in seconds. 0 disables rotation.
|
|
2424
2910
|
*/
|
|
2425
|
-
|
|
2426
|
-
}
|
|
2427
|
-
export interface UpdatePaymentProcessorRequest_values extends AdditionalDataHolder, Parsable {
|
|
2911
|
+
intervalSeconds?: number | null;
|
|
2428
2912
|
}
|
|
2429
|
-
|
|
2913
|
+
/**
|
|
2914
|
+
* The feature options to set on a proxy. A non-default option is only accepted when the proxy exposes the capability it depends on (see ProxyOptions).
|
|
2915
|
+
*/
|
|
2916
|
+
export interface UpdateProxyOptionsRequest extends AdditionalDataHolder, Parsable {
|
|
2430
2917
|
/**
|
|
2431
|
-
*
|
|
2918
|
+
* How the proxy resolves addresses. Non-default modes require the proxy's IPv6 capability.
|
|
2432
2919
|
*/
|
|
2433
|
-
|
|
2920
|
+
resolutionMode?: ResolutionModes | null;
|
|
2434
2921
|
}
|
|
2922
|
+
/**
|
|
2923
|
+
* Publication state of the announcement: only Published ones are shown.
|
|
2924
|
+
*/
|
|
2435
2925
|
export declare const AnnouncementStatusesObject: {
|
|
2436
2926
|
readonly Draft: "Draft";
|
|
2437
2927
|
readonly Published: "Published";
|
|
2438
2928
|
readonly Archived: "Archived";
|
|
2439
2929
|
};
|
|
2930
|
+
/**
|
|
2931
|
+
* Billing period of the selected price.
|
|
2932
|
+
*/
|
|
2440
2933
|
export declare const BillingCyclesObject: {
|
|
2441
2934
|
readonly Daily: "Daily";
|
|
2442
2935
|
readonly Weekly: "Weekly";
|
|
2443
2936
|
readonly Monthly: "Monthly";
|
|
2444
2937
|
readonly Quarterly: "Quarterly";
|
|
2445
2938
|
readonly Yearly: "Yearly";
|
|
2939
|
+
readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
|
|
2940
|
+
};
|
|
2941
|
+
export declare const CapabilityTypesObject: {
|
|
2942
|
+
readonly IpScore: "IpScore";
|
|
2943
|
+
readonly Ipv6: "Ipv6";
|
|
2944
|
+
};
|
|
2945
|
+
/**
|
|
2946
|
+
* Overrides the organization's grace-period policy for this customer's orders. Null (the default) inherits the org's `OrganizationTerms.GracePeriodPolicy`; set it to give one customer its own policy (e.g. GracePeriodPolicies.KeepAlive) without changing the whole organization.
|
|
2947
|
+
*/
|
|
2948
|
+
export declare const GracePeriodPoliciesObject: {
|
|
2949
|
+
readonly DefaultEscaped: "Default";
|
|
2950
|
+
readonly None: "None";
|
|
2951
|
+
readonly KeepAlive: "KeepAlive";
|
|
2952
|
+
readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
|
|
2446
2953
|
};
|
|
2954
|
+
/**
|
|
2955
|
+
* Lifecycle state of the incident (open, resolved, etc.).
|
|
2956
|
+
*/
|
|
2447
2957
|
export declare const IncidentStatusesObject: {
|
|
2448
2958
|
readonly Open: "Open";
|
|
2449
|
-
readonly Investigating: "Investigating";
|
|
2450
2959
|
readonly Resolved: "Resolved";
|
|
2451
2960
|
readonly Dismissed: "Dismissed";
|
|
2452
2961
|
};
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
readonly
|
|
2459
|
-
readonly Weekly: "Weekly";
|
|
2460
|
-
readonly Monthly: "Monthly";
|
|
2461
|
-
readonly Quarterly: "Quarterly";
|
|
2462
|
-
readonly Yearly: "Yearly";
|
|
2463
|
-
readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
|
|
2464
|
-
};
|
|
2465
|
-
export declare const NullableOfPaymentMethodsObject: {
|
|
2466
|
-
readonly Balance: "Balance";
|
|
2467
|
-
readonly CreditCard: "CreditCard";
|
|
2468
|
-
readonly Cryptocurrency: "Cryptocurrency";
|
|
2469
|
-
readonly Debug: "Debug";
|
|
2962
|
+
/**
|
|
2963
|
+
* Reason the order is placed, which decides how it is priced and paid. Null defaults to the caller's channel: OrderIntents.Wholesale from the console, OrderIntents.Retail from the API.
|
|
2964
|
+
*/
|
|
2965
|
+
export declare const OrderIntentsObject: {
|
|
2966
|
+
readonly Wholesale: "Wholesale";
|
|
2967
|
+
readonly Retail: "Retail";
|
|
2470
2968
|
readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
|
|
2471
2969
|
};
|
|
2970
|
+
/**
|
|
2971
|
+
* Commercial state of the order. Stored as the source of truth for states that aren't derivable from the dates (`Provisioning`, `Expired` once a worker confirms it, and later cancellations or holds). The transient `GracePeriod` is layered on at read time by `ResolveStatus` from DateTimeOffset? Order.ExpiresAt and the organization's grace policy. Defaults to `Pending` (nothing paid or set up yet); each flow sets the real state through the transition helpers.
|
|
2972
|
+
*/
|
|
2472
2973
|
export declare const OrderStatusesObject: {
|
|
2473
2974
|
readonly Pending: "Pending";
|
|
2474
2975
|
readonly Provisioning: "Provisioning";
|
|
2475
2976
|
readonly Active: "Active";
|
|
2977
|
+
readonly GracePeriod: "GracePeriod";
|
|
2476
2978
|
readonly Expired: "Expired";
|
|
2979
|
+
readonly Deleted: "Deleted";
|
|
2477
2980
|
};
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
|
|
2981
|
+
/**
|
|
2982
|
+
* Scheme that produced string? Customer.PasswordHash, defaulting to BCrypt. A Legacy hash is an import from a previous system, verified as-is and upgraded to BCrypt on the next successful login. The scheme is exposed to clients (the admin surface shows it) even though the hash itself never is.
|
|
2983
|
+
*/
|
|
2984
|
+
export declare const PasswordHashSchemesObject: {
|
|
2985
|
+
readonly Bcrypt: "Bcrypt";
|
|
2986
|
+
readonly Legacy: "Legacy";
|
|
2481
2987
|
};
|
|
2988
|
+
/**
|
|
2989
|
+
* Payment method for the order.
|
|
2990
|
+
*/
|
|
2482
2991
|
export declare const PaymentMethodsObject: {
|
|
2483
2992
|
readonly Balance: "Balance";
|
|
2484
2993
|
readonly CreditCard: "CreditCard";
|
|
2485
2994
|
readonly Cryptocurrency: "Cryptocurrency";
|
|
2486
2995
|
readonly Debug: "Debug";
|
|
2996
|
+
readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
|
|
2487
2997
|
};
|
|
2998
|
+
/**
|
|
2999
|
+
* Processor that settles the order (Stripe, Heleket). Selects the webhook and reconciliation path that keeps it alive. Null for a trial (nothing to settle).
|
|
3000
|
+
*/
|
|
2488
3001
|
export declare const PaymentProcessorsObject: {
|
|
3002
|
+
readonly None: "None";
|
|
2489
3003
|
readonly Heleket: "Heleket";
|
|
2490
3004
|
readonly Stripe: "Stripe";
|
|
3005
|
+
readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
|
|
2491
3006
|
};
|
|
3007
|
+
/**
|
|
3008
|
+
* How the product is billed.
|
|
3009
|
+
*/
|
|
2492
3010
|
export declare const PricingTypesObject: {
|
|
2493
3011
|
readonly PerUnit: "PerUnit";
|
|
2494
3012
|
readonly PerBandwidth: "PerBandwidth";
|
|
2495
3013
|
};
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
readonly
|
|
3014
|
+
/**
|
|
3015
|
+
* Kind of resource this product delivers (proxy, host).
|
|
3016
|
+
*/
|
|
3017
|
+
export declare const ProductKindsObject: {
|
|
3018
|
+
readonly Proxy: "Proxy";
|
|
3019
|
+
readonly Host: "Host";
|
|
3020
|
+
};
|
|
3021
|
+
/**
|
|
3022
|
+
* How the proxy resolves addresses. The non-default modes need the proxy's IPv6 capability.
|
|
3023
|
+
*/
|
|
3024
|
+
export declare const ResolutionModesObject: {
|
|
3025
|
+
readonly DefaultEscaped: "Default";
|
|
3026
|
+
readonly Ipv6: "Ipv6";
|
|
2501
3027
|
};
|