@opusdns/api 0.160.0 → 0.162.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/package.json +1 -1
- package/src/helpers/constants.ts +107 -1
- package/src/helpers/keys.ts +264 -0
- package/src/helpers/requests.d.ts +39 -0
- package/src/helpers/responses.d.ts +93 -1
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +64 -0
- package/src/openapi.yaml +305 -2
- package/src/schema.d.ts +154 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -359,6 +359,60 @@ export const BILLING_TRANSACTION_STATUS_VALUES = [
|
|
|
359
359
|
'canceled'
|
|
360
360
|
] as const satisfies [string, ...string[]] | BillingTransactionStatus[];
|
|
361
361
|
|
|
362
|
+
/**
|
|
363
|
+
* ComplianceStatus. Auto-generated enum for ComplianceStatus
|
|
364
|
+
*
|
|
365
|
+
* @remarks
|
|
366
|
+
* This constant provides both object and array forms for the ComplianceStatus enum.
|
|
367
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
368
|
+
*
|
|
369
|
+
* @example
|
|
370
|
+
* ```typescript
|
|
371
|
+
* // Using the object form for key-value access
|
|
372
|
+
* const status = COMPLIANCE_STATUS.SUCCESS;
|
|
373
|
+
*
|
|
374
|
+
* // Using the array form for iteration
|
|
375
|
+
* const allStatuses = COMPLIANCE_STATUS_VALUES;
|
|
376
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
377
|
+
* ```
|
|
378
|
+
*
|
|
379
|
+
* @see {@link ComplianceStatus} - The TypeScript type definition
|
|
380
|
+
*/
|
|
381
|
+
export const COMPLIANCE_STATUS = {
|
|
382
|
+
PREPARING: "preparing",
|
|
383
|
+
PENDING: "pending",
|
|
384
|
+
APPROVED: "approved",
|
|
385
|
+
DISAPPROVED: "disapproved",
|
|
386
|
+
} as const satisfies Record<string, ComplianceStatus>;
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
* Array of all ComplianceStatus enum values
|
|
390
|
+
*
|
|
391
|
+
* @remarks
|
|
392
|
+
* This constant provides a array containing all valid ComplianceStatus enum values.
|
|
393
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
394
|
+
*
|
|
395
|
+
* @example
|
|
396
|
+
* ```typescript
|
|
397
|
+
* // Iterating through all values
|
|
398
|
+
* for (const value of COMPLIANCE_STATUS_VALUES) {
|
|
399
|
+
* console.log(`Processing: ${value}`);
|
|
400
|
+
* }
|
|
401
|
+
*
|
|
402
|
+
* // Validation
|
|
403
|
+
* const isValid = COMPLIANCE_STATUS_VALUES.includes(someValue);
|
|
404
|
+
* ```
|
|
405
|
+
*
|
|
406
|
+
* @see {@link ComplianceStatus} - The TypeScript type definition
|
|
407
|
+
* @see {@link COMPLIANCE_STATUS} - The object form of this enum
|
|
408
|
+
*/
|
|
409
|
+
export const COMPLIANCE_STATUS_VALUES = [
|
|
410
|
+
'preparing',
|
|
411
|
+
'pending',
|
|
412
|
+
'approved',
|
|
413
|
+
'disapproved'
|
|
414
|
+
] as const satisfies [string, ...string[]] | ComplianceStatus[];
|
|
415
|
+
|
|
362
416
|
/**
|
|
363
417
|
* ContactSortField. Auto-generated enum for ContactSortField
|
|
364
418
|
*
|
|
@@ -2497,6 +2551,58 @@ export const ORGANIZATION_STATUS_VALUES = [
|
|
|
2497
2551
|
'inactive'
|
|
2498
2552
|
] as const satisfies [string, ...string[]] | OrganizationStatus[];
|
|
2499
2553
|
|
|
2554
|
+
/**
|
|
2555
|
+
* ParkingSortField. Auto-generated enum for ParkingSortField
|
|
2556
|
+
*
|
|
2557
|
+
* @remarks
|
|
2558
|
+
* This constant provides both object and array forms for the ParkingSortField enum.
|
|
2559
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2560
|
+
*
|
|
2561
|
+
* @example
|
|
2562
|
+
* ```typescript
|
|
2563
|
+
* // Using the object form for key-value access
|
|
2564
|
+
* const status = PARKING_SORT_FIELD.SUCCESS;
|
|
2565
|
+
*
|
|
2566
|
+
* // Using the array form for iteration
|
|
2567
|
+
* const allStatuses = PARKING_SORT_FIELD_VALUES;
|
|
2568
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2569
|
+
* ```
|
|
2570
|
+
*
|
|
2571
|
+
* @see {@link ParkingSortField} - The TypeScript type definition
|
|
2572
|
+
*/
|
|
2573
|
+
export const PARKING_SORT_FIELD = {
|
|
2574
|
+
DOMAIN: "domain",
|
|
2575
|
+
CREATED_ON: "created_on",
|
|
2576
|
+
UPDATED_ON: "updated_on",
|
|
2577
|
+
} as const satisfies Record<string, ParkingSortField>;
|
|
2578
|
+
|
|
2579
|
+
/**
|
|
2580
|
+
* Array of all ParkingSortField enum values
|
|
2581
|
+
*
|
|
2582
|
+
* @remarks
|
|
2583
|
+
* This constant provides a array containing all valid ParkingSortField enum values.
|
|
2584
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2585
|
+
*
|
|
2586
|
+
* @example
|
|
2587
|
+
* ```typescript
|
|
2588
|
+
* // Iterating through all values
|
|
2589
|
+
* for (const value of PARKING_SORT_FIELD_VALUES) {
|
|
2590
|
+
* console.log(`Processing: ${value}`);
|
|
2591
|
+
* }
|
|
2592
|
+
*
|
|
2593
|
+
* // Validation
|
|
2594
|
+
* const isValid = PARKING_SORT_FIELD_VALUES.includes(someValue);
|
|
2595
|
+
* ```
|
|
2596
|
+
*
|
|
2597
|
+
* @see {@link ParkingSortField} - The TypeScript type definition
|
|
2598
|
+
* @see {@link PARKING_SORT_FIELD} - The object form of this enum
|
|
2599
|
+
*/
|
|
2600
|
+
export const PARKING_SORT_FIELD_VALUES = [
|
|
2601
|
+
'domain',
|
|
2602
|
+
'created_on',
|
|
2603
|
+
'updated_on'
|
|
2604
|
+
] as const satisfies [string, ...string[]] | ParkingSortField[];
|
|
2605
|
+
|
|
2500
2606
|
/**
|
|
2501
2607
|
* PatchOp. Auto-generated enum for PatchOp
|
|
2502
2608
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -156,6 +156,7 @@ import { OrganizationToken } from './schemas';
|
|
|
156
156
|
import { OrganizationUpdate } from './schemas';
|
|
157
157
|
import { OrganizationWithBillingData } from './schemas';
|
|
158
158
|
import { PaginationMetadata } from './schemas';
|
|
159
|
+
import { Parking } from './schemas';
|
|
159
160
|
import { PasswordUpdate } from './schemas';
|
|
160
161
|
import { Period } from './schemas';
|
|
161
162
|
import { PermissionSet } from './schemas';
|
|
@@ -19193,6 +19194,269 @@ export const KEYS_PAGINATION_METADATA = [
|
|
|
19193
19194
|
KEY_PAGINATION_METADATA_TOTAL_PAGES,
|
|
19194
19195
|
] as const satisfies (keyof PaginationMetadata)[];
|
|
19195
19196
|
|
|
19197
|
+
/**
|
|
19198
|
+
* compliance_status property
|
|
19199
|
+
*
|
|
19200
|
+
* The compliance status of the parking ad
|
|
19201
|
+
*
|
|
19202
|
+
*
|
|
19203
|
+
*
|
|
19204
|
+
* @remarks
|
|
19205
|
+
* This key constant provides type-safe access to the `compliance_status` property of Parking objects.
|
|
19206
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19207
|
+
*
|
|
19208
|
+
* @example
|
|
19209
|
+
* ```typescript
|
|
19210
|
+
* // Direct property access
|
|
19211
|
+
* const value = parking[KEY_PARKING_COMPLIANCE_STATUS];
|
|
19212
|
+
*
|
|
19213
|
+
* // Dynamic property access
|
|
19214
|
+
* const propertyName = KEY_PARKING_COMPLIANCE_STATUS;
|
|
19215
|
+
* const value = parking[propertyName];
|
|
19216
|
+
* ```
|
|
19217
|
+
*
|
|
19218
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19219
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19220
|
+
*/
|
|
19221
|
+
export const KEY_PARKING_COMPLIANCE_STATUS: keyof Parking = 'compliance_status';
|
|
19222
|
+
/**
|
|
19223
|
+
* Content Language
|
|
19224
|
+
*
|
|
19225
|
+
* The primary language code for the ad content
|
|
19226
|
+
*
|
|
19227
|
+
*
|
|
19228
|
+
*
|
|
19229
|
+
* @remarks
|
|
19230
|
+
* This key constant provides type-safe access to the `content_language` property of Parking objects.
|
|
19231
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19232
|
+
*
|
|
19233
|
+
* @example
|
|
19234
|
+
* ```typescript
|
|
19235
|
+
* // Direct property access
|
|
19236
|
+
* const value = parking[KEY_PARKING_CONTENT_LANGUAGE];
|
|
19237
|
+
*
|
|
19238
|
+
* // Dynamic property access
|
|
19239
|
+
* const propertyName = KEY_PARKING_CONTENT_LANGUAGE;
|
|
19240
|
+
* const value = parking[propertyName];
|
|
19241
|
+
* ```
|
|
19242
|
+
*
|
|
19243
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19244
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19245
|
+
*/
|
|
19246
|
+
export const KEY_PARKING_CONTENT_LANGUAGE: keyof Parking = 'content_language';
|
|
19247
|
+
/**
|
|
19248
|
+
* Content Url
|
|
19249
|
+
*
|
|
19250
|
+
* The content URL for approved parking ads
|
|
19251
|
+
*
|
|
19252
|
+
*
|
|
19253
|
+
*
|
|
19254
|
+
* @remarks
|
|
19255
|
+
* This key constant provides type-safe access to the `content_url` property of Parking objects.
|
|
19256
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19257
|
+
*
|
|
19258
|
+
* @example
|
|
19259
|
+
* ```typescript
|
|
19260
|
+
* // Direct property access
|
|
19261
|
+
* const value = parking[KEY_PARKING_CONTENT_URL];
|
|
19262
|
+
*
|
|
19263
|
+
* // Dynamic property access
|
|
19264
|
+
* const propertyName = KEY_PARKING_CONTENT_URL;
|
|
19265
|
+
* const value = parking[propertyName];
|
|
19266
|
+
* ```
|
|
19267
|
+
*
|
|
19268
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19269
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19270
|
+
*/
|
|
19271
|
+
export const KEY_PARKING_CONTENT_URL: keyof Parking = 'content_url';
|
|
19272
|
+
/**
|
|
19273
|
+
* Created On
|
|
19274
|
+
*
|
|
19275
|
+
* When the parking entry was created
|
|
19276
|
+
*
|
|
19277
|
+
* @type {string}
|
|
19278
|
+
*
|
|
19279
|
+
*
|
|
19280
|
+
* @remarks
|
|
19281
|
+
* This key constant provides type-safe access to the `created_on` property of Parking objects.
|
|
19282
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19283
|
+
*
|
|
19284
|
+
* @example
|
|
19285
|
+
* ```typescript
|
|
19286
|
+
* // Direct property access
|
|
19287
|
+
* const value = parking[KEY_PARKING_CREATED_ON];
|
|
19288
|
+
*
|
|
19289
|
+
* // Dynamic property access
|
|
19290
|
+
* const propertyName = KEY_PARKING_CREATED_ON;
|
|
19291
|
+
* const value = parking[propertyName];
|
|
19292
|
+
* ```
|
|
19293
|
+
*
|
|
19294
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19295
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19296
|
+
*/
|
|
19297
|
+
export const KEY_PARKING_CREATED_ON: keyof Parking = 'created_on';
|
|
19298
|
+
/**
|
|
19299
|
+
* Domain
|
|
19300
|
+
*
|
|
19301
|
+
* The domain name for the parking ad
|
|
19302
|
+
*
|
|
19303
|
+
* @type {string}
|
|
19304
|
+
*
|
|
19305
|
+
*
|
|
19306
|
+
* @remarks
|
|
19307
|
+
* This key constant provides type-safe access to the `domain` property of Parking objects.
|
|
19308
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19309
|
+
*
|
|
19310
|
+
* @example
|
|
19311
|
+
* ```typescript
|
|
19312
|
+
* // Direct property access
|
|
19313
|
+
* const value = parking[KEY_PARKING_DOMAIN];
|
|
19314
|
+
*
|
|
19315
|
+
* // Dynamic property access
|
|
19316
|
+
* const propertyName = KEY_PARKING_DOMAIN;
|
|
19317
|
+
* const value = parking[propertyName];
|
|
19318
|
+
* ```
|
|
19319
|
+
*
|
|
19320
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19321
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19322
|
+
*/
|
|
19323
|
+
export const KEY_PARKING_DOMAIN: keyof Parking = 'domain';
|
|
19324
|
+
/**
|
|
19325
|
+
* Enabled
|
|
19326
|
+
*
|
|
19327
|
+
* Whether parking is enabled
|
|
19328
|
+
*
|
|
19329
|
+
* @type {boolean}
|
|
19330
|
+
*
|
|
19331
|
+
*
|
|
19332
|
+
* @remarks
|
|
19333
|
+
* This key constant provides type-safe access to the `enabled` property of Parking objects.
|
|
19334
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19335
|
+
*
|
|
19336
|
+
* @example
|
|
19337
|
+
* ```typescript
|
|
19338
|
+
* // Direct property access
|
|
19339
|
+
* const value = parking[KEY_PARKING_ENABLED];
|
|
19340
|
+
*
|
|
19341
|
+
* // Dynamic property access
|
|
19342
|
+
* const propertyName = KEY_PARKING_ENABLED;
|
|
19343
|
+
* const value = parking[propertyName];
|
|
19344
|
+
* ```
|
|
19345
|
+
*
|
|
19346
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19347
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19348
|
+
*/
|
|
19349
|
+
export const KEY_PARKING_ENABLED: keyof Parking = 'enabled';
|
|
19350
|
+
/**
|
|
19351
|
+
* Note
|
|
19352
|
+
*
|
|
19353
|
+
* Additional notes about the parking ad
|
|
19354
|
+
*
|
|
19355
|
+
*
|
|
19356
|
+
*
|
|
19357
|
+
* @remarks
|
|
19358
|
+
* This key constant provides type-safe access to the `note` property of Parking objects.
|
|
19359
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19360
|
+
*
|
|
19361
|
+
* @example
|
|
19362
|
+
* ```typescript
|
|
19363
|
+
* // Direct property access
|
|
19364
|
+
* const value = parking[KEY_PARKING_NOTE];
|
|
19365
|
+
*
|
|
19366
|
+
* // Dynamic property access
|
|
19367
|
+
* const propertyName = KEY_PARKING_NOTE;
|
|
19368
|
+
* const value = parking[propertyName];
|
|
19369
|
+
* ```
|
|
19370
|
+
*
|
|
19371
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19372
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19373
|
+
*/
|
|
19374
|
+
export const KEY_PARKING_NOTE: keyof Parking = 'note';
|
|
19375
|
+
/**
|
|
19376
|
+
* Parking Id
|
|
19377
|
+
*
|
|
19378
|
+
* Unique identifier for the parking entry
|
|
19379
|
+
*
|
|
19380
|
+
* @type {string}
|
|
19381
|
+
*
|
|
19382
|
+
*
|
|
19383
|
+
* @remarks
|
|
19384
|
+
* This key constant provides type-safe access to the `parking_id` property of Parking objects.
|
|
19385
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19386
|
+
*
|
|
19387
|
+
* @example
|
|
19388
|
+
* ```typescript
|
|
19389
|
+
* // Direct property access
|
|
19390
|
+
* const value = parking[KEY_PARKING_PARKING_ID];
|
|
19391
|
+
*
|
|
19392
|
+
* // Dynamic property access
|
|
19393
|
+
* const propertyName = KEY_PARKING_PARKING_ID;
|
|
19394
|
+
* const value = parking[propertyName];
|
|
19395
|
+
* ```
|
|
19396
|
+
*
|
|
19397
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19398
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19399
|
+
*/
|
|
19400
|
+
export const KEY_PARKING_PARKING_ID: keyof Parking = 'parking_id';
|
|
19401
|
+
/**
|
|
19402
|
+
* Updated On
|
|
19403
|
+
*
|
|
19404
|
+
* When the parking entry was last updated
|
|
19405
|
+
*
|
|
19406
|
+
* @type {string}
|
|
19407
|
+
*
|
|
19408
|
+
*
|
|
19409
|
+
* @remarks
|
|
19410
|
+
* This key constant provides type-safe access to the `updated_on` property of Parking objects.
|
|
19411
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19412
|
+
*
|
|
19413
|
+
* @example
|
|
19414
|
+
* ```typescript
|
|
19415
|
+
* // Direct property access
|
|
19416
|
+
* const value = parking[KEY_PARKING_UPDATED_ON];
|
|
19417
|
+
*
|
|
19418
|
+
* // Dynamic property access
|
|
19419
|
+
* const propertyName = KEY_PARKING_UPDATED_ON;
|
|
19420
|
+
* const value = parking[propertyName];
|
|
19421
|
+
* ```
|
|
19422
|
+
*
|
|
19423
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19424
|
+
* @see {@link KEYS_PARKING} - Array of all keys for this type
|
|
19425
|
+
*/
|
|
19426
|
+
export const KEY_PARKING_UPDATED_ON: keyof Parking = 'updated_on';
|
|
19427
|
+
|
|
19428
|
+
/**
|
|
19429
|
+
* Array of all Parking property keys
|
|
19430
|
+
*
|
|
19431
|
+
* @remarks
|
|
19432
|
+
* This constant provides a readonly array containing all valid property keys for Parking objects.
|
|
19433
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
19434
|
+
*
|
|
19435
|
+
* @example
|
|
19436
|
+
* ```typescript
|
|
19437
|
+
* // Iterating through all keys
|
|
19438
|
+
* for (const key of KEYS_PARKING) {
|
|
19439
|
+
* console.log(`Property: ${key}, Value: ${parking[key]}`);
|
|
19440
|
+
* }
|
|
19441
|
+
*
|
|
19442
|
+
* // Validation
|
|
19443
|
+
* const isValidKey = KEYS_PARKING.includes(someKey);
|
|
19444
|
+
* ```
|
|
19445
|
+
*
|
|
19446
|
+
* @see {@link Parking} - The TypeScript type definition
|
|
19447
|
+
*/
|
|
19448
|
+
export const KEYS_PARKING = [
|
|
19449
|
+
KEY_PARKING_COMPLIANCE_STATUS,
|
|
19450
|
+
KEY_PARKING_CONTENT_LANGUAGE,
|
|
19451
|
+
KEY_PARKING_CONTENT_URL,
|
|
19452
|
+
KEY_PARKING_CREATED_ON,
|
|
19453
|
+
KEY_PARKING_DOMAIN,
|
|
19454
|
+
KEY_PARKING_ENABLED,
|
|
19455
|
+
KEY_PARKING_NOTE,
|
|
19456
|
+
KEY_PARKING_PARKING_ID,
|
|
19457
|
+
KEY_PARKING_UPDATED_ON,
|
|
19458
|
+
] as const satisfies (keyof Parking)[];
|
|
19459
|
+
|
|
19196
19460
|
/**
|
|
19197
19461
|
* New Password
|
|
19198
19462
|
*
|
|
@@ -4633,6 +4633,45 @@ export type GET_OrganizationsUsers_Request = {
|
|
|
4633
4633
|
*/
|
|
4634
4634
|
export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Request['parameters']['query'];
|
|
4635
4635
|
|
|
4636
|
+
/**
|
|
4637
|
+
* Request type for GET Parking endpoint
|
|
4638
|
+
*
|
|
4639
|
+
* List parking entries
|
|
4640
|
+
* Retrieves a paginated list of parking entries for the organization
|
|
4641
|
+
*
|
|
4642
|
+
* @remarks
|
|
4643
|
+
* This type defines the complete request structure for the GET Parking endpoint.
|
|
4644
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4645
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4646
|
+
*
|
|
4647
|
+
* @example
|
|
4648
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4649
|
+
*
|
|
4650
|
+
* @path /v1/parking
|
|
4651
|
+
*
|
|
4652
|
+
* @see {@link GET_Parking_Request_Query} - Query parameters type
|
|
4653
|
+
* @see {@link GET_Parking_Request_Path} - Path parameters type
|
|
4654
|
+
* @see {@link GET_Parking_Request_Body} - Request body type
|
|
4655
|
+
*/
|
|
4656
|
+
export type GET_Parking_Request = {
|
|
4657
|
+
parameters: {
|
|
4658
|
+
query: operations['list_parking_v1_parking_get']['parameters']['query'];
|
|
4659
|
+
};
|
|
4660
|
+
}
|
|
4661
|
+
/**
|
|
4662
|
+
* Query parameters for GET /v1/parking
|
|
4663
|
+
*
|
|
4664
|
+
* @remarks
|
|
4665
|
+
* This type defines the query parameters for the GET /v1/parking endpoint.
|
|
4666
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
4667
|
+
*
|
|
4668
|
+
* @example
|
|
4669
|
+
* Use this type to ensure type safety for query parameters.
|
|
4670
|
+
*
|
|
4671
|
+
* @path /v1/parking
|
|
4672
|
+
*/
|
|
4673
|
+
export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query'];
|
|
4674
|
+
|
|
4636
4675
|
/**
|
|
4637
4676
|
* Request type for GET Tlds endpoint
|
|
4638
4677
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -8852,6 +8852,98 @@ export type GET_OrganizationsUsers_Response_403 = Problem
|
|
|
8852
8852
|
*/
|
|
8853
8853
|
export type GET_OrganizationsUsers_Response_422 = HTTPValidationError
|
|
8854
8854
|
|
|
8855
|
+
/**
|
|
8856
|
+
* Response types for GET Parking endpoint
|
|
8857
|
+
*
|
|
8858
|
+
* List parking entries
|
|
8859
|
+
* Retrieves a paginated list of parking entries for the organization
|
|
8860
|
+
*
|
|
8861
|
+
* @remarks
|
|
8862
|
+
* This type defines all possible response structures for the GET Parking endpoint.
|
|
8863
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
8864
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
8865
|
+
*
|
|
8866
|
+
|
|
8867
|
+
*
|
|
8868
|
+
* @path /v1/parking
|
|
8869
|
+
*
|
|
8870
|
+
* @see {@link GET_Parking_Response_200} - 200 response type
|
|
8871
|
+
* @see {@link GET_Parking_Response_401} - 401 response type
|
|
8872
|
+
* @see {@link GET_Parking_Response_403} - 403 response type
|
|
8873
|
+
* @see {@link GET_Parking_Response_422} - 422 response type
|
|
8874
|
+
*
|
|
8875
|
+
|
|
8876
|
+
*/
|
|
8877
|
+
export type GET_Parking_Response = GET_Parking_Response_200 | GET_Parking_Response_401 | GET_Parking_Response_403 | GET_Parking_Response_422;
|
|
8878
|
+
|
|
8879
|
+
/**
|
|
8880
|
+
* 200 response for GET Parking endpoint
|
|
8881
|
+
*
|
|
8882
|
+
* @remarks
|
|
8883
|
+
* This type defines the response structure for the 200 status code
|
|
8884
|
+
* of the GET Parking endpoint.
|
|
8885
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8886
|
+
*
|
|
8887
|
+
|
|
8888
|
+
*
|
|
8889
|
+
* @path /v1/parking
|
|
8890
|
+
*
|
|
8891
|
+
* @see {@link GET_Parking_Response} - The main response type definition
|
|
8892
|
+
* @see {@link Pagination_Parking} - The actual schema type definition
|
|
8893
|
+
*/
|
|
8894
|
+
export type GET_Parking_Response_200 = Pagination_Parking
|
|
8895
|
+
|
|
8896
|
+
/**
|
|
8897
|
+
* 401 response for GET Parking endpoint
|
|
8898
|
+
*
|
|
8899
|
+
* @remarks
|
|
8900
|
+
* This type defines the response structure for the 401 status code
|
|
8901
|
+
* of the GET Parking endpoint.
|
|
8902
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8903
|
+
*
|
|
8904
|
+
|
|
8905
|
+
*
|
|
8906
|
+
* @path /v1/parking
|
|
8907
|
+
*
|
|
8908
|
+
* @see {@link GET_Parking_Response} - The main response type definition
|
|
8909
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8910
|
+
*/
|
|
8911
|
+
export type GET_Parking_Response_401 = Problem
|
|
8912
|
+
|
|
8913
|
+
/**
|
|
8914
|
+
* 403 response for GET Parking endpoint
|
|
8915
|
+
*
|
|
8916
|
+
* @remarks
|
|
8917
|
+
* This type defines the response structure for the 403 status code
|
|
8918
|
+
* of the GET Parking endpoint.
|
|
8919
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8920
|
+
*
|
|
8921
|
+
|
|
8922
|
+
*
|
|
8923
|
+
* @path /v1/parking
|
|
8924
|
+
*
|
|
8925
|
+
* @see {@link GET_Parking_Response} - The main response type definition
|
|
8926
|
+
* @see {@link Problem} - The actual schema type definition
|
|
8927
|
+
*/
|
|
8928
|
+
export type GET_Parking_Response_403 = Problem
|
|
8929
|
+
|
|
8930
|
+
/**
|
|
8931
|
+
* 422 response for GET Parking endpoint
|
|
8932
|
+
*
|
|
8933
|
+
* @remarks
|
|
8934
|
+
* This type defines the response structure for the 422 status code
|
|
8935
|
+
* of the GET Parking endpoint.
|
|
8936
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8937
|
+
*
|
|
8938
|
+
|
|
8939
|
+
*
|
|
8940
|
+
* @path /v1/parking
|
|
8941
|
+
*
|
|
8942
|
+
* @see {@link GET_Parking_Response} - The main response type definition
|
|
8943
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8944
|
+
*/
|
|
8945
|
+
export type GET_Parking_Response_422 = HTTPValidationError
|
|
8946
|
+
|
|
8855
8947
|
/**
|
|
8856
8948
|
* Response types for GET Tlds endpoint
|
|
8857
8949
|
*
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -919,6 +919,20 @@ export type ObjectLogArray = ObjectLog[];
|
|
|
919
919
|
* @see {@link Organization} - The individual Organization type definition
|
|
920
920
|
*/
|
|
921
921
|
export type OrganizationArray = Organization[];
|
|
922
|
+
/**
|
|
923
|
+
* ParkingResponse
|
|
924
|
+
*
|
|
925
|
+
* @remarks
|
|
926
|
+
* Array type for ParkingResponse objects. Used when the API returns a collection of ParkingResponse instances.
|
|
927
|
+
*
|
|
928
|
+
* @example
|
|
929
|
+
* ```typescript
|
|
930
|
+
* const items: ParkingArray = await api.getParkings();
|
|
931
|
+
* ```
|
|
932
|
+
*
|
|
933
|
+
* @see {@link Parking} - The individual ParkingResponse type definition
|
|
934
|
+
*/
|
|
935
|
+
export type ParkingArray = Parking[];
|
|
922
936
|
/**
|
|
923
937
|
* RequestHistory
|
|
924
938
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -202,6 +202,22 @@ export type BillingTransactionStatus = components['schemas']['BillingTransaction
|
|
|
202
202
|
* @see {@link components} - The OpenAPI components schema definition
|
|
203
203
|
*/
|
|
204
204
|
export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
|
|
205
|
+
/**
|
|
206
|
+
* ComplianceStatus
|
|
207
|
+
*
|
|
208
|
+
* @remarks
|
|
209
|
+
* Type alias for the `ComplianceStatus` OpenAPI schema.
|
|
210
|
+
* This type represents compliancestatus data structures used in API requests and responses.
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* ```typescript
|
|
214
|
+
* const response = await api.getComplianceStatus();
|
|
215
|
+
* const item: ComplianceStatus = response.results;
|
|
216
|
+
* ```
|
|
217
|
+
*
|
|
218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
219
|
+
*/
|
|
220
|
+
export type ComplianceStatus = components['schemas']['ComplianceStatus'];
|
|
205
221
|
/**
|
|
206
222
|
* ContactAttributeDefinition. Definition of a possible attribute for a TLD.
|
|
207
223
|
*
|
|
@@ -3071,6 +3087,22 @@ export type Pagination_ObjectLog = components['schemas']['Pagination_ObjectLog_'
|
|
|
3071
3087
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3072
3088
|
*/
|
|
3073
3089
|
export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
|
|
3090
|
+
/**
|
|
3091
|
+
* Pagination[ParkingResponse]
|
|
3092
|
+
*
|
|
3093
|
+
* @remarks
|
|
3094
|
+
* Type alias for the `Pagination_ParkingResponse_` OpenAPI schema.
|
|
3095
|
+
* This type represents pagination[parkingresponse] data structures used in API requests and responses.
|
|
3096
|
+
*
|
|
3097
|
+
* @example
|
|
3098
|
+
* ```typescript
|
|
3099
|
+
* const response = await api.getPagination_Parking();
|
|
3100
|
+
* const item: Pagination_Parking = response.results;
|
|
3101
|
+
* ```
|
|
3102
|
+
*
|
|
3103
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3104
|
+
*/
|
|
3105
|
+
export type Pagination_Parking = components['schemas']['Pagination_ParkingResponse_'];
|
|
3074
3106
|
/**
|
|
3075
3107
|
* Pagination[RequestHistory]
|
|
3076
3108
|
*
|
|
@@ -3103,6 +3135,38 @@ export type Pagination_RequestHistory = components['schemas']['Pagination_Reques
|
|
|
3103
3135
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3104
3136
|
*/
|
|
3105
3137
|
export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
|
|
3138
|
+
/**
|
|
3139
|
+
* ParkingResponse
|
|
3140
|
+
*
|
|
3141
|
+
* @remarks
|
|
3142
|
+
* Type alias for the `ParkingResponse` OpenAPI schema.
|
|
3143
|
+
* This type represents parkingresponse data structures used in API requests and responses.
|
|
3144
|
+
*
|
|
3145
|
+
* @example
|
|
3146
|
+
* ```typescript
|
|
3147
|
+
* const response = await api.getParking();
|
|
3148
|
+
* const item: Parking = response.results;
|
|
3149
|
+
* ```
|
|
3150
|
+
*
|
|
3151
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3152
|
+
*/
|
|
3153
|
+
export type Parking = components['schemas']['ParkingResponse'];
|
|
3154
|
+
/**
|
|
3155
|
+
* ParkingSortField
|
|
3156
|
+
*
|
|
3157
|
+
* @remarks
|
|
3158
|
+
* Type alias for the `ParkingSortField` OpenAPI schema.
|
|
3159
|
+
* This type represents parkingsortfield data structures used in API requests and responses.
|
|
3160
|
+
*
|
|
3161
|
+
* @example
|
|
3162
|
+
* ```typescript
|
|
3163
|
+
* const response = await api.getParkingSortField();
|
|
3164
|
+
* const item: ParkingSortField = response.results;
|
|
3165
|
+
* ```
|
|
3166
|
+
*
|
|
3167
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3168
|
+
*/
|
|
3169
|
+
export type ParkingSortField = components['schemas']['ParkingSortField'];
|
|
3106
3170
|
/**
|
|
3107
3171
|
* PasswordUpdate
|
|
3108
3172
|
*
|