@hypelabs-llc/ts-sdk 0.2.5 → 0.3.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.
Files changed (60) hide show
  1. package/dist/bearerAuthenticationProvider.d.ts +10 -0
  2. package/dist/bearerAuthenticationProvider.js +14 -0
  3. package/dist/connectClient.d.ts +2 -1
  4. package/dist/connectClient.js +5 -1
  5. package/dist/customerClient.d.ts +16 -0
  6. package/dist/customerClient.js +28 -0
  7. package/dist/generated/customers/index.d.ts +2 -2
  8. package/dist/generated-customer/announcements/index.d.ts +27 -0
  9. package/dist/generated-customer/announcements/index.js +22 -0
  10. package/dist/generated-customer/catalog/capabilities/index.d.ts +44 -0
  11. package/dist/generated-customer/catalog/capabilities/index.js +22 -0
  12. package/dist/generated-customer/catalog/datacenters/index.d.ts +45 -0
  13. package/dist/generated-customer/catalog/datacenters/index.js +25 -0
  14. package/dist/generated-customer/catalog/index.d.ts +39 -0
  15. package/dist/generated-customer/catalog/index.js +39 -0
  16. package/dist/generated-customer/catalog/isps/index.d.ts +45 -0
  17. package/dist/generated-customer/catalog/isps/index.js +25 -0
  18. package/dist/generated-customer/catalog/locations/index.d.ts +41 -0
  19. package/dist/generated-customer/catalog/locations/index.js +25 -0
  20. package/dist/generated-customer/catalog/products/index.d.ts +33 -0
  21. package/dist/generated-customer/catalog/products/index.js +22 -0
  22. package/dist/generated-customer/customerApiClient.d.ts +54 -0
  23. package/dist/generated-customer/customerApiClient.js +92 -0
  24. package/dist/generated-customer/incidents/index.d.ts +30 -0
  25. package/dist/generated-customer/incidents/index.js +28 -0
  26. package/dist/generated-customer/models/index.d.ts +1739 -0
  27. package/dist/generated-customer/models/index.js +1665 -0
  28. package/dist/generated-customer/orders/index.d.ts +55 -0
  29. package/dist/generated-customer/orders/index.js +34 -0
  30. package/dist/generated-customer/orders/item/index.d.ts +37 -0
  31. package/dist/generated-customer/orders/item/index.js +35 -0
  32. package/dist/generated-customer/orders/item/proxies/index.d.ts +28 -0
  33. package/dist/generated-customer/orders/item/proxies/index.js +25 -0
  34. package/dist/generated-customer/organizations/branding/index.d.ts +27 -0
  35. package/dist/generated-customer/organizations/branding/index.js +22 -0
  36. package/dist/generated-customer/organizations/index.d.ts +24 -0
  37. package/dist/generated-customer/organizations/index.js +24 -0
  38. package/dist/generated-customer/organizations/store/index.d.ts +27 -0
  39. package/dist/generated-customer/organizations/store/index.js +22 -0
  40. package/dist/generated-customer/proxies/index.d.ts +38 -0
  41. package/dist/generated-customer/proxies/index.js +34 -0
  42. package/dist/generated-customer/proxies/item/credentials/index.d.ts +41 -0
  43. package/dist/generated-customer/proxies/item/credentials/index.js +30 -0
  44. package/dist/generated-customer/proxies/item/index.d.ts +51 -0
  45. package/dist/generated-customer/proxies/item/index.js +48 -0
  46. package/dist/generated-customer/proxies/item/ipInfo/index.d.ts +29 -0
  47. package/dist/generated-customer/proxies/item/ipInfo/index.js +26 -0
  48. package/dist/generated-customer/proxies/item/ipRotation/index.d.ts +55 -0
  49. package/dist/generated-customer/proxies/item/ipRotation/index.js +45 -0
  50. package/dist/generated-customer/proxies/item/ipRotation/link/index.d.ts +27 -0
  51. package/dist/generated-customer/proxies/item/ipRotation/link/index.js +22 -0
  52. package/dist/generated-customer/proxies/item/ipRotation/trigger/index.d.ts +26 -0
  53. package/dist/generated-customer/proxies/item/ipRotation/trigger/index.js +16 -0
  54. package/dist/generated-customer/proxies/item/options/index.d.ts +27 -0
  55. package/dist/generated-customer/proxies/item/options/index.js +22 -0
  56. package/dist/generated-customer/reviews/index.d.ts +42 -0
  57. package/dist/generated-customer/reviews/index.js +34 -0
  58. package/dist/index.d.ts +3 -0
  59. package/dist/index.js +6 -0
  60. package/package.json +1 -1
