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