@@ -0,0 +1,1739 @@
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 {
6
+ /**
7
+ * Body text of the announcement, shown under the title.
8
+ */
9
+ body?: string | null;
10
+ /**
11
+ * The id property
12
+ */
13
+ id?: Guid | null;
14
+ /**
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.
36
+ */
37
+ status?: AnnouncementStatuses | null;
38
+ /**
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
67
+ */
68
+ messageEscaped?: string | null;
69
+ /**
70
+ * The requestDetails property
71
+ */
72
+ requestDetails?: RequestDetails | null;
73
+ /**
74
+ * The statusCode property
75
+ */
76
+ statusCode?: number | null;
77
+ }
78
+ export type BillingCycles = (typeof BillingCyclesObject)[keyof typeof BillingCyclesObject];
79
+ /**
80
+ * A catalog capability that proxies can expose (IPv6, IP scoring, and similar features).
81
+ */
82
+ export interface Capability extends AdditionalDataHolder, Parsable {
83
+ /**
84
+ * Count of proxies currently available (active and unallocated) behind this option.
85
+ */
86
+ availableProxies?: number | null;
87
+ /**
88
+ * Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
89
+ */
90
+ basePrice?: number | null;
91
+ /**
92
+ * Human-readable explanation of what the capability provides. Null when none is set.
93
+ */
94
+ description?: string | null;
95
+ /**
96
+ * Unique identifier of the catalog option.
97
+ */
98
+ id?: Guid | null;
99
+ /**
100
+ * Whether the current organization has hidden this option from its storefront.
101
+ */
102
+ isDisabled?: boolean | null;
103
+ /**
104
+ * Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
105
+ */
106
+ name?: string | null;
107
+ /**
108
+ * Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
109
+ */
110
+ price?: number | null;
111
+ /**
112
+ * Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
113
+ */
114
+ retailPrice?: number | null;
115
+ /**
116
+ * Which capability this option is (e.g. IPv6, IP scoring).
117
+ */
118
+ type?: CapabilityTypes | null;
119
+ }
120
+ export type CapabilityTypes = (typeof CapabilityTypesObject)[keyof typeof CapabilityTypesObject];
121
+ /**
122
+ * Creates a new instance of the appropriate class based on discriminator value
123
+ * @param parseNode The parse node to use to read the discriminator value and create the object
124
+ * @returns {Announcement_metadata}
125
+ */
126
+ export declare function createAnnouncement_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
127
+ /**
128
+ * Creates a new instance of the appropriate class based on discriminator value
129
+ * @param parseNode The parse node to use to read the discriminator value and create the object
130
+ * @returns {Announcement}
131
+ */
132
+ export declare function createAnnouncementFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
133
+ /**
134
+ * Creates a new instance of the appropriate class based on discriminator value
135
+ * @param parseNode The parse node to use to read the discriminator value and create the object
136
+ * @returns {ApiError}
137
+ */
138
+ export declare function createApiErrorFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
139
+ /**
140
+ * Creates a new instance of the appropriate class based on discriminator value
141
+ * @param parseNode The parse node to use to read the discriminator value and create the object
142
+ * @returns {ApiResponse}
143
+ */
144
+ export declare function createApiResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
145
+ /**
146
+ * Creates a new instance of the appropriate class based on discriminator value
147
+ * @param parseNode The parse node to use to read the discriminator value and create the object
148
+ * @returns {Capability}
149
+ */
150
+ export declare function createCapabilityFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
151
+ /**
152
+ * Creates a new instance of the appropriate class based on discriminator value
153
+ * @param parseNode The parse node to use to read the discriminator value and create the object
154
+ * @returns {CreateIncidentRequest}
155
+ */
156
+ export declare function createCreateIncidentRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
157
+ /**
158
+ * Creates a new instance of the appropriate class based on discriminator value
159
+ * @param parseNode The parse node to use to read the discriminator value and create the object
160
+ * @returns {CreateReviewRequest}
161
+ */
162
+ export declare function createCreateReviewRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
163
+ /**
164
+ * Creates a new instance of the appropriate class based on discriminator value
165
+ * @param parseNode The parse node to use to read the discriminator value and create the object
166
+ * @returns {Datacenter}
167
+ */
168
+ export declare function createDatacenterFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
169
+ /**
170
+ * Creates a new instance of the appropriate class based on discriminator value
171
+ * @param parseNode The parse node to use to read the discriminator value and create the object
172
+ * @returns {Incident_metadata}
173
+ */
174
+ export declare function createIncident_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
175
+ /**
176
+ * Creates a new instance of the appropriate class based on discriminator value
177
+ * @param parseNode The parse node to use to read the discriminator value and create the object
178
+ * @returns {Incident}
179
+ */
180
+ export declare function createIncidentFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
181
+ /**
182
+ * Payload to open a new incident.
183
+ */
184
+ export interface CreateIncidentRequest extends AdditionalDataHolder, Parsable {
185
+ /**
186
+ * Free-form details about the incident.
187
+ */
188
+ description?: string | null;
189
+ /**
190
+ * Email address of the person reporting the incident.
191
+ */
192
+ reporterEmail?: string | null;
193
+ /**
194
+ * Short title summarizing the incident.
195
+ */
196
+ subject?: string | null;
197
+ /**
198
+ * Identifier of the affected resource.
199
+ */
200
+ target?: string | null;
201
+ }
202
+ /**
203
+ * Creates a new instance of the appropriate class based on discriminator value
204
+ * @param parseNode The parse node to use to read the discriminator value and create the object
205
+ * @returns {IpInformation}
206
+ */
207
+ export declare function createIpInformationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
208
+ /**
209
+ * Creates a new instance of the appropriate class based on discriminator value
210
+ * @param parseNode The parse node to use to read the discriminator value and create the object
211
+ * @returns {IpRotationLinkResponse}
212
+ */
213
+ export declare function createIpRotationLinkResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
214
+ /**
215
+ * Creates a new instance of the appropriate class based on discriminator value
216
+ * @param parseNode The parse node to use to read the discriminator value and create the object
217
+ * @returns {Isp}
218
+ */
219
+ export declare function createIspFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
220
+ /**
221
+ * Creates a new instance of the appropriate class based on discriminator value
222
+ * @param parseNode The parse node to use to read the discriminator value and create the object
223
+ * @returns {Location}
224
+ */
225
+ export declare function createLocationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
226
+ /**
227
+ * Creates a new instance of the appropriate class based on discriminator value
228
+ * @param parseNode The parse node to use to read the discriminator value and create the object
229
+ * @returns {Order_metadata}
230
+ */
231
+ export declare function createOrder_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
232
+ /**
233
+ * Creates a new instance of the appropriate class based on discriminator value
234
+ * @param parseNode The parse node to use to read the discriminator value and create the object
235
+ * @returns {Order}
236
+ */
237
+ export declare function createOrderFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
238
+ /**
239
+ * Creates a new instance of the appropriate class based on discriminator value
240
+ * @param parseNode The parse node to use to read the discriminator value and create the object
241
+ * @returns {OrderItem_metadata}
242
+ */
243
+ export declare function createOrderItem_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
244
+ /**
245
+ * Creates a new instance of the appropriate class based on discriminator value
246
+ * @param parseNode The parse node to use to read the discriminator value and create the object
247
+ * @returns {OrderItem}
248
+ */
249
+ export declare function createOrderItemFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
250
+ /**
251
+ * Creates a new instance of the appropriate class based on discriminator value
252
+ * @param parseNode The parse node to use to read the discriminator value and create the object
253
+ * @returns {OrganizationBranding}
254
+ */
255
+ export declare function createOrganizationBrandingFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
256
+ /**
257
+ * Creates a new instance of the appropriate class based on discriminator value
258
+ * @param parseNode The parse node to use to read the discriminator value and create the object
259
+ * @returns {OrganizationStore}
260
+ */
261
+ export declare function createOrganizationStoreFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
262
+ /**
263
+ * Creates a new instance of the appropriate class based on discriminator value
264
+ * @param parseNode The parse node to use to read the discriminator value and create the object
265
+ * @returns {Product}
266
+ */
267
+ export declare function createProductFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
268
+ /**
269
+ * Creates a new instance of the appropriate class based on discriminator value
270
+ * @param parseNode The parse node to use to read the discriminator value and create the object
271
+ * @returns {ProxyCredentialResponse}
272
+ */
273
+ export declare function createProxyCredentialResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
274
+ /**
275
+ * Creates a new instance of the appropriate class based on discriminator value
276
+ * @param parseNode The parse node to use to read the discriminator value and create the object
277
+ * @returns {ProxyDatacenter}
278
+ */
279
+ export declare function createProxyDatacenterFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
280
+ /**
281
+ * Creates a new instance of the appropriate class based on discriminator value
282
+ * @param parseNode The parse node to use to read the discriminator value and create the object
283
+ * @returns {ProxyFeatures}
284
+ */
285
+ export declare function createProxyFeaturesFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
286
+ /**
287
+ * Creates a new instance of the appropriate class based on discriminator value
288
+ * @param parseNode The parse node to use to read the discriminator value and create the object
289
+ * @returns {Proxy}
290
+ */
291
+ export declare function createProxyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
292
+ /**
293
+ * Creates a new instance of the appropriate class based on discriminator value
294
+ * @param parseNode The parse node to use to read the discriminator value and create the object
295
+ * @returns {ProxyIpRotationFeature}
296
+ */
297
+ export declare function createProxyIpRotationFeatureFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
298
+ /**
299
+ * Creates a new instance of the appropriate class based on discriminator value
300
+ * @param parseNode The parse node to use to read the discriminator value and create the object
301
+ * @returns {ProxyIpRotationResponse}
302
+ */
303
+ export declare function createProxyIpRotationResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
304
+ /**
305
+ * Creates a new instance of the appropriate class based on discriminator value
306
+ * @param parseNode The parse node to use to read the discriminator value and create the object
307
+ * @returns {ProxyIsp}
308
+ */
309
+ export declare function createProxyIspFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
310
+ /**
311
+ * Creates a new instance of the appropriate class based on discriminator value
312
+ * @param parseNode The parse node to use to read the discriminator value and create the object
313
+ * @returns {ProxyLocation}
314
+ */
315
+ export declare function createProxyLocationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
316
+ /**
317
+ * Creates a new instance of the appropriate class based on discriminator value
318
+ * @param parseNode The parse node to use to read the discriminator value and create the object
319
+ * @returns {ProxyOptions_metadata}
320
+ */
321
+ export declare function createProxyOptions_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
322
+ /**
323
+ * Creates a new instance of the appropriate class based on discriminator value
324
+ * @param parseNode The parse node to use to read the discriminator value and create the object
325
+ * @returns {ProxyOptions}
326
+ */
327
+ export declare function createProxyOptionsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
328
+ /**
329
+ * Creates a new instance of the appropriate class based on discriminator value
330
+ * @param parseNode The parse node to use to read the discriminator value and create the object
331
+ * @returns {ProxyProduct}
332
+ */
333
+ export declare function createProxyProductFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
334
+ /**
335
+ * Creates a new instance of the appropriate class based on discriminator value
336
+ * @param parseNode The parse node to use to read the discriminator value and create the object
337
+ * @returns {RequestDetails}
338
+ */
339
+ export declare function createRequestDetailsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
340
+ /**
341
+ * Creates a new instance of the appropriate class based on discriminator value
342
+ * @param parseNode The parse node to use to read the discriminator value and create the object
343
+ * @returns {Review_metadata}
344
+ */
345
+ export declare function createReview_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
346
+ /**
347
+ * Creates a new instance of the appropriate class based on discriminator value
348
+ * @param parseNode The parse node to use to read the discriminator value and create the object
349
+ * @returns {Review}
350
+ */
351
+ export declare function createReviewFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
352
+ /**
353
+ * Payload to create a customer review.
354
+ */
355
+ export interface CreateReviewRequest extends AdditionalDataHolder, Parsable {
356
+ /**
357
+ * Body text of the review.
358
+ */
359
+ content?: string | null;
360
+ /**
361
+ * Display name for the reviewer, overriding the customer name or standing in for an anonymous review.
362
+ */
363
+ customAuthorName?: string | null;
364
+ /**
365
+ * Identifier of the customer who left the review. Null for anonymous reviews.
366
+ */
367
+ customerId?: Guid | null;
368
+ /**
369
+ * Whether the review is highlighted (for example pinned on a landing page). Defaults to false.
370
+ */
371
+ isFeatured?: boolean | null;
372
+ /**
373
+ * The star rating, from 1 to 5.
374
+ */
375
+ rating?: number | null;
376
+ }
377
+ /**
378
+ * Creates a new instance of the appropriate class based on discriminator value
379
+ * @param parseNode The parse node to use to read the discriminator value and create the object
380
+ * @returns {UpdateProxyCredentialsRequest}
381
+ */
382
+ export declare function createUpdateProxyCredentialsRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
383
+ /**
384
+ * Creates a new instance of the appropriate class based on discriminator value
385
+ * @param parseNode The parse node to use to read the discriminator value and create the object
386
+ * @returns {UpdateProxyIpRotationRequest}
387
+ */
388
+ export declare function createUpdateProxyIpRotationRequestFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
389
+ /**
390
+ * Catalog option for a single datacenter: a physical site proxies can be provisioned in.
391
+ */
392
+ export interface Datacenter extends AdditionalDataHolder, Parsable {
393
+ /**
394
+ * Count of proxies currently available (active and unallocated) behind this option.
395
+ */
396
+ availableProxies?: number | null;
397
+ /**
398
+ * Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
399
+ */
400
+ basePrice?: number | null;
401
+ /**
402
+ * ISO 3166-1 alpha-2 country code of the site, if known.
403
+ */
404
+ countryCode?: string | null;
405
+ /**
406
+ * Unique identifier of the catalog option.
407
+ */
408
+ id?: Guid | null;
409
+ /**
410
+ * Whether the current organization has hidden this option from its storefront.
411
+ */
412
+ isDisabled?: boolean | null;
413
+ /**
414
+ * Free-text location of the site (city/address), if known.
415
+ */
416
+ location?: string | null;
417
+ /**
418
+ * Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
419
+ */
420
+ name?: string | null;
421
+ /**
422
+ * Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
423
+ */
424
+ price?: number | null;
425
+ /**
426
+ * Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
427
+ */
428
+ retailPrice?: number | null;
429
+ }
430
+ /**
431
+ * The deserialization information for the current model
432
+ * @param Announcement The instance to deserialize into.
433
+ * @returns {Record<string, (node: ParseNode) => void>}
434
+ */
435
+ export declare function deserializeIntoAnnouncement(announcement?: Partial<Announcement> | undefined): Record<string, (node: ParseNode) => void>;
436
+ /**
437
+ * The deserialization information for the current model
438
+ * @param Announcement_metadata The instance to deserialize into.
439
+ * @returns {Record<string, (node: ParseNode) => void>}
440
+ */
441
+ export declare function deserializeIntoAnnouncement_metadata(announcement_metadata?: Partial<Announcement_metadata> | undefined): Record<string, (node: ParseNode) => void>;
442
+ /**
443
+ * The deserialization information for the current model
444
+ * @param ApiError The instance to deserialize into.
445
+ * @returns {Record<string, (node: ParseNode) => void>}
446
+ */
447
+ export declare function deserializeIntoApiError(apiError?: Partial<ApiError> | undefined): Record<string, (node: ParseNode) => void>;
448
+ /**
449
+ * The deserialization information for the current model
450
+ * @param ApiResponse The instance to deserialize into.
451
+ * @returns {Record<string, (node: ParseNode) => void>}
452
+ */
453
+ export declare function deserializeIntoApiResponse(apiResponse?: Partial<ApiResponse> | undefined): Record<string, (node: ParseNode) => void>;
454
+ /**
455
+ * The deserialization information for the current model
456
+ * @param Capability The instance to deserialize into.
457
+ * @returns {Record<string, (node: ParseNode) => void>}
458
+ */
459
+ export declare function deserializeIntoCapability(capability?: Partial<Capability> | undefined): Record<string, (node: ParseNode) => void>;
460
+ /**
461
+ * The deserialization information for the current model
462
+ * @param CreateIncidentRequest The instance to deserialize into.
463
+ * @returns {Record<string, (node: ParseNode) => void>}
464
+ */
465
+ export declare function deserializeIntoCreateIncidentRequest(createIncidentRequest?: Partial<CreateIncidentRequest> | undefined): Record<string, (node: ParseNode) => void>;
466
+ /**
467
+ * The deserialization information for the current model
468
+ * @param CreateReviewRequest The instance to deserialize into.
469
+ * @returns {Record<string, (node: ParseNode) => void>}
470
+ */
471
+ export declare function deserializeIntoCreateReviewRequest(createReviewRequest?: Partial<CreateReviewRequest> | undefined): Record<string, (node: ParseNode) => void>;
472
+ /**
473
+ * The deserialization information for the current model
474
+ * @param Datacenter The instance to deserialize into.
475
+ * @returns {Record<string, (node: ParseNode) => void>}
476
+ */
477
+ export declare function deserializeIntoDatacenter(datacenter?: Partial<Datacenter> | undefined): Record<string, (node: ParseNode) => void>;
478
+ /**
479
+ * The deserialization information for the current model
480
+ * @param Incident The instance to deserialize into.
481
+ * @returns {Record<string, (node: ParseNode) => void>}
482
+ */
483
+ export declare function deserializeIntoIncident(incident?: Partial<Incident> | undefined): Record<string, (node: ParseNode) => void>;
484
+ /**
485
+ * The deserialization information for the current model
486
+ * @param Incident_metadata The instance to deserialize into.
487
+ * @returns {Record<string, (node: ParseNode) => void>}
488
+ */
489
+ export declare function deserializeIntoIncident_metadata(incident_metadata?: Partial<Incident_metadata> | undefined): Record<string, (node: ParseNode) => void>;
490
+ /**
491
+ * The deserialization information for the current model
492
+ * @param IpInformation The instance to deserialize into.
493
+ * @returns {Record<string, (node: ParseNode) => void>}
494
+ */
495
+ export declare function deserializeIntoIpInformation(ipInformation?: Partial<IpInformation> | undefined): Record<string, (node: ParseNode) => void>;
496
+ /**
497
+ * The deserialization information for the current model
498
+ * @param IpRotationLinkResponse The instance to deserialize into.
499
+ * @returns {Record<string, (node: ParseNode) => void>}
500
+ */
501
+ export declare function deserializeIntoIpRotationLinkResponse(ipRotationLinkResponse?: Partial<IpRotationLinkResponse> | undefined): Record<string, (node: ParseNode) => void>;
502
+ /**
503
+ * The deserialization information for the current model
504
+ * @param Isp The instance to deserialize into.
505
+ * @returns {Record<string, (node: ParseNode) => void>}
506
+ */
507
+ export declare function deserializeIntoIsp(isp?: Partial<Isp> | undefined): Record<string, (node: ParseNode) => void>;
508
+ /**
509
+ * The deserialization information for the current model
510
+ * @param Location The instance to deserialize into.
511
+ * @returns {Record<string, (node: ParseNode) => void>}
512
+ */
513
+ export declare function deserializeIntoLocation(location?: Partial<Location> | undefined): Record<string, (node: ParseNode) => void>;
514
+ /**
515
+ * The deserialization information for the current model
516
+ * @param Order The instance to deserialize into.
517
+ * @returns {Record<string, (node: ParseNode) => void>}
518
+ */
519
+ export declare function deserializeIntoOrder(order?: Partial<Order> | undefined): Record<string, (node: ParseNode) => void>;
520
+ /**
521
+ * The deserialization information for the current model
522
+ * @param Order_metadata The instance to deserialize into.
523
+ * @returns {Record<string, (node: ParseNode) => void>}
524
+ */
525
+ export declare function deserializeIntoOrder_metadata(order_metadata?: Partial<Order_metadata> | undefined): Record<string, (node: ParseNode) => void>;
526
+ /**
527
+ * The deserialization information for the current model
528
+ * @param OrderItem The instance to deserialize into.
529
+ * @returns {Record<string, (node: ParseNode) => void>}
530
+ */
531
+ export declare function deserializeIntoOrderItem(orderItem?: Partial<OrderItem> | undefined): Record<string, (node: ParseNode) => void>;
532
+ /**
533
+ * The deserialization information for the current model
534
+ * @param OrderItem_metadata The instance to deserialize into.
535
+ * @returns {Record<string, (node: ParseNode) => void>}
536
+ */
537
+ export declare function deserializeIntoOrderItem_metadata(orderItem_metadata?: Partial<OrderItem_metadata> | undefined): Record<string, (node: ParseNode) => void>;
538
+ /**
539
+ * The deserialization information for the current model
540
+ * @param OrganizationBranding The instance to deserialize into.
541
+ * @returns {Record<string, (node: ParseNode) => void>}
542
+ */
543
+ export declare function deserializeIntoOrganizationBranding(organizationBranding?: Partial<OrganizationBranding> | undefined): Record<string, (node: ParseNode) => void>;
544
+ /**
545
+ * The deserialization information for the current model
546
+ * @param OrganizationStore The instance to deserialize into.
547
+ * @returns {Record<string, (node: ParseNode) => void>}
548
+ */
549
+ export declare function deserializeIntoOrganizationStore(organizationStore?: Partial<OrganizationStore> | undefined): Record<string, (node: ParseNode) => void>;
550
+ /**
551
+ * The deserialization information for the current model
552
+ * @param Product The instance to deserialize into.
553
+ * @returns {Record<string, (node: ParseNode) => void>}
554
+ */
555
+ export declare function deserializeIntoProduct(product?: Partial<Product> | undefined): Record<string, (node: ParseNode) => void>;
556
+ /**
557
+ * The deserialization information for the current model
558
+ * @param Proxy The instance to deserialize into.
559
+ * @returns {Record<string, (node: ParseNode) => void>}
560
+ */
561
+ export declare function deserializeIntoProxy(proxy?: Partial<Proxy> | undefined): Record<string, (node: ParseNode) => void>;
562
+ /**
563
+ * The deserialization information for the current model
564
+ * @param ProxyCredentialResponse The instance to deserialize into.
565
+ * @returns {Record<string, (node: ParseNode) => void>}
566
+ */
567
+ export declare function deserializeIntoProxyCredentialResponse(proxyCredentialResponse?: Partial<ProxyCredentialResponse> | undefined): Record<string, (node: ParseNode) => void>;
568
+ /**
569
+ * The deserialization information for the current model
570
+ * @param ProxyDatacenter The instance to deserialize into.
571
+ * @returns {Record<string, (node: ParseNode) => void>}
572
+ */
573
+ export declare function deserializeIntoProxyDatacenter(proxyDatacenter?: Partial<ProxyDatacenter> | undefined): Record<string, (node: ParseNode) => void>;
574
+ /**
575
+ * The deserialization information for the current model
576
+ * @param ProxyFeatures The instance to deserialize into.
577
+ * @returns {Record<string, (node: ParseNode) => void>}
578
+ */
579
+ export declare function deserializeIntoProxyFeatures(proxyFeatures?: Partial<ProxyFeatures> | undefined): Record<string, (node: ParseNode) => void>;
580
+ /**
581
+ * The deserialization information for the current model
582
+ * @param ProxyIpRotationFeature The instance to deserialize into.
583
+ * @returns {Record<string, (node: ParseNode) => void>}
584
+ */
585
+ export declare function deserializeIntoProxyIpRotationFeature(proxyIpRotationFeature?: Partial<ProxyIpRotationFeature> | undefined): Record<string, (node: ParseNode) => void>;
586
+ /**
587
+ * The deserialization information for the current model
588
+ * @param ProxyIpRotationResponse The instance to deserialize into.
589
+ * @returns {Record<string, (node: ParseNode) => void>}
590
+ */
591
+ export declare function deserializeIntoProxyIpRotationResponse(proxyIpRotationResponse?: Partial<ProxyIpRotationResponse> | undefined): Record<string, (node: ParseNode) => void>;
592
+ /**
593
+ * The deserialization information for the current model
594
+ * @param ProxyIsp The instance to deserialize into.
595
+ * @returns {Record<string, (node: ParseNode) => void>}
596
+ */
597
+ export declare function deserializeIntoProxyIsp(proxyIsp?: Partial<ProxyIsp> | undefined): Record<string, (node: ParseNode) => void>;
598
+ /**
599
+ * The deserialization information for the current model
600
+ * @param ProxyLocation The instance to deserialize into.
601
+ * @returns {Record<string, (node: ParseNode) => void>}
602
+ */
603
+ export declare function deserializeIntoProxyLocation(proxyLocation?: Partial<ProxyLocation> | undefined): Record<string, (node: ParseNode) => void>;
604
+ /**
605
+ * The deserialization information for the current model
606
+ * @param ProxyOptions The instance to deserialize into.
607
+ * @returns {Record<string, (node: ParseNode) => void>}
608
+ */
609
+ export declare function deserializeIntoProxyOptions(proxyOptions?: Partial<ProxyOptions> | undefined): Record<string, (node: ParseNode) => void>;
610
+ /**
611
+ * The deserialization information for the current model
612
+ * @param ProxyOptions_metadata The instance to deserialize into.
613
+ * @returns {Record<string, (node: ParseNode) => void>}
614
+ */
615
+ export declare function deserializeIntoProxyOptions_metadata(proxyOptions_metadata?: Partial<ProxyOptions_metadata> | undefined): Record<string, (node: ParseNode) => void>;
616
+ /**
617
+ * The deserialization information for the current model
618
+ * @param ProxyProduct The instance to deserialize into.
619
+ * @returns {Record<string, (node: ParseNode) => void>}
620
+ */
621
+ export declare function deserializeIntoProxyProduct(proxyProduct?: Partial<ProxyProduct> | undefined): Record<string, (node: ParseNode) => void>;
622
+ /**
623
+ * The deserialization information for the current model
624
+ * @param RequestDetails The instance to deserialize into.
625
+ * @returns {Record<string, (node: ParseNode) => void>}
626
+ */
627
+ export declare function deserializeIntoRequestDetails(requestDetails?: Partial<RequestDetails> | undefined): Record<string, (node: ParseNode) => void>;
628
+ /**
629
+ * The deserialization information for the current model
630
+ * @param Review The instance to deserialize into.
631
+ * @returns {Record<string, (node: ParseNode) => void>}
632
+ */
633
+ export declare function deserializeIntoReview(review?: Partial<Review> | undefined): Record<string, (node: ParseNode) => void>;
634
+ /**
635
+ * The deserialization information for the current model
636
+ * @param Review_metadata The instance to deserialize into.
637
+ * @returns {Record<string, (node: ParseNode) => void>}
638
+ */
639
+ export declare function deserializeIntoReview_metadata(review_metadata?: Partial<Review_metadata> | undefined): Record<string, (node: ParseNode) => void>;
640
+ /**
641
+ * The deserialization information for the current model
642
+ * @param UpdateProxyCredentialsRequest The instance to deserialize into.
643
+ * @returns {Record<string, (node: ParseNode) => void>}
644
+ */
645
+ export declare function deserializeIntoUpdateProxyCredentialsRequest(updateProxyCredentialsRequest?: Partial<UpdateProxyCredentialsRequest> | undefined): Record<string, (node: ParseNode) => void>;
646
+ /**
647
+ * The deserialization information for the current model
648
+ * @param UpdateProxyIpRotationRequest The instance to deserialize into.
649
+ * @returns {Record<string, (node: ParseNode) => void>}
650
+ */
651
+ export declare function deserializeIntoUpdateProxyIpRotationRequest(updateProxyIpRotationRequest?: Partial<UpdateProxyIpRotationRequest> | undefined): Record<string, (node: ParseNode) => void>;
652
+ /**
653
+ * 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.
654
+ */
655
+ export interface Incident extends AdditionalDataHolder, Parsable {
656
+ /**
657
+ * Full text of the complaint, null when none was provided.
658
+ */
659
+ description?: string | null;
660
+ /**
661
+ * The id property
662
+ */
663
+ id?: Guid | null;
664
+ /**
665
+ * True when the incident is still open and was created more than TimeSpan Incident.DefaultOverdueAfter ago.
666
+ */
667
+ isOverdue?: boolean | null;
668
+ /**
669
+ * The metadata property
670
+ */
671
+ metadata?: Incident_metadata | null;
672
+ /**
673
+ * Why the target went down, picked from the predefined reasons when the incident is resolved.
674
+ */
675
+ reason?: string | null;
676
+ /**
677
+ * Email of the customer who reported the incident.
678
+ */
679
+ reporterEmail?: string | null;
680
+ /**
681
+ * Message written for the customer at resolution, surfaced to them (e.g. by email) later.
682
+ */
683
+ resolutionNote?: string | null;
684
+ /**
685
+ * When the incident was resolved, null while it is still open.
686
+ */
687
+ resolvedAt?: Date | null;
688
+ /**
689
+ * Lifecycle state of the incident (open, resolved, etc.).
690
+ */
691
+ status?: IncidentStatuses | null;
692
+ /**
693
+ * Short one-line title of the complaint.
694
+ */
695
+ subject?: string | null;
696
+ /**
697
+ * Identifier of the affected proxy (hostname:port).
698
+ */
699
+ target?: string | null;
700
+ }
701
+ export interface Incident_metadata extends AdditionalDataHolder, Parsable {
702
+ }
703
+ export type IncidentStatuses = (typeof IncidentStatusesObject)[keyof typeof IncidentStatusesObject];
704
+ export interface IpInformation extends AdditionalDataHolder, Parsable {
705
+ /**
706
+ * The asn property
707
+ */
708
+ asn?: string | null;
709
+ /**
710
+ * The asnDomain property
711
+ */
712
+ asnDomain?: string | null;
713
+ /**
714
+ * The asnLogo property
715
+ */
716
+ asnLogo?: string | null;
717
+ /**
718
+ * The continent property
719
+ */
720
+ continent?: string | null;
721
+ /**
722
+ * The continentCode property
723
+ */
724
+ continentCode?: string | null;
725
+ /**
726
+ * The country property
727
+ */
728
+ country?: string | null;
729
+ /**
730
+ * The countryCode property
731
+ */
732
+ countryCode?: string | null;
733
+ /**
734
+ * The countryFlag property
735
+ */
736
+ countryFlag?: string | null;
737
+ /**
738
+ * The countryFlagUrl property
739
+ */
740
+ countryFlagUrl?: string | null;
741
+ /**
742
+ * The currencyCode property
743
+ */
744
+ currencyCode?: string | null;
745
+ /**
746
+ * The currencySymbol property
747
+ */
748
+ currencySymbol?: string | null;
749
+ /**
750
+ * The ipAddress property
751
+ */
752
+ ipAddress?: string | null;
753
+ /**
754
+ * The isAnycast property
755
+ */
756
+ isAnycast?: boolean | null;
757
+ /**
758
+ * The isp property
759
+ */
760
+ isp?: string | null;
761
+ }
762
+ /**
763
+ * A self-contained IP rotation link for a proxy: the raw token plus the ready-to-use link.
764
+ */
765
+ export interface IpRotationLinkResponse extends AdditionalDataHolder, Parsable {
766
+ /**
767
+ * The IP rotation link served on the organization's IP rotation domain (its own, or the default).
768
+ */
769
+ link?: string | null;
770
+ /**
771
+ * The IP rotation token (a protected customer id). Use it to build your own link if needed.
772
+ */
773
+ token?: string | null;
774
+ }
775
+ /**
776
+ * Internet service provider a proxy routes through.
777
+ */
778
+ export interface Isp extends AdditionalDataHolder, Parsable {
779
+ /**
780
+ * Count of proxies currently available (active and unallocated) behind this option.
781
+ */
782
+ availableProxies?: number | null;
783
+ /**
784
+ * Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
785
+ */
786
+ basePrice?: number | null;
787
+ /**
788
+ * Unique identifier of the catalog option.
789
+ */
790
+ id?: Guid | null;
791
+ /**
792
+ * Whether the current organization has hidden this option from its storefront.
793
+ */
794
+ isDisabled?: boolean | null;
795
+ /**
796
+ * Absolute URL of the ISP logo, null when none is set.
797
+ */
798
+ logoUrl?: string | null;
799
+ /**
800
+ * Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
801
+ */
802
+ name?: string | null;
803
+ /**
804
+ * Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
805
+ */
806
+ price?: number | null;
807
+ /**
808
+ * Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
809
+ */
810
+ retailPrice?: number | null;
811
+ }
812
+ /**
813
+ * A geographic location available in the catalog, granular to a city or a country.
814
+ */
815
+ export interface Location extends AdditionalDataHolder, Parsable {
816
+ /**
817
+ * Number of ISPs that cover this location.
818
+ */
819
+ availableIsps?: number | null;
820
+ /**
821
+ * Count of proxies currently available (active and unallocated) behind this option.
822
+ */
823
+ availableProxies?: number | null;
824
+ /**
825
+ * Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
826
+ */
827
+ basePrice?: number | null;
828
+ /**
829
+ * Name of the city, null when the location is country or region granular.
830
+ */
831
+ city?: string | null;
832
+ /**
833
+ * ISO 3166-1 alpha-2 country code of the location.
834
+ */
835
+ countryCode?: string | null;
836
+ /**
837
+ * Unique identifier of the catalog option.
838
+ */
839
+ id?: Guid | null;
840
+ /**
841
+ * Whether the current organization has hidden this option from its storefront.
842
+ */
843
+ isDisabled?: boolean | null;
844
+ /**
845
+ * Display name of the location: the city when city-granular, otherwise the country code.
846
+ */
847
+ name?: string | null;
848
+ /**
849
+ * Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
850
+ */
851
+ price?: number | null;
852
+ /**
853
+ * Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
854
+ */
855
+ retailPrice?: number | null;
856
+ }
857
+ /**
858
+ * An order placed by an organization, owning its lifecycle: the products it holds (its ICollection&lt;OrderItem&gt; 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.
859
+ */
860
+ export interface Order extends AdditionalDataHolder, Parsable {
861
+ /**
862
+ * The billingCycle property
863
+ */
864
+ billingCycle?: BillingCycles | null;
865
+ /**
866
+ * Organization's own end user the order belongs to, if any.
867
+ */
868
+ customerId?: Guid | null;
869
+ /**
870
+ * When the order expires. Persisted so the status can be computed from it without a background worker.
871
+ */
872
+ expiresAt?: Date | null;
873
+ /**
874
+ * 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.
875
+ */
876
+ externalReference?: string | null;
877
+ /**
878
+ * The id property
879
+ */
880
+ id?: Guid | null;
881
+ /**
882
+ * 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.
883
+ */
884
+ intent?: OrderIntents | null;
885
+ /**
886
+ * 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.
887
+ */
888
+ isActive?: boolean | null;
889
+ /**
890
+ * 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.
891
+ */
892
+ isAutoRenew?: boolean | null;
893
+ /**
894
+ * 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.
895
+ */
896
+ isExpiringSoon?: boolean | null;
897
+ /**
898
+ * 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.
899
+ */
900
+ isInactive?: boolean | null;
901
+ /**
902
+ * Whether the order is a trial.
903
+ */
904
+ isTrial?: boolean | null;
905
+ /**
906
+ * Line items the order is made of, one per product bought. Each item carries its product, quantity and the resources delivered for it.
907
+ */
908
+ items?: OrderItem[] | null;
909
+ /**
910
+ * 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.
911
+ */
912
+ lastSettlementReference?: string | null;
913
+ /**
914
+ * The `BalanceTransaction` that last paid this order from the organization's balance (its creation or its most recent extension). Lets a refund credit back exactly that payment without re-deriving its amount. Null for orders paid through a processor (Stripe, crypto) or for trials.
915
+ */
916
+ lastTransactionId?: Guid | null;
917
+ /**
918
+ * The metadata property
919
+ */
920
+ metadata?: Order_metadata | null;
921
+ /**
922
+ * The paymentMethod property
923
+ */
924
+ paymentMethod?: PaymentMethods | null;
925
+ /**
926
+ * The paymentProcessor property
927
+ */
928
+ paymentProcessor?: PaymentProcessors | null;
929
+ /**
930
+ * Opaque handle at the processor (a Stripe `sub_...` or `pi_...`, a Heleket reference).
931
+ */
932
+ processorReference?: string | null;
933
+ /**
934
+ * Total units ordered, summed over the items' quantities and not stored. Requires ICollection&lt;OrderItem&gt; Order.Items to be loaded.
935
+ */
936
+ quantity?: number | null;
937
+ /**
938
+ * 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.
939
+ */
940
+ status?: OrderStatuses | null;
941
+ }
942
+ export interface Order_metadata extends AdditionalDataHolder, Parsable {
943
+ }
944
+ export type OrderIntents = (typeof OrderIntentsObject)[keyof typeof OrderIntentsObject];
945
+ /**
946
+ * One line of an Order? OrderItem.Order: a product bought in a given quantity, with the resources delivered for it.
947
+ */
948
+ export interface OrderItem extends AdditionalDataHolder, Parsable {
949
+ /**
950
+ * The id property
951
+ */
952
+ id?: Guid | null;
953
+ /**
954
+ * Kind of resource this line's product delivers (proxy or host).
955
+ */
956
+ kind?: ProductKinds | null;
957
+ /**
958
+ * The metadata property
959
+ */
960
+ metadata?: OrderItem_metadata | null;
961
+ /**
962
+ * Identifier of the product this line orders.
963
+ */
964
+ productId?: Guid | null;
965
+ /**
966
+ * 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.
967
+ */
968
+ resourceIds?: Guid[] | null;
969
+ }
970
+ export interface OrderItem_metadata extends AdditionalDataHolder, Parsable {
971
+ }
972
+ export type OrderStatuses = (typeof OrderStatusesObject)[keyof typeof OrderStatusesObject];
973
+ /**
974
+ * White-label branding for an organization (colors, logos, icon). A value object owned byOrganization with no identity of its own. All fields optional.Naming convention: an organization's sub-aspects are `Organization&lt;Aspect&gt;` value objectsexposed as a same-named property on Organization (e.g. this `Branding`, or a future`OrganizationBilling` as `Billing`). Same shape every time.
975
+ */
976
+ export interface OrganizationBranding extends AdditionalDataHolder, Parsable {
977
+ /**
978
+ * Accent color as a hex string (e.g. "#4F46E5"), used to theme the reseller's UI.
979
+ */
980
+ accentColor?: string | null;
981
+ /**
982
+ * Icon / favicon (URL).
983
+ */
984
+ iconUrl?: string | null;
985
+ /**
986
+ * Single logo to fall back on: the light variant if set, otherwise the dark one.
987
+ */
988
+ logo?: string | null;
989
+ /**
990
+ * Logo shown on dark backgrounds (URL).
991
+ */
992
+ logoDarkUrl?: string | null;
993
+ /**
994
+ * Logo shown on light backgrounds (URL).
995
+ */
996
+ logoLightUrl?: string | null;
997
+ }
998
+ /**
999
+ * An organization's white-label store: the customer-facing storefront served under its own domain. A valueobject owned by Organization with no identity of its own; an organization has at most one, andit is null until a store is created. Follows the same convention as OrganizationBranding andOrganizationBilling: an `Organization&lt;Aspect&gt;` value object exposed as a same-namedproperty on Organization (here `Store`).
1000
+ */
1001
+ export interface OrganizationStore extends AdditionalDataHolder, Parsable {
1002
+ /**
1003
+ * Crisp workspace id for the store's live chat.
1004
+ */
1005
+ crispWorkspaceId?: string | null;
1006
+ /**
1007
+ * Custom CSS injected into the store's pages.
1008
+ */
1009
+ customCss?: string | null;
1010
+ /**
1011
+ * Custom JavaScript injected into the store's pages.
1012
+ */
1013
+ customJs?: string | null;
1014
+ /**
1015
+ * Store documentation shown to customers, as markdown.
1016
+ */
1017
+ documentationMd?: string | null;
1018
+ /**
1019
+ * Domain or subdomain the store is served on.
1020
+ */
1021
+ domain?: string | null;
1022
+ /**
1023
+ * Store name shown to customers.
1024
+ */
1025
+ name?: string | null;
1026
+ /**
1027
+ * Whether the store shows the documentation tab.
1028
+ */
1029
+ showDocumentationTab?: boolean | null;
1030
+ /**
1031
+ * Whether the store shows the reviews tab.
1032
+ */
1033
+ showReviewsTab?: boolean | null;
1034
+ /**
1035
+ * Link to the reseller's support channel, such as Telegram or Discord.
1036
+ */
1037
+ supportUrl?: string | null;
1038
+ /**
1039
+ * Short tagline shown on the store.
1040
+ */
1041
+ tagline?: string | null;
1042
+ /**
1043
+ * Message shown in the store's top banner; empty/null hides the banner.
1044
+ */
1045
+ topBannerMessage?: string | null;
1046
+ }
1047
+ export type PaymentMethods = (typeof PaymentMethodsObject)[keyof typeof PaymentMethodsObject];
1048
+ export type PaymentProcessors = (typeof PaymentProcessorsObject)[keyof typeof PaymentProcessorsObject];
1049
+ export type PricingTypes = (typeof PricingTypesObject)[keyof typeof PricingTypesObject];
1050
+ /**
1051
+ * 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.
1052
+ */
1053
+ export interface Product extends AdditionalDataHolder, Parsable {
1054
+ /**
1055
+ * Count of proxies currently available (active and unallocated) behind this option.
1056
+ */
1057
+ availableProxies?: number | null;
1058
+ /**
1059
+ * Catalog list price of the option, before the organization's commercial terms. Shown as the struck-through reference next to decimal CatalogOption.Price.
1060
+ */
1061
+ basePrice?: number | null;
1062
+ /**
1063
+ * Short marketing description of the product shown in the catalog.
1064
+ */
1065
+ description?: string | null;
1066
+ /**
1067
+ * Unique identifier of the catalog option.
1068
+ */
1069
+ id?: Guid | null;
1070
+ /**
1071
+ * Whether the current organization has hidden this option from its storefront.
1072
+ */
1073
+ isDisabled?: boolean | null;
1074
+ /**
1075
+ * Kind of resource this product delivers (proxy, host).
1076
+ */
1077
+ kind?: ProductKinds | null;
1078
+ /**
1079
+ * Display name of the option (ISP, datacenter, capability or product name; a location uses its city or country).
1080
+ */
1081
+ name?: string | null;
1082
+ /**
1083
+ * Price the organization pays for this option: its custom override when set, otherwise the base price after its reseller discount.
1084
+ */
1085
+ price?: number | null;
1086
+ /**
1087
+ * How the product is billed.
1088
+ */
1089
+ pricingType?: PricingTypes | null;
1090
+ /**
1091
+ * Price the organization resells this option at to its own customers (its decimal CatalogOption.Price plus margin), shown on the white-label store.
1092
+ */
1093
+ retailPrice?: number | null;
1094
+ }
1095
+ export type ProductKinds = (typeof ProductKindsObject)[keyof typeof ProductKindsObject];
1096
+ /**
1097
+ * Connection details for a proxy an organization owns (one of its allocations).
1098
+ */
1099
+ export interface Proxy extends AdditionalDataHolder, Parsable {
1100
+ /**
1101
+ * The optional capabilities the proxy exposes (e.g. IPv6, IP scoring).
1102
+ */
1103
+ capabilities?: CapabilityTypes[] | null;
1104
+ /**
1105
+ * The datacenter property
1106
+ */
1107
+ datacenter?: ProxyDatacenter | null;
1108
+ /**
1109
+ * The optional features configured on the proxy (IP rotation, ...).
1110
+ */
1111
+ features?: ProxyFeatures | null;
1112
+ /**
1113
+ * Hostname to connect to, with the reseller-facing datacenter label (e.g. `fr3.acme.com`).
1114
+ */
1115
+ host?: string | null;
1116
+ /**
1117
+ * Identifier of the proxy.
1118
+ */
1119
+ id?: Guid | null;
1120
+ /**
1121
+ * Resolved IP address.
1122
+ */
1123
+ ip?: string | null;
1124
+ /**
1125
+ * The isp property
1126
+ */
1127
+ isp?: ProxyIsp | null;
1128
+ /**
1129
+ * The location property
1130
+ */
1131
+ location?: ProxyLocation | null;
1132
+ /**
1133
+ * The organization's free-form note for this proxy, when it has annotated it.
1134
+ */
1135
+ note?: string | null;
1136
+ /**
1137
+ * Connection port.
1138
+ */
1139
+ port?: number | null;
1140
+ /**
1141
+ * The product property
1142
+ */
1143
+ product?: ProxyProduct | null;
1144
+ /**
1145
+ * The organization's tags for this proxy (empty when none).
1146
+ */
1147
+ tags?: string[] | null;
1148
+ }
1149
+ /**
1150
+ * 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.
1151
+ */
1152
+ export interface ProxyCredentialResponse extends AdditionalDataHolder, Parsable {
1153
+ /**
1154
+ * Domains the proxy is permitted to reach. Empty when no domain allowlist applies.
1155
+ */
1156
+ allowedDomains?: string[] | null;
1157
+ /**
1158
+ * IP addresses allowed to connect through the proxy. Empty when access is not restricted by IP.
1159
+ */
1160
+ allowedIps?: string[] | null;
1161
+ /**
1162
+ * Instant these credentials were applied to the proxy in Vault.
1163
+ */
1164
+ appliedAt?: Date | null;
1165
+ /**
1166
+ * Password used to authenticate against the proxy. Null when no credentials are stored yet.
1167
+ */
1168
+ password?: string | null;
1169
+ /**
1170
+ * Username used to authenticate against the proxy. Null when no credentials are stored yet.
1171
+ */
1172
+ username?: string | null;
1173
+ }
1174
+ /**
1175
+ * The datacenter a proxy lives in.
1176
+ */
1177
+ export interface ProxyDatacenter extends AdditionalDataHolder, Parsable {
1178
+ /**
1179
+ * Identifier of the datacenter, to refetch or reorder it.
1180
+ */
1181
+ id?: Guid | null;
1182
+ /**
1183
+ * Name of the datacenter, when known.
1184
+ */
1185
+ name?: string | null;
1186
+ }
1187
+ /**
1188
+ * The optional features configured on a proxy. A feature is null when it isn't active.
1189
+ */
1190
+ export interface ProxyFeatures extends AdditionalDataHolder, Parsable {
1191
+ /**
1192
+ * The ipRotation property
1193
+ */
1194
+ ipRotation?: ProxyIpRotationFeature | null;
1195
+ }
1196
+ /**
1197
+ * An active IP-rotation schedule on a proxy.
1198
+ */
1199
+ export interface ProxyIpRotationFeature extends AdditionalDataHolder, Parsable {
1200
+ /**
1201
+ * Rotation interval in whole minutes.
1202
+ */
1203
+ intervalMinutes?: number | null;
1204
+ /**
1205
+ * Rotation interval in whole seconds.
1206
+ */
1207
+ intervalSeconds?: number | null;
1208
+ }
1209
+ /**
1210
+ * 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.
1211
+ */
1212
+ export interface ProxyIpRotationResponse extends AdditionalDataHolder, Parsable {
1213
+ /**
1214
+ * Interval between IP rotations, in whole minutes.
1215
+ */
1216
+ intervalMinutes?: number | null;
1217
+ /**
1218
+ * Interval between IP rotations, in seconds.
1219
+ */
1220
+ intervalSeconds?: number | null;
1221
+ }
1222
+ /**
1223
+ * A proxy's ISP.
1224
+ */
1225
+ export interface ProxyIsp extends AdditionalDataHolder, Parsable {
1226
+ /**
1227
+ * Identifier of the ISP, to refetch or reorder it.
1228
+ */
1229
+ id?: Guid | null;
1230
+ /**
1231
+ * Logo URL of the ISP, when known.
1232
+ */
1233
+ logoUrl?: string | null;
1234
+ /**
1235
+ * Name of the ISP, when known.
1236
+ */
1237
+ name?: string | null;
1238
+ }
1239
+ /**
1240
+ * Where a proxy is located.
1241
+ */
1242
+ export interface ProxyLocation extends AdditionalDataHolder, Parsable {
1243
+ /**
1244
+ * City, when known.
1245
+ */
1246
+ city?: string | null;
1247
+ /**
1248
+ * ISO 3166-1 alpha-2 country code (e.g. `FR`), when known.
1249
+ */
1250
+ countryCode?: string | null;
1251
+ /**
1252
+ * Identifier of the location, to refetch or reorder it.
1253
+ */
1254
+ id?: Guid | null;
1255
+ }
1256
+ /**
1257
+ * 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.
1258
+ */
1259
+ export interface ProxyOptions extends AdditionalDataHolder, Parsable {
1260
+ /**
1261
+ * The id property
1262
+ */
1263
+ id?: Guid | null;
1264
+ /**
1265
+ * The metadata property
1266
+ */
1267
+ metadata?: ProxyOptions_metadata | null;
1268
+ /**
1269
+ * The inventory proxy these options are about. No foreign key: proxies aren't stored locally.
1270
+ */
1271
+ proxyId?: Guid | null;
1272
+ /**
1273
+ * How the proxy resolves addresses. The non-default modes need the proxy's IPv6 capability.
1274
+ */
1275
+ resolutionMode?: ResolutionModes | null;
1276
+ }
1277
+ export interface ProxyOptions_metadata extends AdditionalDataHolder, Parsable {
1278
+ }
1279
+ /**
1280
+ * The catalog product a proxy was ordered as: the head of the cascade down to location, ISP and datacenter.
1281
+ */
1282
+ export interface ProxyProduct extends AdditionalDataHolder, Parsable {
1283
+ /**
1284
+ * Identifier of the product, to refetch or reorder it.
1285
+ */
1286
+ id?: Guid | null;
1287
+ /**
1288
+ * Kind of resource the product delivers (proxy, host).
1289
+ */
1290
+ kind?: ProductKinds | null;
1291
+ /**
1292
+ * Name of the product.
1293
+ */
1294
+ name?: string | null;
1295
+ }
1296
+ export interface RequestDetails extends AdditionalDataHolder, Parsable {
1297
+ /**
1298
+ * The clientIp property
1299
+ */
1300
+ clientIp?: string | null;
1301
+ /**
1302
+ * The correlationId property
1303
+ */
1304
+ correlationId?: string | null;
1305
+ /**
1306
+ * The date property
1307
+ */
1308
+ date?: Date | null;
1309
+ /**
1310
+ * The endpoint property
1311
+ */
1312
+ endpoint?: string | null;
1313
+ /**
1314
+ * The timestamp property
1315
+ */
1316
+ timestamp?: number | null;
1317
+ /**
1318
+ * The userAgent property
1319
+ */
1320
+ userAgent?: string | null;
1321
+ }
1322
+ export type ResolutionModes = (typeof ResolutionModesObject)[keyof typeof ResolutionModesObject];
1323
+ /**
1324
+ * 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.
1325
+ */
1326
+ export interface Review extends AdditionalDataHolder, Parsable {
1327
+ /**
1328
+ * 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).
1329
+ */
1330
+ authorName?: string | null;
1331
+ /**
1332
+ * The review text.
1333
+ */
1334
+ content?: string | null;
1335
+ /**
1336
+ * 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.
1337
+ */
1338
+ customAuthorName?: string | null;
1339
+ /**
1340
+ * Id of the customer who left the review when it is tied to a known one, or null for anonymous reviews.
1341
+ */
1342
+ customerId?: Guid | null;
1343
+ /**
1344
+ * The id property
1345
+ */
1346
+ id?: Guid | null;
1347
+ /**
1348
+ * Whether the review is highlighted (e.g. pinned on a landing page). Defaults to false.
1349
+ */
1350
+ isFeatured?: boolean | null;
1351
+ /**
1352
+ * Whether the review awaits moderation: true until approved, and only non-pending reviews show publicly (rejecting one deletes it).
1353
+ */
1354
+ isPending?: boolean | null;
1355
+ /**
1356
+ * The metadata property
1357
+ */
1358
+ metadata?: Review_metadata | null;
1359
+ /**
1360
+ * The star rating, from 1 to 5.
1361
+ */
1362
+ rating?: number | null;
1363
+ }
1364
+ export interface Review_metadata extends AdditionalDataHolder, Parsable {
1365
+ }
1366
+ /**
1367
+ * Serializes information the current object
1368
+ * @param Announcement The instance to serialize from.
1369
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1370
+ * @param writer Serialization writer to use to serialize this model
1371
+ */
1372
+ export declare function serializeAnnouncement(writer: SerializationWriter, announcement?: Partial<Announcement> | undefined | null, isSerializingDerivedType?: boolean): void;
1373
+ /**
1374
+ * Serializes information the current object
1375
+ * @param Announcement_metadata The instance to serialize from.
1376
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1377
+ * @param writer Serialization writer to use to serialize this model
1378
+ */
1379
+ export declare function serializeAnnouncement_metadata(writer: SerializationWriter, announcement_metadata?: Partial<Announcement_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
1380
+ /**
1381
+ * Serializes information the current object
1382
+ * @param ApiError The instance to serialize from.
1383
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1384
+ * @param writer Serialization writer to use to serialize this model
1385
+ */
1386
+ export declare function serializeApiError(writer: SerializationWriter, apiError?: Partial<ApiError> | undefined | null, isSerializingDerivedType?: boolean): void;
1387
+ /**
1388
+ * Serializes information the current object
1389
+ * @param ApiResponse The instance to serialize from.
1390
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1391
+ * @param writer Serialization writer to use to serialize this model
1392
+ */
1393
+ export declare function serializeApiResponse(writer: SerializationWriter, apiResponse?: Partial<ApiResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
1394
+ /**
1395
+ * Serializes information the current object
1396
+ * @param Capability The instance to serialize from.
1397
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1398
+ * @param writer Serialization writer to use to serialize this model
1399
+ */
1400
+ export declare function serializeCapability(writer: SerializationWriter, capability?: Partial<Capability> | undefined | null, isSerializingDerivedType?: boolean): void;
1401
+ /**
1402
+ * Serializes information the current object
1403
+ * @param CreateIncidentRequest The instance to serialize from.
1404
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1405
+ * @param writer Serialization writer to use to serialize this model
1406
+ */
1407
+ export declare function serializeCreateIncidentRequest(writer: SerializationWriter, createIncidentRequest?: Partial<CreateIncidentRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
1408
+ /**
1409
+ * Serializes information the current object
1410
+ * @param CreateReviewRequest The instance to serialize from.
1411
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1412
+ * @param writer Serialization writer to use to serialize this model
1413
+ */
1414
+ export declare function serializeCreateReviewRequest(writer: SerializationWriter, createReviewRequest?: Partial<CreateReviewRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
1415
+ /**
1416
+ * Serializes information the current object
1417
+ * @param Datacenter The instance to serialize from.
1418
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1419
+ * @param writer Serialization writer to use to serialize this model
1420
+ */
1421
+ export declare function serializeDatacenter(writer: SerializationWriter, datacenter?: Partial<Datacenter> | undefined | null, isSerializingDerivedType?: boolean): void;
1422
+ /**
1423
+ * Serializes information the current object
1424
+ * @param Incident The instance to serialize from.
1425
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1426
+ * @param writer Serialization writer to use to serialize this model
1427
+ */
1428
+ export declare function serializeIncident(writer: SerializationWriter, incident?: Partial<Incident> | undefined | null, isSerializingDerivedType?: boolean): void;
1429
+ /**
1430
+ * Serializes information the current object
1431
+ * @param Incident_metadata The instance to serialize from.
1432
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1433
+ * @param writer Serialization writer to use to serialize this model
1434
+ */
1435
+ export declare function serializeIncident_metadata(writer: SerializationWriter, incident_metadata?: Partial<Incident_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
1436
+ /**
1437
+ * Serializes information the current object
1438
+ * @param IpInformation The instance to serialize from.
1439
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1440
+ * @param writer Serialization writer to use to serialize this model
1441
+ */
1442
+ export declare function serializeIpInformation(writer: SerializationWriter, ipInformation?: Partial<IpInformation> | undefined | null, isSerializingDerivedType?: boolean): void;
1443
+ /**
1444
+ * Serializes information the current object
1445
+ * @param IpRotationLinkResponse The instance to serialize from.
1446
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1447
+ * @param writer Serialization writer to use to serialize this model
1448
+ */
1449
+ export declare function serializeIpRotationLinkResponse(writer: SerializationWriter, ipRotationLinkResponse?: Partial<IpRotationLinkResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
1450
+ /**
1451
+ * Serializes information the current object
1452
+ * @param Isp The instance to serialize from.
1453
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1454
+ * @param writer Serialization writer to use to serialize this model
1455
+ */
1456
+ export declare function serializeIsp(writer: SerializationWriter, isp?: Partial<Isp> | undefined | null, isSerializingDerivedType?: boolean): void;
1457
+ /**
1458
+ * Serializes information the current object
1459
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1460
+ * @param Location The instance to serialize from.
1461
+ * @param writer Serialization writer to use to serialize this model
1462
+ */
1463
+ export declare function serializeLocation(writer: SerializationWriter, location?: Partial<Location> | undefined | null, isSerializingDerivedType?: boolean): void;
1464
+ /**
1465
+ * Serializes information the current object
1466
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1467
+ * @param Order The instance to serialize from.
1468
+ * @param writer Serialization writer to use to serialize this model
1469
+ */
1470
+ export declare function serializeOrder(writer: SerializationWriter, order?: Partial<Order> | undefined | null, isSerializingDerivedType?: boolean): void;
1471
+ /**
1472
+ * Serializes information the current object
1473
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1474
+ * @param Order_metadata The instance to serialize from.
1475
+ * @param writer Serialization writer to use to serialize this model
1476
+ */
1477
+ export declare function serializeOrder_metadata(writer: SerializationWriter, order_metadata?: Partial<Order_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
1478
+ /**
1479
+ * Serializes information the current object
1480
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1481
+ * @param OrderItem The instance to serialize from.
1482
+ * @param writer Serialization writer to use to serialize this model
1483
+ */
1484
+ export declare function serializeOrderItem(writer: SerializationWriter, orderItem?: Partial<OrderItem> | undefined | null, isSerializingDerivedType?: boolean): void;
1485
+ /**
1486
+ * Serializes information the current object
1487
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1488
+ * @param OrderItem_metadata The instance to serialize from.
1489
+ * @param writer Serialization writer to use to serialize this model
1490
+ */
1491
+ export declare function serializeOrderItem_metadata(writer: SerializationWriter, orderItem_metadata?: Partial<OrderItem_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
1492
+ /**
1493
+ * Serializes information the current object
1494
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1495
+ * @param OrganizationBranding The instance to serialize from.
1496
+ * @param writer Serialization writer to use to serialize this model
1497
+ */
1498
+ export declare function serializeOrganizationBranding(writer: SerializationWriter, organizationBranding?: Partial<OrganizationBranding> | undefined | null, isSerializingDerivedType?: boolean): void;
1499
+ /**
1500
+ * Serializes information the current object
1501
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1502
+ * @param OrganizationStore The instance to serialize from.
1503
+ * @param writer Serialization writer to use to serialize this model
1504
+ */
1505
+ export declare function serializeOrganizationStore(writer: SerializationWriter, organizationStore?: Partial<OrganizationStore> | undefined | null, isSerializingDerivedType?: boolean): void;
1506
+ /**
1507
+ * Serializes information the current object
1508
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1509
+ * @param Product The instance to serialize from.
1510
+ * @param writer Serialization writer to use to serialize this model
1511
+ */
1512
+ export declare function serializeProduct(writer: SerializationWriter, product?: Partial<Product> | undefined | null, isSerializingDerivedType?: boolean): void;
1513
+ /**
1514
+ * Serializes information the current object
1515
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1516
+ * @param Proxy The instance to serialize from.
1517
+ * @param writer Serialization writer to use to serialize this model
1518
+ */
1519
+ export declare function serializeProxy(writer: SerializationWriter, proxy?: Partial<Proxy> | undefined | null, isSerializingDerivedType?: boolean): void;
1520
+ /**
1521
+ * Serializes information the current object
1522
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1523
+ * @param ProxyCredentialResponse The instance to serialize from.
1524
+ * @param writer Serialization writer to use to serialize this model
1525
+ */
1526
+ export declare function serializeProxyCredentialResponse(writer: SerializationWriter, proxyCredentialResponse?: Partial<ProxyCredentialResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
1527
+ /**
1528
+ * Serializes information the current object
1529
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1530
+ * @param ProxyDatacenter The instance to serialize from.
1531
+ * @param writer Serialization writer to use to serialize this model
1532
+ */
1533
+ export declare function serializeProxyDatacenter(writer: SerializationWriter, proxyDatacenter?: Partial<ProxyDatacenter> | undefined | null, isSerializingDerivedType?: boolean): void;
1534
+ /**
1535
+ * Serializes information the current object
1536
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1537
+ * @param ProxyFeatures The instance to serialize from.
1538
+ * @param writer Serialization writer to use to serialize this model
1539
+ */
1540
+ export declare function serializeProxyFeatures(writer: SerializationWriter, proxyFeatures?: Partial<ProxyFeatures> | undefined | null, isSerializingDerivedType?: boolean): void;
1541
+ /**
1542
+ * Serializes information the current object
1543
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1544
+ * @param ProxyIpRotationFeature The instance to serialize from.
1545
+ * @param writer Serialization writer to use to serialize this model
1546
+ */
1547
+ export declare function serializeProxyIpRotationFeature(writer: SerializationWriter, proxyIpRotationFeature?: Partial<ProxyIpRotationFeature> | undefined | null, isSerializingDerivedType?: boolean): void;
1548
+ /**
1549
+ * Serializes information the current object
1550
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1551
+ * @param ProxyIpRotationResponse The instance to serialize from.
1552
+ * @param writer Serialization writer to use to serialize this model
1553
+ */
1554
+ export declare function serializeProxyIpRotationResponse(writer: SerializationWriter, proxyIpRotationResponse?: Partial<ProxyIpRotationResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
1555
+ /**
1556
+ * Serializes information the current object
1557
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1558
+ * @param ProxyIsp The instance to serialize from.
1559
+ * @param writer Serialization writer to use to serialize this model
1560
+ */
1561
+ export declare function serializeProxyIsp(writer: SerializationWriter, proxyIsp?: Partial<ProxyIsp> | undefined | null, isSerializingDerivedType?: boolean): void;
1562
+ /**
1563
+ * Serializes information the current object
1564
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1565
+ * @param ProxyLocation The instance to serialize from.
1566
+ * @param writer Serialization writer to use to serialize this model
1567
+ */
1568
+ export declare function serializeProxyLocation(writer: SerializationWriter, proxyLocation?: Partial<ProxyLocation> | undefined | null, isSerializingDerivedType?: boolean): void;
1569
+ /**
1570
+ * Serializes information the current object
1571
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1572
+ * @param ProxyOptions The instance to serialize from.
1573
+ * @param writer Serialization writer to use to serialize this model
1574
+ */
1575
+ export declare function serializeProxyOptions(writer: SerializationWriter, proxyOptions?: Partial<ProxyOptions> | undefined | null, isSerializingDerivedType?: boolean): void;
1576
+ /**
1577
+ * Serializes information the current object
1578
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1579
+ * @param ProxyOptions_metadata The instance to serialize from.
1580
+ * @param writer Serialization writer to use to serialize this model
1581
+ */
1582
+ export declare function serializeProxyOptions_metadata(writer: SerializationWriter, proxyOptions_metadata?: Partial<ProxyOptions_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
1583
+ /**
1584
+ * Serializes information the current object
1585
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1586
+ * @param ProxyProduct The instance to serialize from.
1587
+ * @param writer Serialization writer to use to serialize this model
1588
+ */
1589
+ export declare function serializeProxyProduct(writer: SerializationWriter, proxyProduct?: Partial<ProxyProduct> | undefined | null, isSerializingDerivedType?: boolean): void;
1590
+ /**
1591
+ * Serializes information the current object
1592
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1593
+ * @param RequestDetails The instance to serialize from.
1594
+ * @param writer Serialization writer to use to serialize this model
1595
+ */
1596
+ export declare function serializeRequestDetails(writer: SerializationWriter, requestDetails?: Partial<RequestDetails> | undefined | null, isSerializingDerivedType?: boolean): void;
1597
+ /**
1598
+ * Serializes information the current object
1599
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1600
+ * @param Review The instance to serialize from.
1601
+ * @param writer Serialization writer to use to serialize this model
1602
+ */
1603
+ export declare function serializeReview(writer: SerializationWriter, review?: Partial<Review> | undefined | null, isSerializingDerivedType?: boolean): void;
1604
+ /**
1605
+ * Serializes information the current object
1606
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1607
+ * @param Review_metadata The instance to serialize from.
1608
+ * @param writer Serialization writer to use to serialize this model
1609
+ */
1610
+ export declare function serializeReview_metadata(writer: SerializationWriter, review_metadata?: Partial<Review_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
1611
+ /**
1612
+ * Serializes information the current object
1613
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1614
+ * @param UpdateProxyCredentialsRequest The instance to serialize from.
1615
+ * @param writer Serialization writer to use to serialize this model
1616
+ */
1617
+ export declare function serializeUpdateProxyCredentialsRequest(writer: SerializationWriter, updateProxyCredentialsRequest?: Partial<UpdateProxyCredentialsRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
1618
+ /**
1619
+ * Serializes information the current object
1620
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
1621
+ * @param UpdateProxyIpRotationRequest The instance to serialize from.
1622
+ * @param writer Serialization writer to use to serialize this model
1623
+ */
1624
+ export declare function serializeUpdateProxyIpRotationRequest(writer: SerializationWriter, updateProxyIpRotationRequest?: Partial<UpdateProxyIpRotationRequest> | undefined | null, isSerializingDerivedType?: boolean): void;
1625
+ /**
1626
+ * Request to change an allocated proxy's credentials. A null username or password is generated from the organization's default formats.
1627
+ */
1628
+ export interface UpdateProxyCredentialsRequest extends AdditionalDataHolder, Parsable {
1629
+ /**
1630
+ * IP addresses allowed to use the proxy.
1631
+ */
1632
+ allowedIps?: string[] | null;
1633
+ /**
1634
+ * New authentication password. Generated from the organization's default format when null.
1635
+ */
1636
+ password?: string | null;
1637
+ /**
1638
+ * New authentication username. Generated from the organization's default format when null.
1639
+ */
1640
+ username?: string | null;
1641
+ }
1642
+ /**
1643
+ * Request to configure a proxy's IP rotation. An interval of 0 disables rotation.
1644
+ */
1645
+ export interface UpdateProxyIpRotationRequest extends AdditionalDataHolder, Parsable {
1646
+ /**
1647
+ * How often the proxy rotates its IP, in seconds. 0 disables rotation.
1648
+ */
1649
+ intervalSeconds?: number | null;
1650
+ }
1651
+ /**
1652
+ * Publication state of the announcement: only Published ones are shown.
1653
+ */
1654
+ export declare const AnnouncementStatusesObject: {
1655
+ readonly Draft: "Draft";
1656
+ readonly Published: "Published";
1657
+ readonly Archived: "Archived";
1658
+ };
1659
+ /**
1660
+ * Billing period the order is charged on (monthly, yearly). Null for a trial (free, time-boxed).
1661
+ */
1662
+ export declare const BillingCyclesObject: {
1663
+ readonly Daily: "Daily";
1664
+ readonly Weekly: "Weekly";
1665
+ readonly Monthly: "Monthly";
1666
+ readonly Quarterly: "Quarterly";
1667
+ readonly Yearly: "Yearly";
1668
+ readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
1669
+ };
1670
+ export declare const CapabilityTypesObject: {
1671
+ readonly IpScore: "IpScore";
1672
+ readonly Ipv6: "Ipv6";
1673
+ };
1674
+ /**
1675
+ * Lifecycle state of the incident (open, resolved, etc.).
1676
+ */
1677
+ export declare const IncidentStatusesObject: {
1678
+ readonly Open: "Open";
1679
+ readonly Resolved: "Resolved";
1680
+ readonly Dismissed: "Dismissed";
1681
+ };
1682
+ /**
1683
+ * 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.
1684
+ */
1685
+ export declare const OrderIntentsObject: {
1686
+ readonly Wholesale: "Wholesale";
1687
+ readonly Retail: "Retail";
1688
+ };
1689
+ /**
1690
+ * 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.
1691
+ */
1692
+ export declare const OrderStatusesObject: {
1693
+ readonly Pending: "Pending";
1694
+ readonly Provisioning: "Provisioning";
1695
+ readonly Active: "Active";
1696
+ readonly GracePeriod: "GracePeriod";
1697
+ readonly Expired: "Expired";
1698
+ readonly Deleted: "Deleted";
1699
+ };
1700
+ /**
1701
+ * How the order is paid. Null for a trial (free).
1702
+ */
1703
+ export declare const PaymentMethodsObject: {
1704
+ readonly Balance: "Balance";
1705
+ readonly CreditCard: "CreditCard";
1706
+ readonly Cryptocurrency: "Cryptocurrency";
1707
+ readonly Debug: "Debug";
1708
+ readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
1709
+ };
1710
+ /**
1711
+ * Processor that settles the order (Stripe, Heleket). Selects the webhook and reconciliation path that keeps it alive. Null for a trial (nothing to settle).
1712
+ */
1713
+ export declare const PaymentProcessorsObject: {
1714
+ readonly None: "None";
1715
+ readonly Heleket: "Heleket";
1716
+ readonly Stripe: "Stripe";
1717
+ readonly OpenapiJsonNullSentinelValue2BF936000FE44250987AE5DDB203E464: "openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464";
1718
+ };
1719
+ /**
1720
+ * How the product is billed.
1721
+ */
1722
+ export declare const PricingTypesObject: {
1723
+ readonly PerUnit: "PerUnit";
1724
+ readonly PerBandwidth: "PerBandwidth";
1725
+ };
1726
+ /**
1727
+ * Kind of resource this product delivers (proxy, host).
1728
+ */
1729
+ export declare const ProductKindsObject: {
1730
+ readonly Proxy: "Proxy";
1731
+ readonly Host: "Host";
1732
+ };
1733
+ /**
1734
+ * How the proxy resolves addresses. The non-default modes need the proxy's IPv6 capability.
1735
+ */
1736
+ export declare const ResolutionModesObject: {
1737
+ readonly DefaultEscaped: "Default";
1738
+ readonly Ipv6: "Ipv6";
1739
+ };