@opusdns/api 0.228.0 → 0.229.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 +321 -1
- package/src/helpers/keys.ts +17785 -7651
- package/src/helpers/requests.d.ts +611 -1
- package/src/helpers/responses.d.ts +991 -1
- package/src/helpers/schemas-arrays.d.ts +272 -6
- package/src/helpers/schemas.d.ts +2368 -976
- package/src/openapi.yaml +5183 -1513
- package/src/schema.d.ts +2730 -221
package/src/schema.d.ts
CHANGED
|
@@ -1339,6 +1339,145 @@ export interface paths {
|
|
|
1339
1339
|
patch: operations["acknowledge_event_v1_events__event_id__patch"];
|
|
1340
1340
|
trace?: never;
|
|
1341
1341
|
};
|
|
1342
|
+
"/v1/job/{job_id}": {
|
|
1343
|
+
parameters: {
|
|
1344
|
+
query?: never;
|
|
1345
|
+
header?: never;
|
|
1346
|
+
path?: never;
|
|
1347
|
+
cookie?: never;
|
|
1348
|
+
};
|
|
1349
|
+
/** Get individual job details */
|
|
1350
|
+
get: operations["get_job_v1_job__job_id__get"];
|
|
1351
|
+
put?: never;
|
|
1352
|
+
post?: never;
|
|
1353
|
+
/** Delete (cancel) a queued job */
|
|
1354
|
+
delete: operations["delete_job_v1_job__job_id__delete"];
|
|
1355
|
+
options?: never;
|
|
1356
|
+
head?: never;
|
|
1357
|
+
patch?: never;
|
|
1358
|
+
trace?: never;
|
|
1359
|
+
};
|
|
1360
|
+
"/v1/job/{job_id}/pause": {
|
|
1361
|
+
parameters: {
|
|
1362
|
+
query?: never;
|
|
1363
|
+
header?: never;
|
|
1364
|
+
path?: never;
|
|
1365
|
+
cookie?: never;
|
|
1366
|
+
};
|
|
1367
|
+
get?: never;
|
|
1368
|
+
put?: never;
|
|
1369
|
+
/** Pause a job */
|
|
1370
|
+
post: operations["pause_job_v1_job__job_id__pause_post"];
|
|
1371
|
+
delete?: never;
|
|
1372
|
+
options?: never;
|
|
1373
|
+
head?: never;
|
|
1374
|
+
patch?: never;
|
|
1375
|
+
trace?: never;
|
|
1376
|
+
};
|
|
1377
|
+
"/v1/job/{job_id}/resume": {
|
|
1378
|
+
parameters: {
|
|
1379
|
+
query?: never;
|
|
1380
|
+
header?: never;
|
|
1381
|
+
path?: never;
|
|
1382
|
+
cookie?: never;
|
|
1383
|
+
};
|
|
1384
|
+
get?: never;
|
|
1385
|
+
put?: never;
|
|
1386
|
+
/** Resume a paused job */
|
|
1387
|
+
post: operations["resume_job_v1_job__job_id__resume_post"];
|
|
1388
|
+
delete?: never;
|
|
1389
|
+
options?: never;
|
|
1390
|
+
head?: never;
|
|
1391
|
+
patch?: never;
|
|
1392
|
+
trace?: never;
|
|
1393
|
+
};
|
|
1394
|
+
"/v1/jobs": {
|
|
1395
|
+
parameters: {
|
|
1396
|
+
query?: never;
|
|
1397
|
+
header?: never;
|
|
1398
|
+
path?: never;
|
|
1399
|
+
cookie?: never;
|
|
1400
|
+
};
|
|
1401
|
+
/** List batches for organization */
|
|
1402
|
+
get: operations["list_batches_v1_jobs_get"];
|
|
1403
|
+
put?: never;
|
|
1404
|
+
/** Create a batch of commands for async execution */
|
|
1405
|
+
post: operations["create_batch_v1_jobs_post"];
|
|
1406
|
+
delete?: never;
|
|
1407
|
+
options?: never;
|
|
1408
|
+
head?: never;
|
|
1409
|
+
patch?: never;
|
|
1410
|
+
trace?: never;
|
|
1411
|
+
};
|
|
1412
|
+
"/v1/jobs/{batch_id}": {
|
|
1413
|
+
parameters: {
|
|
1414
|
+
query?: never;
|
|
1415
|
+
header?: never;
|
|
1416
|
+
path?: never;
|
|
1417
|
+
cookie?: never;
|
|
1418
|
+
};
|
|
1419
|
+
/** Get batch details and execution status */
|
|
1420
|
+
get: operations["get_batch_v1_jobs__batch_id__get"];
|
|
1421
|
+
put?: never;
|
|
1422
|
+
post?: never;
|
|
1423
|
+
/** Delete (cancel) all queued jobs in a batch */
|
|
1424
|
+
delete: operations["delete_batch_v1_jobs__batch_id__delete"];
|
|
1425
|
+
options?: never;
|
|
1426
|
+
head?: never;
|
|
1427
|
+
patch?: never;
|
|
1428
|
+
trace?: never;
|
|
1429
|
+
};
|
|
1430
|
+
"/v1/jobs/{batch_id}/jobs": {
|
|
1431
|
+
parameters: {
|
|
1432
|
+
query?: never;
|
|
1433
|
+
header?: never;
|
|
1434
|
+
path?: never;
|
|
1435
|
+
cookie?: never;
|
|
1436
|
+
};
|
|
1437
|
+
/** Get individual jobs within a batch */
|
|
1438
|
+
get: operations["get_batch_jobs_v1_jobs__batch_id__jobs_get"];
|
|
1439
|
+
put?: never;
|
|
1440
|
+
post?: never;
|
|
1441
|
+
delete?: never;
|
|
1442
|
+
options?: never;
|
|
1443
|
+
head?: never;
|
|
1444
|
+
patch?: never;
|
|
1445
|
+
trace?: never;
|
|
1446
|
+
};
|
|
1447
|
+
"/v1/jobs/{batch_id}/pause": {
|
|
1448
|
+
parameters: {
|
|
1449
|
+
query?: never;
|
|
1450
|
+
header?: never;
|
|
1451
|
+
path?: never;
|
|
1452
|
+
cookie?: never;
|
|
1453
|
+
};
|
|
1454
|
+
get?: never;
|
|
1455
|
+
put?: never;
|
|
1456
|
+
/** Pause all eligible jobs in a batch */
|
|
1457
|
+
post: operations["pause_batch_v1_jobs__batch_id__pause_post"];
|
|
1458
|
+
delete?: never;
|
|
1459
|
+
options?: never;
|
|
1460
|
+
head?: never;
|
|
1461
|
+
patch?: never;
|
|
1462
|
+
trace?: never;
|
|
1463
|
+
};
|
|
1464
|
+
"/v1/jobs/{batch_id}/resume": {
|
|
1465
|
+
parameters: {
|
|
1466
|
+
query?: never;
|
|
1467
|
+
header?: never;
|
|
1468
|
+
path?: never;
|
|
1469
|
+
cookie?: never;
|
|
1470
|
+
};
|
|
1471
|
+
get?: never;
|
|
1472
|
+
put?: never;
|
|
1473
|
+
/** Resume all paused jobs in a batch */
|
|
1474
|
+
post: operations["resume_batch_v1_jobs__batch_id__resume_post"];
|
|
1475
|
+
delete?: never;
|
|
1476
|
+
options?: never;
|
|
1477
|
+
head?: never;
|
|
1478
|
+
patch?: never;
|
|
1479
|
+
trace?: never;
|
|
1480
|
+
};
|
|
1342
1481
|
"/v1/organizations": {
|
|
1343
1482
|
parameters: {
|
|
1344
1483
|
query?: never;
|
|
@@ -1725,6 +1864,58 @@ export interface paths {
|
|
|
1725
1864
|
patch?: never;
|
|
1726
1865
|
trace?: never;
|
|
1727
1866
|
};
|
|
1867
|
+
"/v1/reports": {
|
|
1868
|
+
parameters: {
|
|
1869
|
+
query?: never;
|
|
1870
|
+
header?: never;
|
|
1871
|
+
path?: never;
|
|
1872
|
+
cookie?: never;
|
|
1873
|
+
};
|
|
1874
|
+
/** List Reports */
|
|
1875
|
+
get: operations["list_reports_v1_reports_get"];
|
|
1876
|
+
put?: never;
|
|
1877
|
+
/** Create Report */
|
|
1878
|
+
post: operations["create_report_v1_reports_post"];
|
|
1879
|
+
delete?: never;
|
|
1880
|
+
options?: never;
|
|
1881
|
+
head?: never;
|
|
1882
|
+
patch?: never;
|
|
1883
|
+
trace?: never;
|
|
1884
|
+
};
|
|
1885
|
+
"/v1/reports/{report_id}": {
|
|
1886
|
+
parameters: {
|
|
1887
|
+
query?: never;
|
|
1888
|
+
header?: never;
|
|
1889
|
+
path?: never;
|
|
1890
|
+
cookie?: never;
|
|
1891
|
+
};
|
|
1892
|
+
/** Get Report */
|
|
1893
|
+
get: operations["get_report_v1_reports__report_id__get"];
|
|
1894
|
+
put?: never;
|
|
1895
|
+
post?: never;
|
|
1896
|
+
delete?: never;
|
|
1897
|
+
options?: never;
|
|
1898
|
+
head?: never;
|
|
1899
|
+
patch?: never;
|
|
1900
|
+
trace?: never;
|
|
1901
|
+
};
|
|
1902
|
+
"/v1/reports/{report_id}/download": {
|
|
1903
|
+
parameters: {
|
|
1904
|
+
query?: never;
|
|
1905
|
+
header?: never;
|
|
1906
|
+
path?: never;
|
|
1907
|
+
cookie?: never;
|
|
1908
|
+
};
|
|
1909
|
+
/** Download Report */
|
|
1910
|
+
get: operations["download_report_v1_reports__report_id__download_get"];
|
|
1911
|
+
put?: never;
|
|
1912
|
+
post?: never;
|
|
1913
|
+
delete?: never;
|
|
1914
|
+
options?: never;
|
|
1915
|
+
head?: never;
|
|
1916
|
+
patch?: never;
|
|
1917
|
+
trace?: never;
|
|
1918
|
+
};
|
|
1728
1919
|
"/v1/tlds/": {
|
|
1729
1920
|
parameters: {
|
|
1730
1921
|
query?: never;
|
|
@@ -1953,6 +2144,16 @@ export interface components {
|
|
|
1953
2144
|
* @enum {string}
|
|
1954
2145
|
*/
|
|
1955
2146
|
AttributeType: "enum" | "string" | "boolean" | "datetime" | "integer";
|
|
2147
|
+
/**
|
|
2148
|
+
* BatchSortField
|
|
2149
|
+
* @enum {string}
|
|
2150
|
+
*/
|
|
2151
|
+
BatchSortField: "created_on" | "started_at" | "finished_at";
|
|
2152
|
+
/**
|
|
2153
|
+
* BatchStatus
|
|
2154
|
+
* @enum {string}
|
|
2155
|
+
*/
|
|
2156
|
+
BatchStatus: "pending" | "complete";
|
|
1956
2157
|
/** BillingMetadata */
|
|
1957
2158
|
BillingMetadata: {
|
|
1958
2159
|
/**
|
|
@@ -2092,6 +2293,19 @@ export interface components {
|
|
|
2092
2293
|
/** Unique */
|
|
2093
2294
|
unique: number;
|
|
2094
2295
|
};
|
|
2296
|
+
/** CommandError */
|
|
2297
|
+
CommandError: {
|
|
2298
|
+
/**
|
|
2299
|
+
* Error
|
|
2300
|
+
* @description Error message
|
|
2301
|
+
*/
|
|
2302
|
+
error: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* Index
|
|
2305
|
+
* @description Index of the failed command in the request
|
|
2306
|
+
*/
|
|
2307
|
+
index: number;
|
|
2308
|
+
};
|
|
2095
2309
|
/**
|
|
2096
2310
|
* ComplianceStatus
|
|
2097
2311
|
* @enum {string}
|
|
@@ -2366,166 +2580,398 @@ export interface components {
|
|
|
2366
2580
|
*/
|
|
2367
2581
|
title?: string | null;
|
|
2368
2582
|
};
|
|
2369
|
-
/**
|
|
2370
|
-
|
|
2583
|
+
/** ContactCreateBulkCommand */
|
|
2584
|
+
ContactCreateBulkCommand: {
|
|
2371
2585
|
/**
|
|
2372
|
-
*
|
|
2373
|
-
* @
|
|
2586
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2587
|
+
* @enum {string}
|
|
2374
2588
|
*/
|
|
2375
|
-
|
|
2376
|
-
[key: string]: string;
|
|
2377
|
-
} | null;
|
|
2589
|
+
command: "contact_create_bulk";
|
|
2378
2590
|
/**
|
|
2379
|
-
*
|
|
2380
|
-
*
|
|
2381
|
-
* @description The contact id of the contact
|
|
2382
|
-
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2591
|
+
* Idempotency Key
|
|
2592
|
+
* @description Idempotency key for this bulk command
|
|
2383
2593
|
*/
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
ContactIdList: {
|
|
2388
|
-
[key: string]: TypeId<"contact">;
|
|
2389
|
-
};
|
|
2390
|
-
/** ContactResponse */
|
|
2391
|
-
ContactResponse: {
|
|
2594
|
+
idempotency_key?: string | null;
|
|
2595
|
+
/** @description Bulk contact creation payload */
|
|
2596
|
+
payload: components["schemas"]["ContactCreateBulkPayload"];
|
|
2392
2597
|
/**
|
|
2393
|
-
*
|
|
2394
|
-
* @description
|
|
2598
|
+
* Version
|
|
2599
|
+
* @description Command version
|
|
2600
|
+
* @default v1
|
|
2395
2601
|
*/
|
|
2396
|
-
|
|
2602
|
+
version: string;
|
|
2603
|
+
};
|
|
2604
|
+
/** ContactCreateBulkInstance */
|
|
2605
|
+
ContactCreateBulkInstance: {
|
|
2397
2606
|
/**
|
|
2398
2607
|
* City
|
|
2399
|
-
* @description
|
|
2608
|
+
* @description City
|
|
2400
2609
|
*/
|
|
2401
2610
|
city: string;
|
|
2402
|
-
/**
|
|
2403
|
-
* Contact Id
|
|
2404
|
-
* Format: typeid
|
|
2405
|
-
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2406
|
-
*/
|
|
2407
|
-
contact_id?: TypeId<"contact">;
|
|
2408
2611
|
/**
|
|
2409
2612
|
* Country
|
|
2410
|
-
* @description
|
|
2411
|
-
*/
|
|
2412
|
-
country: string;
|
|
2413
|
-
/**
|
|
2414
|
-
* Created On
|
|
2415
|
-
* Format: date-time
|
|
2416
|
-
* @description The date/time the entry was created on
|
|
2613
|
+
* @description Override country for this contact
|
|
2417
2614
|
*/
|
|
2418
|
-
|
|
2615
|
+
country?: string | null;
|
|
2419
2616
|
/**
|
|
2420
2617
|
* Disclose
|
|
2421
|
-
* @description
|
|
2618
|
+
* @description Override disclose setting for this contact
|
|
2422
2619
|
*/
|
|
2423
|
-
disclose
|
|
2620
|
+
disclose?: boolean | null;
|
|
2424
2621
|
/**
|
|
2425
2622
|
* Email
|
|
2426
2623
|
* Format: email
|
|
2427
|
-
* @description
|
|
2624
|
+
* @description Email address of the contact
|
|
2428
2625
|
*/
|
|
2429
2626
|
email: string;
|
|
2430
2627
|
/**
|
|
2431
2628
|
* Fax
|
|
2432
|
-
* @description
|
|
2629
|
+
* @description Fax number in international format
|
|
2433
2630
|
*/
|
|
2434
2631
|
fax?: string | null;
|
|
2435
2632
|
/**
|
|
2436
2633
|
* First Name
|
|
2437
|
-
* @description
|
|
2634
|
+
* @description First name of the contact
|
|
2438
2635
|
*/
|
|
2439
2636
|
first_name: string;
|
|
2440
2637
|
/**
|
|
2441
2638
|
* Last Name
|
|
2442
|
-
* @description
|
|
2639
|
+
* @description Last name of the contact
|
|
2443
2640
|
*/
|
|
2444
2641
|
last_name: string;
|
|
2445
2642
|
/**
|
|
2446
2643
|
* Org
|
|
2447
|
-
* @description
|
|
2644
|
+
* @description Override organization for this contact
|
|
2448
2645
|
*/
|
|
2449
2646
|
org?: string | null;
|
|
2450
|
-
/**
|
|
2451
|
-
* Organization Id
|
|
2452
|
-
* Format: typeid
|
|
2453
|
-
* @description The organization that owns the domain
|
|
2454
|
-
* @default None
|
|
2455
|
-
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
2456
|
-
*/
|
|
2457
|
-
organization_id: TypeId<"organization">;
|
|
2458
2647
|
/**
|
|
2459
2648
|
* Phone
|
|
2460
2649
|
* Format: phone
|
|
2461
|
-
* @description
|
|
2462
|
-
* @example +1.2125552368
|
|
2650
|
+
* @description Phone number in international format
|
|
2463
2651
|
*/
|
|
2464
2652
|
phone: string;
|
|
2465
2653
|
/**
|
|
2466
2654
|
* Postal Code
|
|
2467
|
-
* @description
|
|
2655
|
+
* @description Postal code
|
|
2468
2656
|
*/
|
|
2469
2657
|
postal_code: string;
|
|
2470
2658
|
/**
|
|
2471
2659
|
* State
|
|
2472
|
-
* @description
|
|
2660
|
+
* @description Override state for this contact
|
|
2473
2661
|
*/
|
|
2474
2662
|
state?: string | null;
|
|
2475
2663
|
/**
|
|
2476
2664
|
* Street
|
|
2477
|
-
* @description
|
|
2665
|
+
* @description Street address
|
|
2478
2666
|
*/
|
|
2479
2667
|
street: string;
|
|
2480
2668
|
/**
|
|
2481
2669
|
* Title
|
|
2482
|
-
* @description
|
|
2670
|
+
* @description Override title for this contact
|
|
2483
2671
|
*/
|
|
2484
2672
|
title?: string | null;
|
|
2485
2673
|
};
|
|
2486
|
-
/**
|
|
2487
|
-
|
|
2674
|
+
/** ContactCreateBulkPayload */
|
|
2675
|
+
ContactCreateBulkPayload: {
|
|
2488
2676
|
/**
|
|
2489
|
-
*
|
|
2490
|
-
* @description
|
|
2491
|
-
*/
|
|
2492
|
-
city: string;
|
|
2493
|
-
/**
|
|
2494
|
-
* Contact Id
|
|
2495
|
-
* Format: typeid
|
|
2496
|
-
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2677
|
+
* Instances
|
|
2678
|
+
* @description List of contacts to create (1-1000)
|
|
2497
2679
|
*/
|
|
2498
|
-
|
|
2680
|
+
instances: components["schemas"]["ContactCreateBulkInstance"][];
|
|
2681
|
+
/** @description Shared settings for all contacts */
|
|
2682
|
+
template: components["schemas"]["ContactCreateBulkTemplate"];
|
|
2683
|
+
};
|
|
2684
|
+
/** ContactCreateBulkTemplate */
|
|
2685
|
+
ContactCreateBulkTemplate: {
|
|
2499
2686
|
/**
|
|
2500
2687
|
* Country
|
|
2501
|
-
* @description The country of the
|
|
2688
|
+
* @description The country of the contacts
|
|
2502
2689
|
*/
|
|
2503
2690
|
country: string;
|
|
2504
|
-
/**
|
|
2505
|
-
* Created On
|
|
2506
|
-
* Format: date-time
|
|
2507
|
-
* @description The date/time the entry was created on
|
|
2508
|
-
*/
|
|
2509
|
-
created_on?: Date;
|
|
2510
2691
|
/**
|
|
2511
2692
|
* Disclose
|
|
2512
|
-
* @description Whether
|
|
2693
|
+
* @description Whether contact details should be disclosed in WHOIS
|
|
2513
2694
|
*/
|
|
2514
2695
|
disclose: boolean;
|
|
2515
2696
|
/**
|
|
2516
|
-
*
|
|
2517
|
-
*
|
|
2518
|
-
* @description The email of the contact
|
|
2697
|
+
* Org
|
|
2698
|
+
* @description Organization name
|
|
2519
2699
|
*/
|
|
2520
|
-
|
|
2700
|
+
org?: string | null;
|
|
2521
2701
|
/**
|
|
2522
|
-
*
|
|
2523
|
-
* @description
|
|
2702
|
+
* State
|
|
2703
|
+
* @description State/province
|
|
2524
2704
|
*/
|
|
2525
|
-
|
|
2705
|
+
state?: string | null;
|
|
2526
2706
|
/**
|
|
2527
|
-
*
|
|
2528
|
-
* @description
|
|
2707
|
+
* Title
|
|
2708
|
+
* @description Contact title
|
|
2709
|
+
*/
|
|
2710
|
+
title?: string | null;
|
|
2711
|
+
};
|
|
2712
|
+
/** ContactCreateCommand */
|
|
2713
|
+
ContactCreateCommand: {
|
|
2714
|
+
/**
|
|
2715
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2716
|
+
* @enum {string}
|
|
2717
|
+
*/
|
|
2718
|
+
command: "contact_create";
|
|
2719
|
+
/**
|
|
2720
|
+
* Idempotency Key
|
|
2721
|
+
* @description Idempotency key for this command
|
|
2722
|
+
*/
|
|
2723
|
+
idempotency_key?: string | null;
|
|
2724
|
+
/** @description Contact creation payload */
|
|
2725
|
+
payload: components["schemas"]["ContactCreatePayloadData"];
|
|
2726
|
+
/**
|
|
2727
|
+
* Version
|
|
2728
|
+
* @description Command version
|
|
2729
|
+
* @default v1
|
|
2730
|
+
*/
|
|
2731
|
+
version: string;
|
|
2732
|
+
};
|
|
2733
|
+
/** ContactCreatePayloadData */
|
|
2734
|
+
ContactCreatePayloadData: {
|
|
2735
|
+
/**
|
|
2736
|
+
* City
|
|
2737
|
+
* @description The city of the contact
|
|
2738
|
+
*/
|
|
2739
|
+
city: string;
|
|
2740
|
+
/**
|
|
2741
|
+
* Country
|
|
2742
|
+
* @description The country of the contact
|
|
2743
|
+
*/
|
|
2744
|
+
country: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* Disclose
|
|
2747
|
+
* @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
2748
|
+
*/
|
|
2749
|
+
disclose: boolean;
|
|
2750
|
+
/**
|
|
2751
|
+
* Email
|
|
2752
|
+
* Format: email
|
|
2753
|
+
* @description The email of the contact
|
|
2754
|
+
*/
|
|
2755
|
+
email: string;
|
|
2756
|
+
/**
|
|
2757
|
+
* Fax
|
|
2758
|
+
* @description The contacts's fax number
|
|
2759
|
+
*/
|
|
2760
|
+
fax?: string | null;
|
|
2761
|
+
/**
|
|
2762
|
+
* First Name
|
|
2763
|
+
* @description The first name of the contact
|
|
2764
|
+
*/
|
|
2765
|
+
first_name: string;
|
|
2766
|
+
/**
|
|
2767
|
+
* Last Name
|
|
2768
|
+
* @description The last name of the contact
|
|
2769
|
+
*/
|
|
2770
|
+
last_name: string;
|
|
2771
|
+
/**
|
|
2772
|
+
* Org
|
|
2773
|
+
* @description The organization of the contact
|
|
2774
|
+
*/
|
|
2775
|
+
org?: string | null;
|
|
2776
|
+
/**
|
|
2777
|
+
* Phone
|
|
2778
|
+
* Format: phone
|
|
2779
|
+
* @description The contact's phone number
|
|
2780
|
+
* @example +1.2125552368
|
|
2781
|
+
*/
|
|
2782
|
+
phone: string;
|
|
2783
|
+
/**
|
|
2784
|
+
* Postal Code
|
|
2785
|
+
* @description The postal code of the contact
|
|
2786
|
+
*/
|
|
2787
|
+
postal_code: string;
|
|
2788
|
+
/**
|
|
2789
|
+
* State
|
|
2790
|
+
* @description The state of the contact
|
|
2791
|
+
*/
|
|
2792
|
+
state?: string | null;
|
|
2793
|
+
/**
|
|
2794
|
+
* Street
|
|
2795
|
+
* @description The address of the contact
|
|
2796
|
+
*/
|
|
2797
|
+
street: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* Title
|
|
2800
|
+
* @description The title of the contact
|
|
2801
|
+
*/
|
|
2802
|
+
title?: string | null;
|
|
2803
|
+
};
|
|
2804
|
+
/** ContactCreateWorkerPayload */
|
|
2805
|
+
ContactCreateWorkerPayload: {
|
|
2806
|
+
contact: components["schemas"]["ContactCreatePayloadData"];
|
|
2807
|
+
/** Operation */
|
|
2808
|
+
operation: string;
|
|
2809
|
+
/**
|
|
2810
|
+
* @description discriminator enum property added by openapi-typescript
|
|
2811
|
+
* @enum {string}
|
|
2812
|
+
*/
|
|
2813
|
+
type: "contact_create" | "contact_create_bulk";
|
|
2814
|
+
};
|
|
2815
|
+
/** ContactHandle */
|
|
2816
|
+
ContactHandle: {
|
|
2817
|
+
/**
|
|
2818
|
+
* Attributes
|
|
2819
|
+
* @description Additional attributes related to the contact
|
|
2820
|
+
*/
|
|
2821
|
+
attributes?: {
|
|
2822
|
+
[key: string]: string;
|
|
2823
|
+
} | null;
|
|
2824
|
+
/**
|
|
2825
|
+
* Contact Id
|
|
2826
|
+
* Format: typeid
|
|
2827
|
+
* @description The contact id of the contact
|
|
2828
|
+
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2829
|
+
*/
|
|
2830
|
+
contact_id: TypeId<"contact">;
|
|
2831
|
+
};
|
|
2832
|
+
/** @description The contacts of the domain */
|
|
2833
|
+
ContactIdList: {
|
|
2834
|
+
[key: string]: TypeId<"contact">;
|
|
2835
|
+
};
|
|
2836
|
+
/** ContactResponse */
|
|
2837
|
+
ContactResponse: {
|
|
2838
|
+
/**
|
|
2839
|
+
* Attribute Sets
|
|
2840
|
+
* @description Linked attribute sets for this contact
|
|
2841
|
+
*/
|
|
2842
|
+
attribute_sets?: components["schemas"]["ContactAttributeLinkDetail"][];
|
|
2843
|
+
/**
|
|
2844
|
+
* City
|
|
2845
|
+
* @description The city of the contact
|
|
2846
|
+
*/
|
|
2847
|
+
city: string;
|
|
2848
|
+
/**
|
|
2849
|
+
* Contact Id
|
|
2850
|
+
* Format: typeid
|
|
2851
|
+
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2852
|
+
*/
|
|
2853
|
+
contact_id?: TypeId<"contact">;
|
|
2854
|
+
/**
|
|
2855
|
+
* Country
|
|
2856
|
+
* @description The country of the contact
|
|
2857
|
+
*/
|
|
2858
|
+
country: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* Created On
|
|
2861
|
+
* Format: date-time
|
|
2862
|
+
* @description The date/time the entry was created on
|
|
2863
|
+
*/
|
|
2864
|
+
created_on?: Date;
|
|
2865
|
+
/**
|
|
2866
|
+
* Disclose
|
|
2867
|
+
* @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
2868
|
+
*/
|
|
2869
|
+
disclose: boolean;
|
|
2870
|
+
/**
|
|
2871
|
+
* Email
|
|
2872
|
+
* Format: email
|
|
2873
|
+
* @description The email of the contact
|
|
2874
|
+
*/
|
|
2875
|
+
email: string;
|
|
2876
|
+
/**
|
|
2877
|
+
* Fax
|
|
2878
|
+
* @description The contacts's fax number
|
|
2879
|
+
*/
|
|
2880
|
+
fax?: string | null;
|
|
2881
|
+
/**
|
|
2882
|
+
* First Name
|
|
2883
|
+
* @description The first name of the contact
|
|
2884
|
+
*/
|
|
2885
|
+
first_name: string;
|
|
2886
|
+
/**
|
|
2887
|
+
* Last Name
|
|
2888
|
+
* @description The last name of the contact
|
|
2889
|
+
*/
|
|
2890
|
+
last_name: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* Org
|
|
2893
|
+
* @description The organization of the contact
|
|
2894
|
+
*/
|
|
2895
|
+
org?: string | null;
|
|
2896
|
+
/**
|
|
2897
|
+
* Organization Id
|
|
2898
|
+
* Format: typeid
|
|
2899
|
+
* @description The organization that owns the domain
|
|
2900
|
+
* @default None
|
|
2901
|
+
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
2902
|
+
*/
|
|
2903
|
+
organization_id: TypeId<"organization">;
|
|
2904
|
+
/**
|
|
2905
|
+
* Phone
|
|
2906
|
+
* Format: phone
|
|
2907
|
+
* @description The contact's phone number
|
|
2908
|
+
* @example +1.2125552368
|
|
2909
|
+
*/
|
|
2910
|
+
phone: string;
|
|
2911
|
+
/**
|
|
2912
|
+
* Postal Code
|
|
2913
|
+
* @description The postal code of the contact
|
|
2914
|
+
*/
|
|
2915
|
+
postal_code: string;
|
|
2916
|
+
/**
|
|
2917
|
+
* State
|
|
2918
|
+
* @description The state of the contact
|
|
2919
|
+
*/
|
|
2920
|
+
state?: string | null;
|
|
2921
|
+
/**
|
|
2922
|
+
* Street
|
|
2923
|
+
* @description The address of the contact
|
|
2924
|
+
*/
|
|
2925
|
+
street: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* Title
|
|
2928
|
+
* @description The title of the contact
|
|
2929
|
+
*/
|
|
2930
|
+
title?: string | null;
|
|
2931
|
+
};
|
|
2932
|
+
/** ContactSchema */
|
|
2933
|
+
ContactSchema: {
|
|
2934
|
+
/**
|
|
2935
|
+
* City
|
|
2936
|
+
* @description The city of the contact
|
|
2937
|
+
*/
|
|
2938
|
+
city: string;
|
|
2939
|
+
/**
|
|
2940
|
+
* Contact Id
|
|
2941
|
+
* Format: typeid
|
|
2942
|
+
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2943
|
+
*/
|
|
2944
|
+
contact_id?: TypeId<"contact">;
|
|
2945
|
+
/**
|
|
2946
|
+
* Country
|
|
2947
|
+
* @description The country of the contact
|
|
2948
|
+
*/
|
|
2949
|
+
country: string;
|
|
2950
|
+
/**
|
|
2951
|
+
* Created On
|
|
2952
|
+
* Format: date-time
|
|
2953
|
+
* @description The date/time the entry was created on
|
|
2954
|
+
*/
|
|
2955
|
+
created_on?: Date;
|
|
2956
|
+
/**
|
|
2957
|
+
* Disclose
|
|
2958
|
+
* @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
2959
|
+
*/
|
|
2960
|
+
disclose: boolean;
|
|
2961
|
+
/**
|
|
2962
|
+
* Email
|
|
2963
|
+
* Format: email
|
|
2964
|
+
* @description The email of the contact
|
|
2965
|
+
*/
|
|
2966
|
+
email: string;
|
|
2967
|
+
/**
|
|
2968
|
+
* Fax
|
|
2969
|
+
* @description The contacts's fax number
|
|
2970
|
+
*/
|
|
2971
|
+
fax?: string | null;
|
|
2972
|
+
/**
|
|
2973
|
+
* First Name
|
|
2974
|
+
* @description The first name of the contact
|
|
2529
2975
|
*/
|
|
2530
2976
|
first_name: string;
|
|
2531
2977
|
/**
|
|
@@ -2782,18 +3228,58 @@ export interface components {
|
|
|
2782
3228
|
*/
|
|
2783
3229
|
update_supported_roles?: components["schemas"]["ContactConfigBase"][] | null;
|
|
2784
3230
|
};
|
|
2785
|
-
/**
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
|
|
2790
|
-
|
|
2791
|
-
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
3231
|
+
/** CreateJobBatchResponse */
|
|
3232
|
+
CreateJobBatchResponse: {
|
|
3233
|
+
/**
|
|
3234
|
+
* Batch Id
|
|
3235
|
+
* Format: typeid
|
|
3236
|
+
* @description TypeID identifying this batch
|
|
3237
|
+
* @example batch_01h45ytscbebyvny4gc8cr8ma2
|
|
3238
|
+
*/
|
|
3239
|
+
batch_id: TypeId<"batch">;
|
|
3240
|
+
/**
|
|
3241
|
+
* Errors
|
|
3242
|
+
* @description Details of failed commands
|
|
3243
|
+
*/
|
|
3244
|
+
errors?: components["schemas"]["CommandError"][];
|
|
3245
|
+
/**
|
|
3246
|
+
* Jobs Created
|
|
3247
|
+
* @description Number of jobs successfully created
|
|
3248
|
+
*/
|
|
3249
|
+
jobs_created: number;
|
|
3250
|
+
/**
|
|
3251
|
+
* Jobs Failed
|
|
3252
|
+
* @description Number of jobs that failed to create
|
|
3253
|
+
*/
|
|
3254
|
+
jobs_failed: number;
|
|
3255
|
+
/**
|
|
3256
|
+
* Status Url
|
|
3257
|
+
* @description URL to check batch status
|
|
3258
|
+
*/
|
|
3259
|
+
status_url: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* Total Commands
|
|
3262
|
+
* @description Total commands in the batch
|
|
3263
|
+
*/
|
|
3264
|
+
total_commands: number;
|
|
3265
|
+
};
|
|
3266
|
+
/** CreateReportReq */
|
|
3267
|
+
CreateReportReq: {
|
|
3268
|
+
/** @default domain_inventory */
|
|
3269
|
+
report_type: components["schemas"]["ReportType"];
|
|
3270
|
+
};
|
|
3271
|
+
/**
|
|
3272
|
+
* Currency
|
|
3273
|
+
* @enum {string}
|
|
3274
|
+
*/
|
|
3275
|
+
Currency: "USD" | "EUR";
|
|
3276
|
+
/**
|
|
3277
|
+
* DeletePolicyType
|
|
3278
|
+
* @enum {string}
|
|
3279
|
+
*/
|
|
3280
|
+
DeletePolicyType: "immediate" | "expiration";
|
|
3281
|
+
/** DeletedEvent */
|
|
3282
|
+
DeletedEvent: {
|
|
2797
3283
|
date: components["schemas"]["EppDateTime"];
|
|
2798
3284
|
};
|
|
2799
3285
|
/**
|
|
@@ -2959,6 +3445,193 @@ export interface components {
|
|
|
2959
3445
|
/** Rrsets */
|
|
2960
3446
|
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
2961
3447
|
};
|
|
3448
|
+
/** DnsZoneCreateBulkCommand */
|
|
3449
|
+
DnsZoneCreateBulkCommand: {
|
|
3450
|
+
/**
|
|
3451
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3452
|
+
* @enum {string}
|
|
3453
|
+
*/
|
|
3454
|
+
command: "dns_zone_create_bulk";
|
|
3455
|
+
/**
|
|
3456
|
+
* Idempotency Key
|
|
3457
|
+
* @description Idempotency key for this bulk command
|
|
3458
|
+
*/
|
|
3459
|
+
idempotency_key?: string | null;
|
|
3460
|
+
/** @description Bulk DNS zone creation payload */
|
|
3461
|
+
payload: components["schemas"]["DnsZoneCreateBulkPayload"];
|
|
3462
|
+
/**
|
|
3463
|
+
* Version
|
|
3464
|
+
* @description Command version
|
|
3465
|
+
* @default v1
|
|
3466
|
+
*/
|
|
3467
|
+
version: string;
|
|
3468
|
+
};
|
|
3469
|
+
/** DnsZoneCreateBulkInstance */
|
|
3470
|
+
DnsZoneCreateBulkInstance: {
|
|
3471
|
+
/**
|
|
3472
|
+
* Name
|
|
3473
|
+
* @description The DNS zone name (e.g., example.com)
|
|
3474
|
+
*/
|
|
3475
|
+
name: string;
|
|
3476
|
+
/**
|
|
3477
|
+
* Rrsets
|
|
3478
|
+
* @description Override RRsets for this zone
|
|
3479
|
+
*/
|
|
3480
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][] | null;
|
|
3481
|
+
};
|
|
3482
|
+
/** DnsZoneCreateBulkPayload */
|
|
3483
|
+
DnsZoneCreateBulkPayload: {
|
|
3484
|
+
/**
|
|
3485
|
+
* Instances
|
|
3486
|
+
* @description List of zones to create (1-1000)
|
|
3487
|
+
*/
|
|
3488
|
+
instances: components["schemas"]["DnsZoneCreateBulkInstance"][];
|
|
3489
|
+
/** @description Shared RRsets for all zones */
|
|
3490
|
+
template: components["schemas"]["DnsZoneCreateBulkTemplate"];
|
|
3491
|
+
};
|
|
3492
|
+
/** DnsZoneCreateBulkTemplate */
|
|
3493
|
+
DnsZoneCreateBulkTemplate: {
|
|
3494
|
+
/**
|
|
3495
|
+
* Rrsets
|
|
3496
|
+
* @description DNS record sets to create
|
|
3497
|
+
*/
|
|
3498
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
3499
|
+
};
|
|
3500
|
+
/** DnsZoneCreateCommand */
|
|
3501
|
+
DnsZoneCreateCommand: {
|
|
3502
|
+
/**
|
|
3503
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3504
|
+
* @enum {string}
|
|
3505
|
+
*/
|
|
3506
|
+
command: "dns_zone_create";
|
|
3507
|
+
/**
|
|
3508
|
+
* Idempotency Key
|
|
3509
|
+
* @description Idempotency key for this command
|
|
3510
|
+
*/
|
|
3511
|
+
idempotency_key?: string | null;
|
|
3512
|
+
/** @description DNS zone creation payload */
|
|
3513
|
+
payload: components["schemas"]["DnsZoneCreatePayloadData"];
|
|
3514
|
+
/**
|
|
3515
|
+
* Version
|
|
3516
|
+
* @description Command version
|
|
3517
|
+
* @default v1
|
|
3518
|
+
*/
|
|
3519
|
+
version: string;
|
|
3520
|
+
};
|
|
3521
|
+
/** DnsZoneCreatePayloadData */
|
|
3522
|
+
DnsZoneCreatePayloadData: {
|
|
3523
|
+
/** @default disabled */
|
|
3524
|
+
dnssec_status: components["schemas"]["DnssecStatus"];
|
|
3525
|
+
/** Name */
|
|
3526
|
+
name: string;
|
|
3527
|
+
/** Rrsets */
|
|
3528
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
3529
|
+
};
|
|
3530
|
+
/** DnsZoneCreateWorkerPayload */
|
|
3531
|
+
DnsZoneCreateWorkerPayload: {
|
|
3532
|
+
/** Operation */
|
|
3533
|
+
operation: string;
|
|
3534
|
+
/**
|
|
3535
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3536
|
+
* @enum {string}
|
|
3537
|
+
*/
|
|
3538
|
+
type: "dns_zone_create" | "dns_zone_create_bulk";
|
|
3539
|
+
zone: components["schemas"]["DnsZoneCreatePayloadData"];
|
|
3540
|
+
};
|
|
3541
|
+
/** DnsZonePatchRecordsBulkCommand */
|
|
3542
|
+
DnsZonePatchRecordsBulkCommand: {
|
|
3543
|
+
/**
|
|
3544
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3545
|
+
* @enum {string}
|
|
3546
|
+
*/
|
|
3547
|
+
command: "dns_zone_patch_records_bulk";
|
|
3548
|
+
/**
|
|
3549
|
+
* Idempotency Key
|
|
3550
|
+
* @description Idempotency key for this command
|
|
3551
|
+
*/
|
|
3552
|
+
idempotency_key?: string | null;
|
|
3553
|
+
/** @description DNS zone patch records bulk payload */
|
|
3554
|
+
payload: components["schemas"]["DnsZonePatchRecordsBulkPayload"];
|
|
3555
|
+
/**
|
|
3556
|
+
* Version
|
|
3557
|
+
* @description Command version
|
|
3558
|
+
* @default v1
|
|
3559
|
+
*/
|
|
3560
|
+
version: string;
|
|
3561
|
+
};
|
|
3562
|
+
/** DnsZonePatchRecordsBulkInstance */
|
|
3563
|
+
DnsZonePatchRecordsBulkInstance: {
|
|
3564
|
+
/** Ops */
|
|
3565
|
+
ops: components["schemas"]["DnsRecordPatchOp"][];
|
|
3566
|
+
/**
|
|
3567
|
+
* Zone Name
|
|
3568
|
+
* @description DNS zone name to patch
|
|
3569
|
+
*/
|
|
3570
|
+
zone_name: string;
|
|
3571
|
+
};
|
|
3572
|
+
/** DnsZonePatchRecordsBulkPayload */
|
|
3573
|
+
DnsZonePatchRecordsBulkPayload: {
|
|
3574
|
+
/** Instances */
|
|
3575
|
+
instances: components["schemas"]["DnsZonePatchRecordsBulkInstance"][];
|
|
3576
|
+
};
|
|
3577
|
+
/** DnsZonePatchRecordsWorkerPayload */
|
|
3578
|
+
DnsZonePatchRecordsWorkerPayload: {
|
|
3579
|
+
/** Operation */
|
|
3580
|
+
operation: string;
|
|
3581
|
+
/**
|
|
3582
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3583
|
+
* @enum {string}
|
|
3584
|
+
*/
|
|
3585
|
+
type: "dns_zone_patch_records_bulk";
|
|
3586
|
+
zone: components["schemas"]["DnsZonePatchRecordsBulkInstance"];
|
|
3587
|
+
};
|
|
3588
|
+
/** DnsZonePatchRrsetsBulkCommand */
|
|
3589
|
+
DnsZonePatchRrsetsBulkCommand: {
|
|
3590
|
+
/**
|
|
3591
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3592
|
+
* @enum {string}
|
|
3593
|
+
*/
|
|
3594
|
+
command: "dns_zone_patch_rrsets_bulk";
|
|
3595
|
+
/**
|
|
3596
|
+
* Idempotency Key
|
|
3597
|
+
* @description Idempotency key for this command
|
|
3598
|
+
*/
|
|
3599
|
+
idempotency_key?: string | null;
|
|
3600
|
+
/** @description DNS zone patch rrsets bulk payload */
|
|
3601
|
+
payload: components["schemas"]["DnsZonePatchRrsetsBulkPayload"];
|
|
3602
|
+
/**
|
|
3603
|
+
* Version
|
|
3604
|
+
* @description Command version
|
|
3605
|
+
* @default v1
|
|
3606
|
+
*/
|
|
3607
|
+
version: string;
|
|
3608
|
+
};
|
|
3609
|
+
/** DnsZonePatchRrsetsBulkInstance */
|
|
3610
|
+
DnsZonePatchRrsetsBulkInstance: {
|
|
3611
|
+
/** Ops */
|
|
3612
|
+
ops: components["schemas"]["DnsRrsetPatchOp"][];
|
|
3613
|
+
/**
|
|
3614
|
+
* Zone Name
|
|
3615
|
+
* @description DNS zone name to patch
|
|
3616
|
+
*/
|
|
3617
|
+
zone_name: string;
|
|
3618
|
+
};
|
|
3619
|
+
/** DnsZonePatchRrsetsBulkPayload */
|
|
3620
|
+
DnsZonePatchRrsetsBulkPayload: {
|
|
3621
|
+
/** Instances */
|
|
3622
|
+
instances: components["schemas"]["DnsZonePatchRrsetsBulkInstance"][];
|
|
3623
|
+
};
|
|
3624
|
+
/** DnsZonePatchRrsetsWorkerPayload */
|
|
3625
|
+
DnsZonePatchRrsetsWorkerPayload: {
|
|
3626
|
+
/** Operation */
|
|
3627
|
+
operation: string;
|
|
3628
|
+
/**
|
|
3629
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3630
|
+
* @enum {string}
|
|
3631
|
+
*/
|
|
3632
|
+
type: "dns_zone_patch_rrsets_bulk";
|
|
3633
|
+
zone: components["schemas"]["DnsZonePatchRrsetsBulkInstance"];
|
|
3634
|
+
};
|
|
2962
3635
|
/** DnsZoneRecordsPatchOps */
|
|
2963
3636
|
DnsZoneRecordsPatchOps: {
|
|
2964
3637
|
/** Ops */
|
|
@@ -3011,6 +3684,99 @@ export interface components {
|
|
|
3011
3684
|
[key: string]: number;
|
|
3012
3685
|
};
|
|
3013
3686
|
};
|
|
3687
|
+
/** DnsZoneUpdateBulkCommand */
|
|
3688
|
+
DnsZoneUpdateBulkCommand: {
|
|
3689
|
+
/**
|
|
3690
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3691
|
+
* @enum {string}
|
|
3692
|
+
*/
|
|
3693
|
+
command: "dns_zone_update_bulk";
|
|
3694
|
+
/**
|
|
3695
|
+
* Idempotency Key
|
|
3696
|
+
* @description Idempotency key for this bulk command
|
|
3697
|
+
*/
|
|
3698
|
+
idempotency_key?: string | null;
|
|
3699
|
+
/** @description Bulk DNS zone update payload */
|
|
3700
|
+
payload: components["schemas"]["DnsZoneUpdateBulkPayload"];
|
|
3701
|
+
/**
|
|
3702
|
+
* Version
|
|
3703
|
+
* @description Command version
|
|
3704
|
+
* @default v1
|
|
3705
|
+
*/
|
|
3706
|
+
version: string;
|
|
3707
|
+
};
|
|
3708
|
+
/** DnsZoneUpdateBulkInstance */
|
|
3709
|
+
DnsZoneUpdateBulkInstance: {
|
|
3710
|
+
/**
|
|
3711
|
+
* Name
|
|
3712
|
+
* @description The DNS zone name (e.g., example.com)
|
|
3713
|
+
*/
|
|
3714
|
+
name: string;
|
|
3715
|
+
/**
|
|
3716
|
+
* Rrsets
|
|
3717
|
+
* @description Override RRsets for this zone
|
|
3718
|
+
*/
|
|
3719
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][] | null;
|
|
3720
|
+
};
|
|
3721
|
+
/** DnsZoneUpdateBulkPayload */
|
|
3722
|
+
DnsZoneUpdateBulkPayload: {
|
|
3723
|
+
/**
|
|
3724
|
+
* Instances
|
|
3725
|
+
* @description List of zones to update (1-1000)
|
|
3726
|
+
*/
|
|
3727
|
+
instances: components["schemas"]["DnsZoneUpdateBulkInstance"][];
|
|
3728
|
+
/** @description Shared RRsets for all zones */
|
|
3729
|
+
template: components["schemas"]["DnsZoneUpdateBulkTemplate"];
|
|
3730
|
+
};
|
|
3731
|
+
/** DnsZoneUpdateBulkTemplate */
|
|
3732
|
+
DnsZoneUpdateBulkTemplate: {
|
|
3733
|
+
/**
|
|
3734
|
+
* Rrsets
|
|
3735
|
+
* @description DNS record sets to update
|
|
3736
|
+
*/
|
|
3737
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
3738
|
+
};
|
|
3739
|
+
/** DnsZoneUpdateCommand */
|
|
3740
|
+
DnsZoneUpdateCommand: {
|
|
3741
|
+
/**
|
|
3742
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3743
|
+
* @enum {string}
|
|
3744
|
+
*/
|
|
3745
|
+
command: "dns_zone_update";
|
|
3746
|
+
/**
|
|
3747
|
+
* Idempotency Key
|
|
3748
|
+
* @description Idempotency key for this command
|
|
3749
|
+
*/
|
|
3750
|
+
idempotency_key?: string | null;
|
|
3751
|
+
/** @description DNS zone update payload */
|
|
3752
|
+
payload: components["schemas"]["DnsZoneUpdatePayloadData"];
|
|
3753
|
+
/**
|
|
3754
|
+
* Version
|
|
3755
|
+
* @description Command version
|
|
3756
|
+
* @default v1
|
|
3757
|
+
*/
|
|
3758
|
+
version: string;
|
|
3759
|
+
};
|
|
3760
|
+
/** DnsZoneUpdatePayloadData */
|
|
3761
|
+
DnsZoneUpdatePayloadData: {
|
|
3762
|
+
/** @default disabled */
|
|
3763
|
+
dnssec_status: components["schemas"]["DnssecStatus"];
|
|
3764
|
+
/** Name */
|
|
3765
|
+
name: string;
|
|
3766
|
+
/** Rrsets */
|
|
3767
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
3768
|
+
};
|
|
3769
|
+
/** DnsZoneUpdateWorkerPayload */
|
|
3770
|
+
DnsZoneUpdateWorkerPayload: {
|
|
3771
|
+
/** Operation */
|
|
3772
|
+
operation: string;
|
|
3773
|
+
/**
|
|
3774
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3775
|
+
* @enum {string}
|
|
3776
|
+
*/
|
|
3777
|
+
type: "dns_zone_update" | "dns_zone_update_bulk";
|
|
3778
|
+
zone: components["schemas"]["DnsZoneUpdatePayloadData"];
|
|
3779
|
+
};
|
|
3014
3780
|
/**
|
|
3015
3781
|
* DnssecAlgorithm
|
|
3016
3782
|
* @enum {integer}
|
|
@@ -3128,6 +3894,162 @@ export interface components {
|
|
|
3128
3894
|
/** @description The renewal mode of the domain */
|
|
3129
3895
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
3130
3896
|
};
|
|
3897
|
+
/** DomainCreateBulkCommand */
|
|
3898
|
+
DomainCreateBulkCommand: {
|
|
3899
|
+
/**
|
|
3900
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3901
|
+
* @enum {string}
|
|
3902
|
+
*/
|
|
3903
|
+
command: "domain_create_bulk";
|
|
3904
|
+
/**
|
|
3905
|
+
* Idempotency Key
|
|
3906
|
+
* @description Idempotency key for this bulk command
|
|
3907
|
+
*/
|
|
3908
|
+
idempotency_key?: string | null;
|
|
3909
|
+
/** @description Bulk domain creation payload */
|
|
3910
|
+
payload: components["schemas"]["DomainCreateBulkPayload"];
|
|
3911
|
+
/**
|
|
3912
|
+
* Version
|
|
3913
|
+
* @description Command version
|
|
3914
|
+
* @default v1
|
|
3915
|
+
*/
|
|
3916
|
+
version: string;
|
|
3917
|
+
};
|
|
3918
|
+
/** DomainCreateBulkInstance */
|
|
3919
|
+
DomainCreateBulkInstance: {
|
|
3920
|
+
/**
|
|
3921
|
+
* Auth Code
|
|
3922
|
+
* @description Override auth code for this domain
|
|
3923
|
+
*/
|
|
3924
|
+
auth_code?: string | null;
|
|
3925
|
+
/**
|
|
3926
|
+
* Contacts
|
|
3927
|
+
* @description Override contacts for this domain
|
|
3928
|
+
*/
|
|
3929
|
+
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
3930
|
+
/**
|
|
3931
|
+
* Create Zone
|
|
3932
|
+
* @description Override create_zone for this domain
|
|
3933
|
+
*/
|
|
3934
|
+
create_zone?: boolean | null;
|
|
3935
|
+
/**
|
|
3936
|
+
* Name
|
|
3937
|
+
* @description The domain to be created
|
|
3938
|
+
*/
|
|
3939
|
+
name: string;
|
|
3940
|
+
/**
|
|
3941
|
+
* Nameservers
|
|
3942
|
+
* @description Override nameservers for this domain
|
|
3943
|
+
*/
|
|
3944
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
3945
|
+
/** @description Override registration period for this domain */
|
|
3946
|
+
period?: components["schemas"]["DomainPeriod"] | null;
|
|
3947
|
+
/** @description Override renewal mode for this domain */
|
|
3948
|
+
renewal_mode?: components["schemas"]["RenewalMode"] | null;
|
|
3949
|
+
};
|
|
3950
|
+
/** DomainCreateBulkPayload */
|
|
3951
|
+
DomainCreateBulkPayload: {
|
|
3952
|
+
/**
|
|
3953
|
+
* Instances
|
|
3954
|
+
* @description List of domains to create (1-1000)
|
|
3955
|
+
*/
|
|
3956
|
+
instances: components["schemas"]["DomainCreateBulkInstance"][];
|
|
3957
|
+
/** @description Shared settings for all domains */
|
|
3958
|
+
template: components["schemas"]["DomainCreateBulkTemplate"];
|
|
3959
|
+
};
|
|
3960
|
+
/** DomainCreateBulkTemplate */
|
|
3961
|
+
DomainCreateBulkTemplate: {
|
|
3962
|
+
/**
|
|
3963
|
+
* Auth Code
|
|
3964
|
+
* @description The auth code used for the domain
|
|
3965
|
+
*/
|
|
3966
|
+
auth_code?: string | null;
|
|
3967
|
+
/**
|
|
3968
|
+
* Contacts
|
|
3969
|
+
* @description The contacts of the domain
|
|
3970
|
+
*/
|
|
3971
|
+
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
3972
|
+
/**
|
|
3973
|
+
* Create Zone
|
|
3974
|
+
* @description Create a zone on OpusDNS nameserver infrastructure
|
|
3975
|
+
* @default false
|
|
3976
|
+
*/
|
|
3977
|
+
create_zone: boolean;
|
|
3978
|
+
/**
|
|
3979
|
+
* Nameservers
|
|
3980
|
+
* @description The name servers for the domain
|
|
3981
|
+
*/
|
|
3982
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
3983
|
+
/** @description The registration period of the domain */
|
|
3984
|
+
period: components["schemas"]["DomainPeriod"];
|
|
3985
|
+
/** @description The renewal mode of the domain */
|
|
3986
|
+
renewal_mode: components["schemas"]["RenewalMode"];
|
|
3987
|
+
};
|
|
3988
|
+
/** DomainCreateCommand */
|
|
3989
|
+
DomainCreateCommand: {
|
|
3990
|
+
/**
|
|
3991
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3992
|
+
* @enum {string}
|
|
3993
|
+
*/
|
|
3994
|
+
command: "domain_create";
|
|
3995
|
+
/**
|
|
3996
|
+
* Idempotency Key
|
|
3997
|
+
* @description Idempotency key for this command
|
|
3998
|
+
*/
|
|
3999
|
+
idempotency_key?: string | null;
|
|
4000
|
+
/** @description Domain creation payload */
|
|
4001
|
+
payload: components["schemas"]["DomainCreatePayloadData"];
|
|
4002
|
+
/**
|
|
4003
|
+
* Version
|
|
4004
|
+
* @description Command version
|
|
4005
|
+
* @default v1
|
|
4006
|
+
*/
|
|
4007
|
+
version: string;
|
|
4008
|
+
};
|
|
4009
|
+
/** DomainCreatePayloadData */
|
|
4010
|
+
DomainCreatePayloadData: {
|
|
4011
|
+
/**
|
|
4012
|
+
* Auth Code
|
|
4013
|
+
* @description The auth code used for the domain
|
|
4014
|
+
*/
|
|
4015
|
+
auth_code?: string | null;
|
|
4016
|
+
/**
|
|
4017
|
+
* Contacts
|
|
4018
|
+
* @description The contacts of the domain
|
|
4019
|
+
*/
|
|
4020
|
+
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
4021
|
+
/**
|
|
4022
|
+
* Create Zone
|
|
4023
|
+
* @description Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
4024
|
+
* @default false
|
|
4025
|
+
*/
|
|
4026
|
+
create_zone: boolean;
|
|
4027
|
+
/**
|
|
4028
|
+
* Name
|
|
4029
|
+
* @description The domain to be created
|
|
4030
|
+
*/
|
|
4031
|
+
name: string;
|
|
4032
|
+
/**
|
|
4033
|
+
* Nameservers
|
|
4034
|
+
* @description The name servers for the domain
|
|
4035
|
+
*/
|
|
4036
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
4037
|
+
/** @description The registration period of the domain */
|
|
4038
|
+
period: components["schemas"]["DomainPeriod"];
|
|
4039
|
+
/** @description The renewal mode of the domain */
|
|
4040
|
+
renewal_mode: components["schemas"]["RenewalMode"];
|
|
4041
|
+
};
|
|
4042
|
+
/** DomainCreateWorkerPayload */
|
|
4043
|
+
DomainCreateWorkerPayload: {
|
|
4044
|
+
domain: components["schemas"]["DomainCreatePayloadData"];
|
|
4045
|
+
/** Operation */
|
|
4046
|
+
operation: string;
|
|
4047
|
+
/**
|
|
4048
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4049
|
+
* @enum {string}
|
|
4050
|
+
*/
|
|
4051
|
+
type: "domain_create" | "domain_create_bulk";
|
|
4052
|
+
};
|
|
3131
4053
|
/** DomainDnssecDataCreate */
|
|
3132
4054
|
DomainDnssecDataCreate: {
|
|
3133
4055
|
/** @description DNSSEC algorithm used */
|
|
@@ -3782,11 +4704,172 @@ export interface components {
|
|
|
3782
4704
|
*/
|
|
3783
4705
|
organization_id: TypeId<"organization">;
|
|
3784
4706
|
};
|
|
3785
|
-
/**
|
|
3786
|
-
|
|
4707
|
+
/** DomainTransferBulkCommand */
|
|
4708
|
+
DomainTransferBulkCommand: {
|
|
3787
4709
|
/**
|
|
3788
|
-
*
|
|
3789
|
-
* @
|
|
4710
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4711
|
+
* @enum {string}
|
|
4712
|
+
*/
|
|
4713
|
+
command: "domain_transfer_bulk";
|
|
4714
|
+
/**
|
|
4715
|
+
* Idempotency Key
|
|
4716
|
+
* @description Idempotency key for this bulk command
|
|
4717
|
+
*/
|
|
4718
|
+
idempotency_key?: string | null;
|
|
4719
|
+
/** @description Bulk domain transfer payload */
|
|
4720
|
+
payload: components["schemas"]["DomainTransferBulkPayload"];
|
|
4721
|
+
/**
|
|
4722
|
+
* Version
|
|
4723
|
+
* @description Command version
|
|
4724
|
+
* @default v1
|
|
4725
|
+
*/
|
|
4726
|
+
version: string;
|
|
4727
|
+
};
|
|
4728
|
+
/** DomainTransferBulkInstance */
|
|
4729
|
+
DomainTransferBulkInstance: {
|
|
4730
|
+
/**
|
|
4731
|
+
* Attributes
|
|
4732
|
+
* @description Override attributes for this domain
|
|
4733
|
+
*/
|
|
4734
|
+
attributes?: {
|
|
4735
|
+
[key: string]: string;
|
|
4736
|
+
} | null;
|
|
4737
|
+
/**
|
|
4738
|
+
* Auth Code
|
|
4739
|
+
* @description The auth code for this domain (required)
|
|
4740
|
+
*/
|
|
4741
|
+
auth_code: string;
|
|
4742
|
+
/**
|
|
4743
|
+
* Contacts
|
|
4744
|
+
* @description Override contacts for this domain
|
|
4745
|
+
*/
|
|
4746
|
+
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
4747
|
+
/**
|
|
4748
|
+
* Create Zone
|
|
4749
|
+
* @description Override create_zone for this domain
|
|
4750
|
+
*/
|
|
4751
|
+
create_zone?: boolean | null;
|
|
4752
|
+
/**
|
|
4753
|
+
* Name
|
|
4754
|
+
* @description The domain to transfer
|
|
4755
|
+
*/
|
|
4756
|
+
name: string;
|
|
4757
|
+
/**
|
|
4758
|
+
* Nameservers
|
|
4759
|
+
* @description Override nameservers for this domain
|
|
4760
|
+
*/
|
|
4761
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
4762
|
+
/** @description Override period for this domain */
|
|
4763
|
+
period?: components["schemas"]["DomainPeriod"] | null;
|
|
4764
|
+
/** @description Override renewal mode for this domain */
|
|
4765
|
+
renewal_mode?: components["schemas"]["RenewalMode"] | null;
|
|
4766
|
+
};
|
|
4767
|
+
/** DomainTransferBulkPayload */
|
|
4768
|
+
DomainTransferBulkPayload: {
|
|
4769
|
+
/**
|
|
4770
|
+
* Instances
|
|
4771
|
+
* @description List of domains to transfer (1-1000)
|
|
4772
|
+
*/
|
|
4773
|
+
instances: components["schemas"]["DomainTransferBulkInstance"][];
|
|
4774
|
+
/** @description Shared settings for all domains */
|
|
4775
|
+
template: components["schemas"]["DomainTransferBulkTemplate"];
|
|
4776
|
+
};
|
|
4777
|
+
/** DomainTransferBulkTemplate */
|
|
4778
|
+
DomainTransferBulkTemplate: {
|
|
4779
|
+
/**
|
|
4780
|
+
* Attributes
|
|
4781
|
+
* @description Additional attributes of the domain
|
|
4782
|
+
*/
|
|
4783
|
+
attributes?: {
|
|
4784
|
+
[key: string]: string;
|
|
4785
|
+
} | null;
|
|
4786
|
+
/**
|
|
4787
|
+
* Contacts
|
|
4788
|
+
* @description The contacts of the domain
|
|
4789
|
+
*/
|
|
4790
|
+
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
4791
|
+
/**
|
|
4792
|
+
* Create Zone
|
|
4793
|
+
* @description Create a zone on OpusDNS nameserver infrastructure
|
|
4794
|
+
* @default false
|
|
4795
|
+
*/
|
|
4796
|
+
create_zone: boolean;
|
|
4797
|
+
/**
|
|
4798
|
+
* Nameservers
|
|
4799
|
+
* @description The name servers for the domain
|
|
4800
|
+
*/
|
|
4801
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
4802
|
+
/** @description Additional registration period to add upon transfer completion */
|
|
4803
|
+
period?: components["schemas"]["DomainPeriod"] | null;
|
|
4804
|
+
/** @description The renewal mode of the domain */
|
|
4805
|
+
renewal_mode: components["schemas"]["RenewalMode"];
|
|
4806
|
+
};
|
|
4807
|
+
/** DomainTransferCommand */
|
|
4808
|
+
DomainTransferCommand: {
|
|
4809
|
+
/**
|
|
4810
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4811
|
+
* @enum {string}
|
|
4812
|
+
*/
|
|
4813
|
+
command: "domain_transfer";
|
|
4814
|
+
/**
|
|
4815
|
+
* Idempotency Key
|
|
4816
|
+
* @description Idempotency key for this command
|
|
4817
|
+
*/
|
|
4818
|
+
idempotency_key?: string | null;
|
|
4819
|
+
/** @description Domain transfer payload */
|
|
4820
|
+
payload: components["schemas"]["DomainTransferPayloadData"];
|
|
4821
|
+
/**
|
|
4822
|
+
* Version
|
|
4823
|
+
* @description Command version
|
|
4824
|
+
* @default v1
|
|
4825
|
+
*/
|
|
4826
|
+
version: string;
|
|
4827
|
+
};
|
|
4828
|
+
/** DomainTransferIn */
|
|
4829
|
+
DomainTransferIn: {
|
|
4830
|
+
/**
|
|
4831
|
+
* Attributes
|
|
4832
|
+
* @description Additional attributes of the domain
|
|
4833
|
+
*/
|
|
4834
|
+
attributes?: {
|
|
4835
|
+
[key: string]: string;
|
|
4836
|
+
} | null;
|
|
4837
|
+
/**
|
|
4838
|
+
* Auth Code
|
|
4839
|
+
* @description The auth code for the domain
|
|
4840
|
+
*/
|
|
4841
|
+
auth_code: string;
|
|
4842
|
+
/**
|
|
4843
|
+
* Contacts
|
|
4844
|
+
* @description The contacts of the domain
|
|
4845
|
+
*/
|
|
4846
|
+
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
4847
|
+
/**
|
|
4848
|
+
* Create Zone
|
|
4849
|
+
* @description Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
4850
|
+
* @default false
|
|
4851
|
+
*/
|
|
4852
|
+
create_zone: boolean;
|
|
4853
|
+
/**
|
|
4854
|
+
* Name
|
|
4855
|
+
* @description The domain to be created
|
|
4856
|
+
*/
|
|
4857
|
+
name: string;
|
|
4858
|
+
/**
|
|
4859
|
+
* Nameservers
|
|
4860
|
+
* @description The name servers for the domain
|
|
4861
|
+
*/
|
|
4862
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
4863
|
+
/** @description Additional registration period to add to the domain upon transfer completion. If omitted, the registry default policy will be applied. */
|
|
4864
|
+
period?: components["schemas"]["DomainPeriod"] | null;
|
|
4865
|
+
/** @description The renewal mode of the domain */
|
|
4866
|
+
renewal_mode: components["schemas"]["RenewalMode"];
|
|
4867
|
+
};
|
|
4868
|
+
/** DomainTransferPayloadData */
|
|
4869
|
+
DomainTransferPayloadData: {
|
|
4870
|
+
/**
|
|
4871
|
+
* Attributes
|
|
4872
|
+
* @description Additional attributes of the domain
|
|
3790
4873
|
*/
|
|
3791
4874
|
attributes?: {
|
|
3792
4875
|
[key: string]: string;
|
|
@@ -3822,6 +4905,17 @@ export interface components {
|
|
|
3822
4905
|
/** @description The renewal mode of the domain */
|
|
3823
4906
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
3824
4907
|
};
|
|
4908
|
+
/** DomainTransferWorkerPayload */
|
|
4909
|
+
DomainTransferWorkerPayload: {
|
|
4910
|
+
domain: components["schemas"]["DomainTransferPayloadData"];
|
|
4911
|
+
/** Operation */
|
|
4912
|
+
operation: string;
|
|
4913
|
+
/**
|
|
4914
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4915
|
+
* @enum {string}
|
|
4916
|
+
*/
|
|
4917
|
+
type: "domain_transfer" | "domain_transfer_bulk";
|
|
4918
|
+
};
|
|
3825
4919
|
/** DomainTransitRequest */
|
|
3826
4920
|
DomainTransitRequest: {
|
|
3827
4921
|
/**
|
|
@@ -3876,6 +4970,166 @@ export interface components {
|
|
|
3876
4970
|
*/
|
|
3877
4971
|
statuses?: components["schemas"]["DomainClientStatus"][] | null;
|
|
3878
4972
|
};
|
|
4973
|
+
/** DomainUpdateBulkCommand */
|
|
4974
|
+
DomainUpdateBulkCommand: {
|
|
4975
|
+
/**
|
|
4976
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4977
|
+
* @enum {string}
|
|
4978
|
+
*/
|
|
4979
|
+
command: "domain_update_bulk";
|
|
4980
|
+
/**
|
|
4981
|
+
* Idempotency Key
|
|
4982
|
+
* @description Idempotency key for this bulk command
|
|
4983
|
+
*/
|
|
4984
|
+
idempotency_key?: string | null;
|
|
4985
|
+
/** @description Bulk domain update payload */
|
|
4986
|
+
payload: components["schemas"]["DomainUpdateBulkPayload"];
|
|
4987
|
+
/**
|
|
4988
|
+
* Version
|
|
4989
|
+
* @description Command version
|
|
4990
|
+
* @default v1
|
|
4991
|
+
*/
|
|
4992
|
+
version: string;
|
|
4993
|
+
};
|
|
4994
|
+
/** DomainUpdateBulkInstance */
|
|
4995
|
+
DomainUpdateBulkInstance: {
|
|
4996
|
+
/**
|
|
4997
|
+
* Auth Code
|
|
4998
|
+
* @description Override auth code for this domain
|
|
4999
|
+
*/
|
|
5000
|
+
auth_code?: string | null;
|
|
5001
|
+
/**
|
|
5002
|
+
* Contacts
|
|
5003
|
+
* @description Override contacts for this domain
|
|
5004
|
+
*/
|
|
5005
|
+
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
5006
|
+
/**
|
|
5007
|
+
* Domain Id
|
|
5008
|
+
* @description The domain ID to update
|
|
5009
|
+
*/
|
|
5010
|
+
domain_id?: string | null;
|
|
5011
|
+
/**
|
|
5012
|
+
* Name
|
|
5013
|
+
* @description The domain name to update
|
|
5014
|
+
*/
|
|
5015
|
+
name?: string | null;
|
|
5016
|
+
/**
|
|
5017
|
+
* Nameservers
|
|
5018
|
+
* @description Override nameservers for this domain
|
|
5019
|
+
*/
|
|
5020
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
5021
|
+
/** @description Override renewal mode for this domain */
|
|
5022
|
+
renewal_mode?: components["schemas"]["RenewalMode"] | null;
|
|
5023
|
+
/** @description Override status changes for this domain */
|
|
5024
|
+
status_changes?: components["schemas"]["StatusChanges"] | null;
|
|
5025
|
+
/**
|
|
5026
|
+
* Statuses
|
|
5027
|
+
* @description Override statuses for this domain
|
|
5028
|
+
*/
|
|
5029
|
+
statuses?: components["schemas"]["DomainClientStatus"][] | null;
|
|
5030
|
+
};
|
|
5031
|
+
/** DomainUpdateBulkPayload */
|
|
5032
|
+
DomainUpdateBulkPayload: {
|
|
5033
|
+
/**
|
|
5034
|
+
* Instances
|
|
5035
|
+
* @description List of domains to update (1-1000)
|
|
5036
|
+
*/
|
|
5037
|
+
instances: components["schemas"]["DomainUpdateBulkInstance"][];
|
|
5038
|
+
/** @description Shared settings for all domain updates */
|
|
5039
|
+
template: components["schemas"]["DomainUpdateBulkTemplate"];
|
|
5040
|
+
};
|
|
5041
|
+
/** DomainUpdateBulkTemplate */
|
|
5042
|
+
DomainUpdateBulkTemplate: {
|
|
5043
|
+
/**
|
|
5044
|
+
* Contacts
|
|
5045
|
+
* @description The new contacts of the domain
|
|
5046
|
+
*/
|
|
5047
|
+
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
5048
|
+
/**
|
|
5049
|
+
* Nameservers
|
|
5050
|
+
* @description The new name servers for the domain
|
|
5051
|
+
*/
|
|
5052
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
5053
|
+
/** @description The new renewal mode of the domain */
|
|
5054
|
+
renewal_mode?: components["schemas"]["RenewalMode"] | null;
|
|
5055
|
+
/** @description Statuses to add or remove relative to current state */
|
|
5056
|
+
status_changes?: components["schemas"]["StatusChanges"] | null;
|
|
5057
|
+
/**
|
|
5058
|
+
* Statuses
|
|
5059
|
+
* @description The new statuses of the domain
|
|
5060
|
+
*/
|
|
5061
|
+
statuses?: components["schemas"]["DomainClientStatus"][] | null;
|
|
5062
|
+
};
|
|
5063
|
+
/** DomainUpdateCommand */
|
|
5064
|
+
DomainUpdateCommand: {
|
|
5065
|
+
/**
|
|
5066
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5067
|
+
* @enum {string}
|
|
5068
|
+
*/
|
|
5069
|
+
command: "domain_update";
|
|
5070
|
+
/**
|
|
5071
|
+
* Idempotency Key
|
|
5072
|
+
* @description Idempotency key for this command
|
|
5073
|
+
*/
|
|
5074
|
+
idempotency_key?: string | null;
|
|
5075
|
+
/** @description Domain update payload */
|
|
5076
|
+
payload: components["schemas"]["DomainUpdatePayloadData"];
|
|
5077
|
+
/**
|
|
5078
|
+
* Version
|
|
5079
|
+
* @description Command version
|
|
5080
|
+
* @default v1
|
|
5081
|
+
*/
|
|
5082
|
+
version: string;
|
|
5083
|
+
};
|
|
5084
|
+
/** DomainUpdatePayloadData */
|
|
5085
|
+
DomainUpdatePayloadData: {
|
|
5086
|
+
/**
|
|
5087
|
+
* Auth Code
|
|
5088
|
+
* @description The new auth code for the domain
|
|
5089
|
+
*/
|
|
5090
|
+
auth_code?: string | null;
|
|
5091
|
+
/**
|
|
5092
|
+
* Contacts
|
|
5093
|
+
* @description The new contacts of the domain
|
|
5094
|
+
* @example {
|
|
5095
|
+
* "admin": "contact_01h45ytscbebyvny4gc8cr8ma2",
|
|
5096
|
+
* "billing": "contact_01h45ytscbebyvny4gc8cr8ma2",
|
|
5097
|
+
* "registrant": "contact_01h45ytscbebyvny4gc8cr8ma2",
|
|
5098
|
+
* "tech": "contact_01h45ytscbebyvny4gc8cr8ma2"
|
|
5099
|
+
* }
|
|
5100
|
+
*/
|
|
5101
|
+
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
5102
|
+
/**
|
|
5103
|
+
* Domain Id
|
|
5104
|
+
* @description Domain ID to update
|
|
5105
|
+
*/
|
|
5106
|
+
domain_id: string;
|
|
5107
|
+
/**
|
|
5108
|
+
* Nameservers
|
|
5109
|
+
* @description The new name servers for the domain
|
|
5110
|
+
*/
|
|
5111
|
+
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
5112
|
+
/** @description The new renewal mode of the domain */
|
|
5113
|
+
renewal_mode?: components["schemas"]["RenewalMode"] | null;
|
|
5114
|
+
/** @description Statuses to add or remove relative to current state */
|
|
5115
|
+
status_changes?: components["schemas"]["StatusChanges"] | null;
|
|
5116
|
+
/**
|
|
5117
|
+
* Statuses
|
|
5118
|
+
* @description The new statuses of the domain
|
|
5119
|
+
*/
|
|
5120
|
+
statuses?: components["schemas"]["DomainClientStatus"][] | null;
|
|
5121
|
+
};
|
|
5122
|
+
/** DomainUpdateWorkerPayload */
|
|
5123
|
+
DomainUpdateWorkerPayload: {
|
|
5124
|
+
domain: components["schemas"]["DomainUpdatePayloadData"];
|
|
5125
|
+
/** Operation */
|
|
5126
|
+
operation: string;
|
|
5127
|
+
/**
|
|
5128
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5129
|
+
* @enum {string}
|
|
5130
|
+
*/
|
|
5131
|
+
type: "domain_update" | "domain_update_bulk";
|
|
5132
|
+
};
|
|
3879
5133
|
/** DomainWithdrawRequest */
|
|
3880
5134
|
DomainWithdrawRequest: {
|
|
3881
5135
|
/**
|
|
@@ -4679,37 +5933,286 @@ export interface components {
|
|
|
4679
5933
|
*/
|
|
4680
5934
|
last_used_on?: Date | null;
|
|
4681
5935
|
};
|
|
4682
|
-
|
|
4683
|
-
|
|
4684
|
-
LaunchPhaseBase: {
|
|
4685
|
-
/** @description Allocation method */
|
|
4686
|
-
allocation?: components["schemas"]["AllocationMethodType"] | null;
|
|
5936
|
+
/** JobBatchMetadataResponse */
|
|
5937
|
+
JobBatchMetadataResponse: {
|
|
4687
5938
|
/**
|
|
4688
|
-
*
|
|
4689
|
-
*
|
|
5939
|
+
* Batch Id
|
|
5940
|
+
* Format: typeid
|
|
5941
|
+
* @description TypeID identifying this batch
|
|
5942
|
+
* @example batch_01h45ytscbebyvny4gc8cr8ma2
|
|
4690
5943
|
*/
|
|
4691
|
-
|
|
5944
|
+
batch_id: TypeId<"batch">;
|
|
4692
5945
|
/**
|
|
4693
|
-
*
|
|
4694
|
-
*
|
|
5946
|
+
* Created On
|
|
5947
|
+
* Format: date-time
|
|
5948
|
+
* @description Timestamp when the batch was created (UTC)
|
|
4695
5949
|
*/
|
|
4696
|
-
|
|
5950
|
+
created_on: Date;
|
|
4697
5951
|
/**
|
|
4698
|
-
*
|
|
4699
|
-
* @description
|
|
5952
|
+
* Finished At
|
|
5953
|
+
* @description Timestamp when the last job finished (UTC)
|
|
4700
5954
|
*/
|
|
4701
|
-
|
|
5955
|
+
finished_at?: Date | null;
|
|
5956
|
+
/** @description Number of jobs in each status */
|
|
5957
|
+
job_counts: components["schemas"]["JobCountsByStatus"];
|
|
4702
5958
|
/**
|
|
4703
|
-
*
|
|
4704
|
-
* @description
|
|
5959
|
+
* Label
|
|
5960
|
+
* @description Human-readable label for this batch
|
|
4705
5961
|
*/
|
|
4706
|
-
|
|
4707
|
-
/**
|
|
4708
|
-
|
|
5962
|
+
label?: string | null;
|
|
5963
|
+
/**
|
|
5964
|
+
* Started At
|
|
5965
|
+
* @description Timestamp when the first job started (UTC)
|
|
5966
|
+
*/
|
|
5967
|
+
started_at?: Date | null;
|
|
5968
|
+
/** @description Batch status: pending (jobs still processing) or complete (all done) */
|
|
5969
|
+
status: components["schemas"]["BatchStatus"];
|
|
5970
|
+
/**
|
|
5971
|
+
* Total Jobs
|
|
5972
|
+
* @description Total number of jobs in this batch
|
|
5973
|
+
*/
|
|
5974
|
+
total_jobs: number;
|
|
4709
5975
|
};
|
|
4710
|
-
/**
|
|
4711
|
-
|
|
4712
|
-
|
|
5976
|
+
/** JobBatchRequest */
|
|
5977
|
+
JobBatchRequest: {
|
|
5978
|
+
/**
|
|
5979
|
+
* Commands
|
|
5980
|
+
* @description List of commands to execute
|
|
5981
|
+
*/
|
|
5982
|
+
commands: (components["schemas"]["DomainCreateCommand"] | components["schemas"]["DomainUpdateCommand"] | components["schemas"]["DomainTransferCommand"] | components["schemas"]["DnsZoneCreateCommand"] | components["schemas"]["DnsZoneUpdateCommand"] | components["schemas"]["DomainCreateBulkCommand"] | components["schemas"]["DomainTransferBulkCommand"] | components["schemas"]["DomainUpdateBulkCommand"] | components["schemas"]["DnsZoneCreateBulkCommand"] | components["schemas"]["DnsZoneUpdateBulkCommand"] | components["schemas"]["DnsZonePatchRrsetsBulkCommand"] | components["schemas"]["DnsZonePatchRecordsBulkCommand"] | components["schemas"]["ContactCreateBulkCommand"] | components["schemas"]["ContactCreateCommand"] | components["schemas"]["ParkingCreateBulkCommand"] | components["schemas"]["ParkingEnableBulkCommand"] | components["schemas"]["ParkingDisableBulkCommand"] | components["schemas"]["ParkingDeleteBulkCommand"])[];
|
|
5983
|
+
/**
|
|
5984
|
+
* Label
|
|
5985
|
+
* @description Human-readable label for this batch
|
|
5986
|
+
*/
|
|
5987
|
+
label?: string | null;
|
|
5988
|
+
/**
|
|
5989
|
+
* Not Before
|
|
5990
|
+
* @description Earliest time jobs can execute (UTC). If not provided, jobs run immediately.
|
|
5991
|
+
*/
|
|
5992
|
+
not_before?: Date | null;
|
|
5993
|
+
/**
|
|
5994
|
+
* Paused
|
|
5995
|
+
* @description If true, jobs are created in paused state and must be explicitly resumed
|
|
5996
|
+
* @default false
|
|
5997
|
+
*/
|
|
5998
|
+
paused: boolean;
|
|
5999
|
+
};
|
|
6000
|
+
/** JobBatchStatusResponse */
|
|
6001
|
+
JobBatchStatusResponse: {
|
|
6002
|
+
/**
|
|
6003
|
+
* Batch Id
|
|
6004
|
+
* Format: typeid
|
|
6005
|
+
* @description TypeID identifying this batch. All jobs in a batch share the same batch_id, while each job has its own unique job_id.
|
|
6006
|
+
* @example batch_01h45ytscbebyvny4gc8cr8ma2
|
|
6007
|
+
*/
|
|
6008
|
+
batch_id: TypeId<"batch">;
|
|
6009
|
+
/**
|
|
6010
|
+
* Blocked
|
|
6011
|
+
* @description Number of jobs waiting for eligibility (scheduled, serial blocked, or no tokens)
|
|
6012
|
+
* @default 0
|
|
6013
|
+
*/
|
|
6014
|
+
blocked: number;
|
|
6015
|
+
/**
|
|
6016
|
+
* Canceled
|
|
6017
|
+
* @description Number of jobs that were canceled
|
|
6018
|
+
*/
|
|
6019
|
+
canceled: number;
|
|
6020
|
+
/**
|
|
6021
|
+
* Dead Letter
|
|
6022
|
+
* @description Number of jobs that permanently failed after exhausting retries
|
|
6023
|
+
*/
|
|
6024
|
+
dead_letter: number;
|
|
6025
|
+
/**
|
|
6026
|
+
* Failed
|
|
6027
|
+
* @description Number of jobs that failed execution
|
|
6028
|
+
*/
|
|
6029
|
+
failed: number;
|
|
6030
|
+
/**
|
|
6031
|
+
* Paused
|
|
6032
|
+
* @description Number of jobs in paused state
|
|
6033
|
+
* @default 0
|
|
6034
|
+
*/
|
|
6035
|
+
paused: number;
|
|
6036
|
+
/**
|
|
6037
|
+
* Progress Percentage
|
|
6038
|
+
* @description Completion percentage (0-100)
|
|
6039
|
+
*/
|
|
6040
|
+
progress_percentage: number;
|
|
6041
|
+
/**
|
|
6042
|
+
* Queued
|
|
6043
|
+
* @description Number of jobs awaiting processing
|
|
6044
|
+
*/
|
|
6045
|
+
queued: number;
|
|
6046
|
+
/**
|
|
6047
|
+
* Running
|
|
6048
|
+
* @description Number of jobs currently being executed
|
|
6049
|
+
*/
|
|
6050
|
+
running: number;
|
|
6051
|
+
/**
|
|
6052
|
+
* Succeeded
|
|
6053
|
+
* @description Number of jobs that completed successfully
|
|
6054
|
+
*/
|
|
6055
|
+
succeeded: number;
|
|
6056
|
+
/**
|
|
6057
|
+
* Total
|
|
6058
|
+
* @description Total number of jobs in the batch
|
|
6059
|
+
*/
|
|
6060
|
+
total: number;
|
|
6061
|
+
};
|
|
6062
|
+
/** JobCountsByStatus */
|
|
6063
|
+
JobCountsByStatus: {
|
|
6064
|
+
/**
|
|
6065
|
+
* Blocked
|
|
6066
|
+
* @default 0
|
|
6067
|
+
*/
|
|
6068
|
+
blocked: number;
|
|
6069
|
+
/**
|
|
6070
|
+
* Canceled
|
|
6071
|
+
* @default 0
|
|
6072
|
+
*/
|
|
6073
|
+
canceled: number;
|
|
6074
|
+
/**
|
|
6075
|
+
* Dead Letter
|
|
6076
|
+
* @default 0
|
|
6077
|
+
*/
|
|
6078
|
+
dead_letter: number;
|
|
6079
|
+
/**
|
|
6080
|
+
* Failed
|
|
6081
|
+
* @default 0
|
|
6082
|
+
*/
|
|
6083
|
+
failed: number;
|
|
6084
|
+
/**
|
|
6085
|
+
* Paused
|
|
6086
|
+
* @default 0
|
|
6087
|
+
*/
|
|
6088
|
+
paused: number;
|
|
6089
|
+
/**
|
|
6090
|
+
* Queued
|
|
6091
|
+
* @default 0
|
|
6092
|
+
*/
|
|
6093
|
+
queued: number;
|
|
6094
|
+
/**
|
|
6095
|
+
* Running
|
|
6096
|
+
* @default 0
|
|
6097
|
+
*/
|
|
6098
|
+
running: number;
|
|
6099
|
+
/**
|
|
6100
|
+
* Succeeded
|
|
6101
|
+
* @default 0
|
|
6102
|
+
*/
|
|
6103
|
+
succeeded: number;
|
|
6104
|
+
};
|
|
6105
|
+
/** JobResponse */
|
|
6106
|
+
JobResponse: {
|
|
6107
|
+
/**
|
|
6108
|
+
* Attempts
|
|
6109
|
+
* @description Number of execution attempts made for this job
|
|
6110
|
+
*/
|
|
6111
|
+
attempts: number;
|
|
6112
|
+
/**
|
|
6113
|
+
* Command
|
|
6114
|
+
* @description Command name (e.g., 'domain_create', 'dns_zone_update')
|
|
6115
|
+
*/
|
|
6116
|
+
command?: string | null;
|
|
6117
|
+
/**
|
|
6118
|
+
* Created On
|
|
6119
|
+
* Format: date-time
|
|
6120
|
+
* @description Timestamp when the job was created (UTC)
|
|
6121
|
+
*/
|
|
6122
|
+
created_on: Date;
|
|
6123
|
+
/**
|
|
6124
|
+
* Display
|
|
6125
|
+
* @description Human-readable description of this job
|
|
6126
|
+
*/
|
|
6127
|
+
display?: string | null;
|
|
6128
|
+
/**
|
|
6129
|
+
* Error Class
|
|
6130
|
+
* @description Error type if the job failed (e.g., ValidationError, TimeoutError)
|
|
6131
|
+
*/
|
|
6132
|
+
error_class?: string | null;
|
|
6133
|
+
/**
|
|
6134
|
+
* Error Message
|
|
6135
|
+
* @description Detailed error message if the job failed
|
|
6136
|
+
*/
|
|
6137
|
+
error_message?: string | null;
|
|
6138
|
+
/**
|
|
6139
|
+
* Finished At
|
|
6140
|
+
* @description Timestamp when job execution completed (UTC)
|
|
6141
|
+
*/
|
|
6142
|
+
finished_at?: Date | null;
|
|
6143
|
+
/**
|
|
6144
|
+
* Job Id
|
|
6145
|
+
* Format: typeid
|
|
6146
|
+
* @description Unique identifier for this individual job
|
|
6147
|
+
* @example job_01h45ytscbebyvny4gc8cr8ma2
|
|
6148
|
+
*/
|
|
6149
|
+
job_id: TypeId<"job">;
|
|
6150
|
+
/**
|
|
6151
|
+
* Operation
|
|
6152
|
+
* @description Operation type (e.g., 'create', 'update', 'transfer')
|
|
6153
|
+
*/
|
|
6154
|
+
operation?: string | null;
|
|
6155
|
+
/**
|
|
6156
|
+
* Paused At
|
|
6157
|
+
* @description Timestamp when job was paused (UTC)
|
|
6158
|
+
*/
|
|
6159
|
+
paused_at?: Date | null;
|
|
6160
|
+
/**
|
|
6161
|
+
* Payload
|
|
6162
|
+
* @description The original request payload for this job
|
|
6163
|
+
*/
|
|
6164
|
+
payload?: (components["schemas"]["DomainCreateWorkerPayload"] | components["schemas"]["DomainUpdateWorkerPayload"] | components["schemas"]["DomainTransferWorkerPayload"] | components["schemas"]["DnsZoneCreateWorkerPayload"] | components["schemas"]["DnsZoneUpdateWorkerPayload"] | components["schemas"]["DnsZonePatchRrsetsWorkerPayload"] | components["schemas"]["DnsZonePatchRecordsWorkerPayload"] | components["schemas"]["ContactCreateWorkerPayload"] | components["schemas"]["ParkingCreateWorkerPayload"] | components["schemas"]["ParkingEnableWorkerPayload"] | components["schemas"]["ParkingDisableWorkerPayload"] | components["schemas"]["ParkingDeleteWorkerPayload"]) | {
|
|
6165
|
+
[key: string]: unknown;
|
|
6166
|
+
} | null;
|
|
6167
|
+
/**
|
|
6168
|
+
* Resource Key
|
|
6169
|
+
* @description Resource identifier for this job
|
|
6170
|
+
*/
|
|
6171
|
+
resource_key?: string | null;
|
|
6172
|
+
/**
|
|
6173
|
+
* Started At
|
|
6174
|
+
* @description Timestamp when job execution began (UTC)
|
|
6175
|
+
*/
|
|
6176
|
+
started_at?: Date | null;
|
|
6177
|
+
/** @description Current job status: queued, running, succeeded, failed, canceled, or dead_letter */
|
|
6178
|
+
status: components["schemas"]["JobStatus"];
|
|
6179
|
+
};
|
|
6180
|
+
/**
|
|
6181
|
+
* JobStatus
|
|
6182
|
+
* @enum {string}
|
|
6183
|
+
*/
|
|
6184
|
+
JobStatus: "blocked" | "queued" | "paused" | "running" | "succeeded" | "failed" | "canceled" | "dead_letter";
|
|
6185
|
+
JsonValue: unknown;
|
|
6186
|
+
/** LaunchPhaseBase */
|
|
6187
|
+
LaunchPhaseBase: {
|
|
6188
|
+
/** @description Allocation method */
|
|
6189
|
+
allocation?: components["schemas"]["AllocationMethodType"] | null;
|
|
6190
|
+
/**
|
|
6191
|
+
* End Date
|
|
6192
|
+
* @description End date of the phase
|
|
6193
|
+
*/
|
|
6194
|
+
end_date?: Date | null;
|
|
6195
|
+
/**
|
|
6196
|
+
* Smd Required
|
|
6197
|
+
* @description Whether an SMD file is required for participation
|
|
6198
|
+
*/
|
|
6199
|
+
smd_required?: boolean | null;
|
|
6200
|
+
/**
|
|
6201
|
+
* Start Date
|
|
6202
|
+
* @description Start date of the phase
|
|
6203
|
+
*/
|
|
6204
|
+
start_date?: Date | null;
|
|
6205
|
+
/**
|
|
6206
|
+
* Supported
|
|
6207
|
+
* @description Whether this phase is supported
|
|
6208
|
+
*/
|
|
6209
|
+
supported: boolean;
|
|
6210
|
+
/** @description Type of launch phase */
|
|
6211
|
+
type: components["schemas"]["LaunchPhaseType"];
|
|
6212
|
+
};
|
|
6213
|
+
/**
|
|
6214
|
+
* LaunchPhaseType
|
|
6215
|
+
* @enum {string}
|
|
4713
6216
|
*/
|
|
4714
6217
|
LaunchPhaseType: "sunrise" | "landrush" | "eap";
|
|
4715
6218
|
/** LaunchPhasesBase */
|
|
@@ -5429,6 +6932,18 @@ export interface components {
|
|
|
5429
6932
|
/** Results */
|
|
5430
6933
|
results: components["schemas"]["InvoiceResponse"][];
|
|
5431
6934
|
};
|
|
6935
|
+
/** Pagination[JobBatchMetadataResponse] */
|
|
6936
|
+
Pagination_JobBatchMetadataResponse_: {
|
|
6937
|
+
pagination: components["schemas"]["PaginationMetadata"];
|
|
6938
|
+
/** Results */
|
|
6939
|
+
results: components["schemas"]["JobBatchMetadataResponse"][];
|
|
6940
|
+
};
|
|
6941
|
+
/** Pagination[JobResponse] */
|
|
6942
|
+
Pagination_JobResponse_: {
|
|
6943
|
+
pagination: components["schemas"]["PaginationMetadata"];
|
|
6944
|
+
/** Results */
|
|
6945
|
+
results: components["schemas"]["JobResponse"][];
|
|
6946
|
+
};
|
|
5432
6947
|
/** Pagination[ObjectLog] */
|
|
5433
6948
|
Pagination_ObjectLog_: {
|
|
5434
6949
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -5459,6 +6974,11 @@ export interface components {
|
|
|
5459
6974
|
/** Results */
|
|
5460
6975
|
results: components["schemas"]["UserPublic"][];
|
|
5461
6976
|
};
|
|
6977
|
+
/** ParkingActionPayloadData */
|
|
6978
|
+
ParkingActionPayloadData: {
|
|
6979
|
+
/** Parking Id */
|
|
6980
|
+
parking_id: string;
|
|
6981
|
+
};
|
|
5462
6982
|
/**
|
|
5463
6983
|
* ParkingAgreementAcceptance
|
|
5464
6984
|
* @description Parking agreement acceptance details.
|
|
@@ -5481,6 +7001,230 @@ export interface components {
|
|
|
5481
7001
|
*/
|
|
5482
7002
|
version: string;
|
|
5483
7003
|
};
|
|
7004
|
+
/** ParkingCreateBulkCommand */
|
|
7005
|
+
ParkingCreateBulkCommand: {
|
|
7006
|
+
/**
|
|
7007
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7008
|
+
* @enum {string}
|
|
7009
|
+
*/
|
|
7010
|
+
command: "parking_create_bulk";
|
|
7011
|
+
/**
|
|
7012
|
+
* Idempotency Key
|
|
7013
|
+
* @description Idempotency key for this bulk command
|
|
7014
|
+
*/
|
|
7015
|
+
idempotency_key?: string | null;
|
|
7016
|
+
/** @description Bulk parking creation payload */
|
|
7017
|
+
payload: components["schemas"]["ParkingCreateBulkPayload"];
|
|
7018
|
+
/**
|
|
7019
|
+
* Version
|
|
7020
|
+
* @description Command version
|
|
7021
|
+
* @default v1
|
|
7022
|
+
*/
|
|
7023
|
+
version: string;
|
|
7024
|
+
};
|
|
7025
|
+
/** ParkingCreateBulkInstance */
|
|
7026
|
+
ParkingCreateBulkInstance: {
|
|
7027
|
+
/**
|
|
7028
|
+
* Domain
|
|
7029
|
+
* @description The domain name for the parking ad
|
|
7030
|
+
*/
|
|
7031
|
+
domain: string;
|
|
7032
|
+
/**
|
|
7033
|
+
* Enabled
|
|
7034
|
+
* @description Override enabled setting for this domain
|
|
7035
|
+
*/
|
|
7036
|
+
enabled?: boolean | null;
|
|
7037
|
+
};
|
|
7038
|
+
/** ParkingCreateBulkPayload */
|
|
7039
|
+
ParkingCreateBulkPayload: {
|
|
7040
|
+
/**
|
|
7041
|
+
* Instances
|
|
7042
|
+
* @description List of parking entries to create (1-1000)
|
|
7043
|
+
*/
|
|
7044
|
+
instances: components["schemas"]["ParkingCreateBulkInstance"][];
|
|
7045
|
+
/** @description Shared settings for all parking entries */
|
|
7046
|
+
template: components["schemas"]["ParkingCreateBulkTemplate"];
|
|
7047
|
+
};
|
|
7048
|
+
/** ParkingCreateBulkTemplate */
|
|
7049
|
+
ParkingCreateBulkTemplate: {
|
|
7050
|
+
/**
|
|
7051
|
+
* Enabled
|
|
7052
|
+
* @description Whether to enable parking immediately after creation
|
|
7053
|
+
* @default false
|
|
7054
|
+
*/
|
|
7055
|
+
enabled: boolean;
|
|
7056
|
+
};
|
|
7057
|
+
/** ParkingCreatePayloadData */
|
|
7058
|
+
ParkingCreatePayloadData: {
|
|
7059
|
+
/** Domain */
|
|
7060
|
+
domain: string;
|
|
7061
|
+
/**
|
|
7062
|
+
* Enabled
|
|
7063
|
+
* @default false
|
|
7064
|
+
*/
|
|
7065
|
+
enabled: boolean;
|
|
7066
|
+
};
|
|
7067
|
+
/** ParkingCreateWorkerPayload */
|
|
7068
|
+
ParkingCreateWorkerPayload: {
|
|
7069
|
+
/** Operation */
|
|
7070
|
+
operation: string;
|
|
7071
|
+
parking: components["schemas"]["ParkingCreatePayloadData"];
|
|
7072
|
+
/**
|
|
7073
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7074
|
+
* @enum {string}
|
|
7075
|
+
*/
|
|
7076
|
+
type: "parking_create_bulk";
|
|
7077
|
+
};
|
|
7078
|
+
/** ParkingDeleteBulkCommand */
|
|
7079
|
+
ParkingDeleteBulkCommand: {
|
|
7080
|
+
/**
|
|
7081
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7082
|
+
* @enum {string}
|
|
7083
|
+
*/
|
|
7084
|
+
command: "parking_delete_bulk";
|
|
7085
|
+
/**
|
|
7086
|
+
* Idempotency Key
|
|
7087
|
+
* @description Idempotency key for this bulk command
|
|
7088
|
+
*/
|
|
7089
|
+
idempotency_key?: string | null;
|
|
7090
|
+
/** @description Bulk parking delete payload */
|
|
7091
|
+
payload: components["schemas"]["ParkingDeleteBulkPayload"];
|
|
7092
|
+
/**
|
|
7093
|
+
* Version
|
|
7094
|
+
* @description Command version
|
|
7095
|
+
* @default v1
|
|
7096
|
+
*/
|
|
7097
|
+
version: string;
|
|
7098
|
+
};
|
|
7099
|
+
/** ParkingDeleteBulkInstance */
|
|
7100
|
+
ParkingDeleteBulkInstance: {
|
|
7101
|
+
/**
|
|
7102
|
+
* Parking Id
|
|
7103
|
+
* Format: typeid
|
|
7104
|
+
* @description The parking ID of the entry to delete
|
|
7105
|
+
* @example parking_01h45ytscbebyvny4gc8cr8ma2
|
|
7106
|
+
*/
|
|
7107
|
+
parking_id: TypeId<"parking">;
|
|
7108
|
+
};
|
|
7109
|
+
/** ParkingDeleteBulkPayload */
|
|
7110
|
+
ParkingDeleteBulkPayload: {
|
|
7111
|
+
/**
|
|
7112
|
+
* Instances
|
|
7113
|
+
* @description List of parking entries to delete (1-1000)
|
|
7114
|
+
*/
|
|
7115
|
+
instances: components["schemas"]["ParkingDeleteBulkInstance"][];
|
|
7116
|
+
};
|
|
7117
|
+
/** ParkingDeleteWorkerPayload */
|
|
7118
|
+
ParkingDeleteWorkerPayload: {
|
|
7119
|
+
/** Operation */
|
|
7120
|
+
operation: string;
|
|
7121
|
+
parking: components["schemas"]["ParkingActionPayloadData"];
|
|
7122
|
+
/**
|
|
7123
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7124
|
+
* @enum {string}
|
|
7125
|
+
*/
|
|
7126
|
+
type: "parking_delete_bulk";
|
|
7127
|
+
};
|
|
7128
|
+
/** ParkingDisableBulkCommand */
|
|
7129
|
+
ParkingDisableBulkCommand: {
|
|
7130
|
+
/**
|
|
7131
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7132
|
+
* @enum {string}
|
|
7133
|
+
*/
|
|
7134
|
+
command: "parking_disable_bulk";
|
|
7135
|
+
/**
|
|
7136
|
+
* Idempotency Key
|
|
7137
|
+
* @description Idempotency key for this bulk command
|
|
7138
|
+
*/
|
|
7139
|
+
idempotency_key?: string | null;
|
|
7140
|
+
/** @description Bulk parking disable payload */
|
|
7141
|
+
payload: components["schemas"]["ParkingDisableBulkPayload"];
|
|
7142
|
+
/**
|
|
7143
|
+
* Version
|
|
7144
|
+
* @description Command version
|
|
7145
|
+
* @default v1
|
|
7146
|
+
*/
|
|
7147
|
+
version: string;
|
|
7148
|
+
};
|
|
7149
|
+
/** ParkingDisableBulkInstance */
|
|
7150
|
+
ParkingDisableBulkInstance: {
|
|
7151
|
+
/**
|
|
7152
|
+
* Parking Id
|
|
7153
|
+
* Format: typeid
|
|
7154
|
+
* @description The parking ID of the entry to disable
|
|
7155
|
+
* @example parking_01h45ytscbebyvny4gc8cr8ma2
|
|
7156
|
+
*/
|
|
7157
|
+
parking_id: TypeId<"parking">;
|
|
7158
|
+
};
|
|
7159
|
+
/** ParkingDisableBulkPayload */
|
|
7160
|
+
ParkingDisableBulkPayload: {
|
|
7161
|
+
/**
|
|
7162
|
+
* Instances
|
|
7163
|
+
* @description List of parking entries to disable (1-1000)
|
|
7164
|
+
*/
|
|
7165
|
+
instances: components["schemas"]["ParkingDisableBulkInstance"][];
|
|
7166
|
+
};
|
|
7167
|
+
/** ParkingDisableWorkerPayload */
|
|
7168
|
+
ParkingDisableWorkerPayload: {
|
|
7169
|
+
/** Operation */
|
|
7170
|
+
operation: string;
|
|
7171
|
+
parking: components["schemas"]["ParkingActionPayloadData"];
|
|
7172
|
+
/**
|
|
7173
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7174
|
+
* @enum {string}
|
|
7175
|
+
*/
|
|
7176
|
+
type: "parking_disable_bulk";
|
|
7177
|
+
};
|
|
7178
|
+
/** ParkingEnableBulkCommand */
|
|
7179
|
+
ParkingEnableBulkCommand: {
|
|
7180
|
+
/**
|
|
7181
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7182
|
+
* @enum {string}
|
|
7183
|
+
*/
|
|
7184
|
+
command: "parking_enable_bulk";
|
|
7185
|
+
/**
|
|
7186
|
+
* Idempotency Key
|
|
7187
|
+
* @description Idempotency key for this bulk command
|
|
7188
|
+
*/
|
|
7189
|
+
idempotency_key?: string | null;
|
|
7190
|
+
/** @description Bulk parking enable payload */
|
|
7191
|
+
payload: components["schemas"]["ParkingEnableBulkPayload"];
|
|
7192
|
+
/**
|
|
7193
|
+
* Version
|
|
7194
|
+
* @description Command version
|
|
7195
|
+
* @default v1
|
|
7196
|
+
*/
|
|
7197
|
+
version: string;
|
|
7198
|
+
};
|
|
7199
|
+
/** ParkingEnableBulkInstance */
|
|
7200
|
+
ParkingEnableBulkInstance: {
|
|
7201
|
+
/**
|
|
7202
|
+
* Parking Id
|
|
7203
|
+
* Format: typeid
|
|
7204
|
+
* @description The parking ID of the entry to enable
|
|
7205
|
+
* @example parking_01h45ytscbebyvny4gc8cr8ma2
|
|
7206
|
+
*/
|
|
7207
|
+
parking_id: TypeId<"parking">;
|
|
7208
|
+
};
|
|
7209
|
+
/** ParkingEnableBulkPayload */
|
|
7210
|
+
ParkingEnableBulkPayload: {
|
|
7211
|
+
/**
|
|
7212
|
+
* Instances
|
|
7213
|
+
* @description List of parking entries to enable (1-1000)
|
|
7214
|
+
*/
|
|
7215
|
+
instances: components["schemas"]["ParkingEnableBulkInstance"][];
|
|
7216
|
+
};
|
|
7217
|
+
/** ParkingEnableWorkerPayload */
|
|
7218
|
+
ParkingEnableWorkerPayload: {
|
|
7219
|
+
/** Operation */
|
|
7220
|
+
operation: string;
|
|
7221
|
+
parking: components["schemas"]["ParkingActionPayloadData"];
|
|
7222
|
+
/**
|
|
7223
|
+
* @description discriminator enum property added by openapi-typescript
|
|
7224
|
+
* @enum {string}
|
|
7225
|
+
*/
|
|
7226
|
+
type: "parking_enable_bulk";
|
|
7227
|
+
};
|
|
5484
7228
|
/** ParkingMetricsResponse */
|
|
5485
7229
|
ParkingMetricsResponse: {
|
|
5486
7230
|
/** @description Metrics for the parking entry */
|
|
@@ -5782,16 +7526,56 @@ export interface components {
|
|
|
5782
7526
|
*/
|
|
5783
7527
|
grant_type: string;
|
|
5784
7528
|
};
|
|
5785
|
-
/**
|
|
5786
|
-
|
|
7529
|
+
/** PublicReportListRes */
|
|
7530
|
+
PublicReportListRes: {
|
|
7531
|
+
pagination: components["schemas"]["PaginationMetadata"];
|
|
7532
|
+
/** Results */
|
|
7533
|
+
results: components["schemas"]["PublicReportRes"][];
|
|
7534
|
+
};
|
|
7535
|
+
/** PublicReportRes */
|
|
7536
|
+
PublicReportRes: {
|
|
5787
7537
|
/**
|
|
5788
|
-
*
|
|
5789
|
-
*
|
|
7538
|
+
* Created On
|
|
7539
|
+
* Format: date-time
|
|
5790
7540
|
*/
|
|
5791
|
-
|
|
5792
|
-
|
|
5793
|
-
|
|
5794
|
-
|
|
7541
|
+
created_on: Date;
|
|
7542
|
+
/** File Size Bytes */
|
|
7543
|
+
file_size_bytes?: number | null;
|
|
7544
|
+
/** Generated On */
|
|
7545
|
+
generated_on?: Date | null;
|
|
7546
|
+
/**
|
|
7547
|
+
* Organization Id
|
|
7548
|
+
* Format: typeid
|
|
7549
|
+
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
7550
|
+
*/
|
|
7551
|
+
organization_id: TypeId<"organization">;
|
|
7552
|
+
/** Record Count */
|
|
7553
|
+
record_count?: number | null;
|
|
7554
|
+
/**
|
|
7555
|
+
* Report Id
|
|
7556
|
+
* Format: typeid
|
|
7557
|
+
* @example report_01h45ytscbebyvny4gc8cr8ma2
|
|
7558
|
+
*/
|
|
7559
|
+
report_id: TypeId<"report">;
|
|
7560
|
+
report_type: components["schemas"]["ReportType"];
|
|
7561
|
+
status: components["schemas"]["ReportStatus"];
|
|
7562
|
+
trigger_type: components["schemas"]["ReportTriggerType"];
|
|
7563
|
+
/**
|
|
7564
|
+
* Updated On
|
|
7565
|
+
* Format: date-time
|
|
7566
|
+
*/
|
|
7567
|
+
updated_on: Date;
|
|
7568
|
+
};
|
|
7569
|
+
/** RdapBase */
|
|
7570
|
+
RdapBase: {
|
|
7571
|
+
/**
|
|
7572
|
+
* Rdap Server
|
|
7573
|
+
* @description RDAP server URL
|
|
7574
|
+
*/
|
|
7575
|
+
rdap_server?: string | null;
|
|
7576
|
+
};
|
|
7577
|
+
/**
|
|
7578
|
+
* RedirectCode
|
|
5795
7579
|
* @enum {integer}
|
|
5796
7580
|
*/
|
|
5797
7581
|
RedirectCode: 301 | 302 | 307 | 308;
|
|
@@ -5862,6 +7646,21 @@ export interface components {
|
|
|
5862
7646
|
* @enum {string}
|
|
5863
7647
|
*/
|
|
5864
7648
|
RenewalMode: "renew" | "expire";
|
|
7649
|
+
/**
|
|
7650
|
+
* ReportStatus
|
|
7651
|
+
* @enum {string}
|
|
7652
|
+
*/
|
|
7653
|
+
ReportStatus: "pending" | "generating" | "completed" | "failed";
|
|
7654
|
+
/**
|
|
7655
|
+
* ReportTriggerType
|
|
7656
|
+
* @enum {string}
|
|
7657
|
+
*/
|
|
7658
|
+
ReportTriggerType: "on_demand" | "scheduled";
|
|
7659
|
+
/**
|
|
7660
|
+
* ReportType
|
|
7661
|
+
* @enum {string}
|
|
7662
|
+
*/
|
|
7663
|
+
ReportType: "domain_inventory" | "dns_zone_summary" | "dns_zone_records";
|
|
5865
7664
|
/** RequestHistory */
|
|
5866
7665
|
RequestHistory: {
|
|
5867
7666
|
/**
|
|
@@ -12368,53 +14167,642 @@ export interface operations {
|
|
|
12368
14167
|
};
|
|
12369
14168
|
header?: never;
|
|
12370
14169
|
path: {
|
|
12371
|
-
email_forward_id: TypeId<"email_forward">;
|
|
14170
|
+
email_forward_id: TypeId<"email_forward">;
|
|
14171
|
+
};
|
|
14172
|
+
cookie?: never;
|
|
14173
|
+
};
|
|
14174
|
+
requestBody?: never;
|
|
14175
|
+
responses: {
|
|
14176
|
+
/** @description Successful Response */
|
|
14177
|
+
200: {
|
|
14178
|
+
headers: {
|
|
14179
|
+
[name: string]: unknown;
|
|
14180
|
+
};
|
|
14181
|
+
content: {
|
|
14182
|
+
"application/json": components["schemas"]["EmailForwardMetrics"];
|
|
14183
|
+
};
|
|
14184
|
+
};
|
|
14185
|
+
/** @description Unauthorized */
|
|
14186
|
+
401: {
|
|
14187
|
+
headers: {
|
|
14188
|
+
[name: string]: unknown;
|
|
14189
|
+
};
|
|
14190
|
+
content: {
|
|
14191
|
+
/** @example {
|
|
14192
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
14193
|
+
* "detail": "Additional error context.",
|
|
14194
|
+
* "status": 401,
|
|
14195
|
+
* "title": "Authentication Error",
|
|
14196
|
+
* "type": "authentication"
|
|
14197
|
+
* } */
|
|
14198
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14199
|
+
};
|
|
14200
|
+
};
|
|
14201
|
+
/** @description Forbidden */
|
|
14202
|
+
403: {
|
|
14203
|
+
headers: {
|
|
14204
|
+
[name: string]: unknown;
|
|
14205
|
+
};
|
|
14206
|
+
content: {
|
|
14207
|
+
/** @example {
|
|
14208
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
14209
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
14210
|
+
* "status": 403,
|
|
14211
|
+
* "title": "Permission Denied",
|
|
14212
|
+
* "type": "permission-denied"
|
|
14213
|
+
* } */
|
|
14214
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14215
|
+
};
|
|
14216
|
+
};
|
|
14217
|
+
/** @description Not Found */
|
|
14218
|
+
404: {
|
|
14219
|
+
headers: {
|
|
14220
|
+
[name: string]: unknown;
|
|
14221
|
+
};
|
|
14222
|
+
content: {
|
|
14223
|
+
/** @example {
|
|
14224
|
+
* "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
|
|
14225
|
+
* "detail": "Email forward not found for hostname: Additional error context.",
|
|
14226
|
+
* "status": 404,
|
|
14227
|
+
* "title": "Email Forward Error",
|
|
14228
|
+
* "type": "email-forward-not-found"
|
|
14229
|
+
* } */
|
|
14230
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14231
|
+
};
|
|
14232
|
+
};
|
|
14233
|
+
/** @description Validation Error */
|
|
14234
|
+
422: {
|
|
14235
|
+
headers: {
|
|
14236
|
+
[name: string]: unknown;
|
|
14237
|
+
};
|
|
14238
|
+
content: {
|
|
14239
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14240
|
+
};
|
|
14241
|
+
};
|
|
14242
|
+
};
|
|
14243
|
+
};
|
|
14244
|
+
get_events_v1_events_get: {
|
|
14245
|
+
parameters: {
|
|
14246
|
+
query?: {
|
|
14247
|
+
sort_by?: components["schemas"]["EventSortField"];
|
|
14248
|
+
sort_order?: components["schemas"]["SortOrder"];
|
|
14249
|
+
object_type?: components["schemas"]["EventObjectType"] | null;
|
|
14250
|
+
object_id?: string | null;
|
|
14251
|
+
type?: components["schemas"]["EventType"] | null;
|
|
14252
|
+
subtype?: components["schemas"]["EventSubtype"] | null;
|
|
14253
|
+
acknowledged?: boolean | null;
|
|
14254
|
+
page?: number;
|
|
14255
|
+
page_size?: number;
|
|
14256
|
+
};
|
|
14257
|
+
header?: never;
|
|
14258
|
+
path?: never;
|
|
14259
|
+
cookie?: never;
|
|
14260
|
+
};
|
|
14261
|
+
requestBody?: never;
|
|
14262
|
+
responses: {
|
|
14263
|
+
/** @description Successful Response */
|
|
14264
|
+
200: {
|
|
14265
|
+
headers: {
|
|
14266
|
+
[name: string]: unknown;
|
|
14267
|
+
};
|
|
14268
|
+
content: {
|
|
14269
|
+
"application/json": components["schemas"]["Pagination_EventResponse_"];
|
|
14270
|
+
};
|
|
14271
|
+
};
|
|
14272
|
+
/** @description Unauthorized */
|
|
14273
|
+
401: {
|
|
14274
|
+
headers: {
|
|
14275
|
+
[name: string]: unknown;
|
|
14276
|
+
};
|
|
14277
|
+
content: {
|
|
14278
|
+
/** @example {
|
|
14279
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
14280
|
+
* "detail": "Additional error context.",
|
|
14281
|
+
* "status": 401,
|
|
14282
|
+
* "title": "Authentication Error",
|
|
14283
|
+
* "type": "authentication"
|
|
14284
|
+
* } */
|
|
14285
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14286
|
+
};
|
|
14287
|
+
};
|
|
14288
|
+
/** @description Validation Error */
|
|
14289
|
+
422: {
|
|
14290
|
+
headers: {
|
|
14291
|
+
[name: string]: unknown;
|
|
14292
|
+
};
|
|
14293
|
+
content: {
|
|
14294
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14295
|
+
};
|
|
14296
|
+
};
|
|
14297
|
+
};
|
|
14298
|
+
};
|
|
14299
|
+
get_event_v1_events__event_id__get: {
|
|
14300
|
+
parameters: {
|
|
14301
|
+
query?: never;
|
|
14302
|
+
header?: never;
|
|
14303
|
+
path: {
|
|
14304
|
+
event_id: TypeId<"epp_event">;
|
|
14305
|
+
};
|
|
14306
|
+
cookie?: never;
|
|
14307
|
+
};
|
|
14308
|
+
requestBody?: never;
|
|
14309
|
+
responses: {
|
|
14310
|
+
/** @description Successful Response */
|
|
14311
|
+
200: {
|
|
14312
|
+
headers: {
|
|
14313
|
+
[name: string]: unknown;
|
|
14314
|
+
};
|
|
14315
|
+
content: {
|
|
14316
|
+
"application/json": components["schemas"]["EventSchema"];
|
|
14317
|
+
};
|
|
14318
|
+
};
|
|
14319
|
+
/** @description Unauthorized */
|
|
14320
|
+
401: {
|
|
14321
|
+
headers: {
|
|
14322
|
+
[name: string]: unknown;
|
|
14323
|
+
};
|
|
14324
|
+
content: {
|
|
14325
|
+
/** @example {
|
|
14326
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
14327
|
+
* "detail": "Additional error context.",
|
|
14328
|
+
* "status": 401,
|
|
14329
|
+
* "title": "Authentication Error",
|
|
14330
|
+
* "type": "authentication"
|
|
14331
|
+
* } */
|
|
14332
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14333
|
+
};
|
|
14334
|
+
};
|
|
14335
|
+
/** @description Not Found */
|
|
14336
|
+
404: {
|
|
14337
|
+
headers: {
|
|
14338
|
+
[name: string]: unknown;
|
|
14339
|
+
};
|
|
14340
|
+
content: {
|
|
14341
|
+
/** @example {
|
|
14342
|
+
* "code": "ERROR_EVENT_NOT_FOUND",
|
|
14343
|
+
* "detail": "Event not found",
|
|
14344
|
+
* "event_id": "Additional error context.",
|
|
14345
|
+
* "status": 404,
|
|
14346
|
+
* "title": "Event Error",
|
|
14347
|
+
* "type": "event-not-found"
|
|
14348
|
+
* } */
|
|
14349
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14350
|
+
};
|
|
14351
|
+
};
|
|
14352
|
+
/** @description Validation Error */
|
|
14353
|
+
422: {
|
|
14354
|
+
headers: {
|
|
14355
|
+
[name: string]: unknown;
|
|
14356
|
+
};
|
|
14357
|
+
content: {
|
|
14358
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14359
|
+
};
|
|
14360
|
+
};
|
|
14361
|
+
};
|
|
14362
|
+
};
|
|
14363
|
+
acknowledge_event_v1_events__event_id__patch: {
|
|
14364
|
+
parameters: {
|
|
14365
|
+
query?: never;
|
|
14366
|
+
header?: never;
|
|
14367
|
+
path: {
|
|
14368
|
+
event_id: TypeId<"epp_event">;
|
|
14369
|
+
};
|
|
14370
|
+
cookie?: never;
|
|
14371
|
+
};
|
|
14372
|
+
requestBody?: never;
|
|
14373
|
+
responses: {
|
|
14374
|
+
/** @description Successful Response */
|
|
14375
|
+
204: {
|
|
14376
|
+
headers: {
|
|
14377
|
+
[name: string]: unknown;
|
|
14378
|
+
};
|
|
14379
|
+
content?: never;
|
|
14380
|
+
};
|
|
14381
|
+
/** @description Unauthorized */
|
|
14382
|
+
401: {
|
|
14383
|
+
headers: {
|
|
14384
|
+
[name: string]: unknown;
|
|
14385
|
+
};
|
|
14386
|
+
content: {
|
|
14387
|
+
/** @example {
|
|
14388
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
14389
|
+
* "detail": "Additional error context.",
|
|
14390
|
+
* "status": 401,
|
|
14391
|
+
* "title": "Authentication Error",
|
|
14392
|
+
* "type": "authentication"
|
|
14393
|
+
* } */
|
|
14394
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14395
|
+
};
|
|
14396
|
+
};
|
|
14397
|
+
/** @description Not Found */
|
|
14398
|
+
404: {
|
|
14399
|
+
headers: {
|
|
14400
|
+
[name: string]: unknown;
|
|
14401
|
+
};
|
|
14402
|
+
content: {
|
|
14403
|
+
/** @example {
|
|
14404
|
+
* "code": "ERROR_EVENT_NOT_FOUND",
|
|
14405
|
+
* "detail": "Event not found",
|
|
14406
|
+
* "event_id": "Additional error context.",
|
|
14407
|
+
* "status": 404,
|
|
14408
|
+
* "title": "Event Error",
|
|
14409
|
+
* "type": "event-not-found"
|
|
14410
|
+
* } */
|
|
14411
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14412
|
+
};
|
|
14413
|
+
};
|
|
14414
|
+
/** @description Validation Error */
|
|
14415
|
+
422: {
|
|
14416
|
+
headers: {
|
|
14417
|
+
[name: string]: unknown;
|
|
14418
|
+
};
|
|
14419
|
+
content: {
|
|
14420
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14421
|
+
};
|
|
14422
|
+
};
|
|
14423
|
+
};
|
|
14424
|
+
};
|
|
14425
|
+
get_job_v1_job__job_id__get: {
|
|
14426
|
+
parameters: {
|
|
14427
|
+
query?: never;
|
|
14428
|
+
header?: never;
|
|
14429
|
+
path: {
|
|
14430
|
+
/** @description Job ID */
|
|
14431
|
+
job_id: TypeId<"job">;
|
|
14432
|
+
};
|
|
14433
|
+
cookie?: never;
|
|
14434
|
+
};
|
|
14435
|
+
requestBody?: never;
|
|
14436
|
+
responses: {
|
|
14437
|
+
/** @description Successful Response */
|
|
14438
|
+
200: {
|
|
14439
|
+
headers: {
|
|
14440
|
+
[name: string]: unknown;
|
|
14441
|
+
};
|
|
14442
|
+
content: {
|
|
14443
|
+
"application/json": components["schemas"]["JobResponse"];
|
|
14444
|
+
};
|
|
14445
|
+
};
|
|
14446
|
+
/** @description Not Found */
|
|
14447
|
+
404: {
|
|
14448
|
+
headers: {
|
|
14449
|
+
[name: string]: unknown;
|
|
14450
|
+
};
|
|
14451
|
+
content: {
|
|
14452
|
+
/** @example {
|
|
14453
|
+
* "code": "ERROR_JOB_NOT_FOUND",
|
|
14454
|
+
* "detail": "No job found with id 'Additional error context.'",
|
|
14455
|
+
* "job_id": "Additional error context.",
|
|
14456
|
+
* "status": 404,
|
|
14457
|
+
* "title": "Batch Operation Error",
|
|
14458
|
+
* "type": "job-not-found"
|
|
14459
|
+
* } */
|
|
14460
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14461
|
+
};
|
|
14462
|
+
};
|
|
14463
|
+
/** @description Validation Error */
|
|
14464
|
+
422: {
|
|
14465
|
+
headers: {
|
|
14466
|
+
[name: string]: unknown;
|
|
14467
|
+
};
|
|
14468
|
+
content: {
|
|
14469
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14470
|
+
};
|
|
14471
|
+
};
|
|
14472
|
+
};
|
|
14473
|
+
};
|
|
14474
|
+
delete_job_v1_job__job_id__delete: {
|
|
14475
|
+
parameters: {
|
|
14476
|
+
query?: never;
|
|
14477
|
+
header?: never;
|
|
14478
|
+
path: {
|
|
14479
|
+
/** @description Job ID */
|
|
14480
|
+
job_id: TypeId<"job">;
|
|
14481
|
+
};
|
|
14482
|
+
cookie?: never;
|
|
14483
|
+
};
|
|
14484
|
+
requestBody?: never;
|
|
14485
|
+
responses: {
|
|
14486
|
+
/** @description Successful Response */
|
|
14487
|
+
204: {
|
|
14488
|
+
headers: {
|
|
14489
|
+
[name: string]: unknown;
|
|
14490
|
+
};
|
|
14491
|
+
content?: never;
|
|
14492
|
+
};
|
|
14493
|
+
/** @description Not Found */
|
|
14494
|
+
404: {
|
|
14495
|
+
headers: {
|
|
14496
|
+
[name: string]: unknown;
|
|
14497
|
+
};
|
|
14498
|
+
content: {
|
|
14499
|
+
/** @example {
|
|
14500
|
+
* "code": "ERROR_JOB_NOT_FOUND",
|
|
14501
|
+
* "detail": "No job found with id 'Additional error context.'",
|
|
14502
|
+
* "job_id": "Additional error context.",
|
|
14503
|
+
* "status": 404,
|
|
14504
|
+
* "title": "Batch Operation Error",
|
|
14505
|
+
* "type": "job-not-found"
|
|
14506
|
+
* } */
|
|
14507
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14508
|
+
};
|
|
14509
|
+
};
|
|
14510
|
+
/** @description Validation Error */
|
|
14511
|
+
422: {
|
|
14512
|
+
headers: {
|
|
14513
|
+
[name: string]: unknown;
|
|
14514
|
+
};
|
|
14515
|
+
content: {
|
|
14516
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14517
|
+
};
|
|
14518
|
+
};
|
|
14519
|
+
};
|
|
14520
|
+
};
|
|
14521
|
+
pause_job_v1_job__job_id__pause_post: {
|
|
14522
|
+
parameters: {
|
|
14523
|
+
query?: never;
|
|
14524
|
+
header?: never;
|
|
14525
|
+
path: {
|
|
14526
|
+
/** @description Job ID */
|
|
14527
|
+
job_id: TypeId<"job">;
|
|
14528
|
+
};
|
|
14529
|
+
cookie?: never;
|
|
14530
|
+
};
|
|
14531
|
+
requestBody?: never;
|
|
14532
|
+
responses: {
|
|
14533
|
+
/** @description Successful Response */
|
|
14534
|
+
204: {
|
|
14535
|
+
headers: {
|
|
14536
|
+
[name: string]: unknown;
|
|
14537
|
+
};
|
|
14538
|
+
content?: never;
|
|
14539
|
+
};
|
|
14540
|
+
/** @description Not Found */
|
|
14541
|
+
404: {
|
|
14542
|
+
headers: {
|
|
14543
|
+
[name: string]: unknown;
|
|
14544
|
+
};
|
|
14545
|
+
content: {
|
|
14546
|
+
/** @example {
|
|
14547
|
+
* "code": "ERROR_JOB_NOT_FOUND",
|
|
14548
|
+
* "detail": "No job found with id 'Additional error context.'",
|
|
14549
|
+
* "job_id": "Additional error context.",
|
|
14550
|
+
* "status": 404,
|
|
14551
|
+
* "title": "Batch Operation Error",
|
|
14552
|
+
* "type": "job-not-found"
|
|
14553
|
+
* } */
|
|
14554
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14555
|
+
};
|
|
14556
|
+
};
|
|
14557
|
+
/** @description Validation Error */
|
|
14558
|
+
422: {
|
|
14559
|
+
headers: {
|
|
14560
|
+
[name: string]: unknown;
|
|
14561
|
+
};
|
|
14562
|
+
content: {
|
|
14563
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14564
|
+
};
|
|
14565
|
+
};
|
|
14566
|
+
};
|
|
14567
|
+
};
|
|
14568
|
+
resume_job_v1_job__job_id__resume_post: {
|
|
14569
|
+
parameters: {
|
|
14570
|
+
query?: never;
|
|
14571
|
+
header?: never;
|
|
14572
|
+
path: {
|
|
14573
|
+
/** @description Job ID */
|
|
14574
|
+
job_id: TypeId<"job">;
|
|
14575
|
+
};
|
|
14576
|
+
cookie?: never;
|
|
14577
|
+
};
|
|
14578
|
+
requestBody?: never;
|
|
14579
|
+
responses: {
|
|
14580
|
+
/** @description Successful Response */
|
|
14581
|
+
200: {
|
|
14582
|
+
headers: {
|
|
14583
|
+
[name: string]: unknown;
|
|
14584
|
+
};
|
|
14585
|
+
content: {
|
|
14586
|
+
"application/json": components["schemas"]["JobResponse"];
|
|
14587
|
+
};
|
|
14588
|
+
};
|
|
14589
|
+
/** @description Not Found */
|
|
14590
|
+
404: {
|
|
14591
|
+
headers: {
|
|
14592
|
+
[name: string]: unknown;
|
|
14593
|
+
};
|
|
14594
|
+
content: {
|
|
14595
|
+
/** @example {
|
|
14596
|
+
* "code": "ERROR_JOB_NOT_FOUND",
|
|
14597
|
+
* "detail": "No job found with id 'Additional error context.'",
|
|
14598
|
+
* "job_id": "Additional error context.",
|
|
14599
|
+
* "status": 404,
|
|
14600
|
+
* "title": "Batch Operation Error",
|
|
14601
|
+
* "type": "job-not-found"
|
|
14602
|
+
* } */
|
|
14603
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14604
|
+
};
|
|
14605
|
+
};
|
|
14606
|
+
/** @description Validation Error */
|
|
14607
|
+
422: {
|
|
14608
|
+
headers: {
|
|
14609
|
+
[name: string]: unknown;
|
|
14610
|
+
};
|
|
14611
|
+
content: {
|
|
14612
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14613
|
+
};
|
|
14614
|
+
};
|
|
14615
|
+
};
|
|
14616
|
+
};
|
|
14617
|
+
list_batches_v1_jobs_get: {
|
|
14618
|
+
parameters: {
|
|
14619
|
+
query?: {
|
|
14620
|
+
/** @description Filter by batch status (pending or complete) */
|
|
14621
|
+
status?: components["schemas"]["BatchStatus"] | null;
|
|
14622
|
+
/** @description Sort field */
|
|
14623
|
+
sort_by?: components["schemas"]["BatchSortField"];
|
|
14624
|
+
/** @description Sort order */
|
|
14625
|
+
sort_order?: components["schemas"]["SortOrder"];
|
|
14626
|
+
page?: number;
|
|
14627
|
+
page_size?: number;
|
|
14628
|
+
};
|
|
14629
|
+
header?: never;
|
|
14630
|
+
path?: never;
|
|
14631
|
+
cookie?: never;
|
|
14632
|
+
};
|
|
14633
|
+
requestBody?: never;
|
|
14634
|
+
responses: {
|
|
14635
|
+
/** @description Successful Response */
|
|
14636
|
+
200: {
|
|
14637
|
+
headers: {
|
|
14638
|
+
[name: string]: unknown;
|
|
14639
|
+
};
|
|
14640
|
+
content: {
|
|
14641
|
+
"application/json": components["schemas"]["Pagination_JobBatchMetadataResponse_"];
|
|
14642
|
+
};
|
|
14643
|
+
};
|
|
14644
|
+
/** @description Validation Error */
|
|
14645
|
+
422: {
|
|
14646
|
+
headers: {
|
|
14647
|
+
[name: string]: unknown;
|
|
14648
|
+
};
|
|
14649
|
+
content: {
|
|
14650
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14651
|
+
};
|
|
14652
|
+
};
|
|
14653
|
+
};
|
|
14654
|
+
};
|
|
14655
|
+
create_batch_v1_jobs_post: {
|
|
14656
|
+
parameters: {
|
|
14657
|
+
query?: never;
|
|
14658
|
+
header?: never;
|
|
14659
|
+
path?: never;
|
|
14660
|
+
cookie?: never;
|
|
14661
|
+
};
|
|
14662
|
+
requestBody: {
|
|
14663
|
+
content: {
|
|
14664
|
+
"application/json": components["schemas"]["JobBatchRequest"];
|
|
14665
|
+
};
|
|
14666
|
+
};
|
|
14667
|
+
responses: {
|
|
14668
|
+
/** @description Batch created successfully */
|
|
14669
|
+
201: {
|
|
14670
|
+
headers: {
|
|
14671
|
+
[name: string]: unknown;
|
|
14672
|
+
};
|
|
14673
|
+
content: {
|
|
14674
|
+
"application/json": components["schemas"]["CreateJobBatchResponse"];
|
|
14675
|
+
};
|
|
14676
|
+
};
|
|
14677
|
+
/** @description Bad Request */
|
|
14678
|
+
400: {
|
|
14679
|
+
headers: {
|
|
14680
|
+
[name: string]: unknown;
|
|
14681
|
+
};
|
|
14682
|
+
content: {
|
|
14683
|
+
/** @example {
|
|
14684
|
+
* "code": "ERROR_BATCH_EMPTY",
|
|
14685
|
+
* "detail": "Additional error context.",
|
|
14686
|
+
* "status": 400,
|
|
14687
|
+
* "title": "Batch Operation Error",
|
|
14688
|
+
* "type": "batch-empty"
|
|
14689
|
+
* } */
|
|
14690
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14691
|
+
};
|
|
14692
|
+
};
|
|
14693
|
+
/** @description Validation Error */
|
|
14694
|
+
422: {
|
|
14695
|
+
headers: {
|
|
14696
|
+
[name: string]: unknown;
|
|
14697
|
+
};
|
|
14698
|
+
content: {
|
|
14699
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14700
|
+
};
|
|
14701
|
+
};
|
|
14702
|
+
/** @description Service Unavailable */
|
|
14703
|
+
503: {
|
|
14704
|
+
headers: {
|
|
14705
|
+
[name: string]: unknown;
|
|
14706
|
+
};
|
|
14707
|
+
content: {
|
|
14708
|
+
/** @example {
|
|
14709
|
+
* "code": "ERROR_BATCH_JOB_CREATION_FAILED",
|
|
14710
|
+
* "command": "Additional error context.",
|
|
14711
|
+
* "detail": "Failed to create job for command 'Additional error context.'",
|
|
14712
|
+
* "status": 503,
|
|
14713
|
+
* "title": "Batch Operation Error",
|
|
14714
|
+
* "type": "batch-job-creation"
|
|
14715
|
+
* } */
|
|
14716
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14717
|
+
};
|
|
14718
|
+
};
|
|
14719
|
+
};
|
|
14720
|
+
};
|
|
14721
|
+
get_batch_v1_jobs__batch_id__get: {
|
|
14722
|
+
parameters: {
|
|
14723
|
+
query?: never;
|
|
14724
|
+
header?: never;
|
|
14725
|
+
path: {
|
|
14726
|
+
/** @description Batch ID */
|
|
14727
|
+
batch_id: TypeId<"batch">;
|
|
12372
14728
|
};
|
|
12373
14729
|
cookie?: never;
|
|
12374
14730
|
};
|
|
12375
14731
|
requestBody?: never;
|
|
12376
14732
|
responses: {
|
|
12377
|
-
/** @description
|
|
14733
|
+
/** @description Batch status retrieved successfully */
|
|
12378
14734
|
200: {
|
|
12379
14735
|
headers: {
|
|
12380
14736
|
[name: string]: unknown;
|
|
12381
14737
|
};
|
|
12382
14738
|
content: {
|
|
12383
|
-
"application/json": components["schemas"]["
|
|
14739
|
+
"application/json": components["schemas"]["JobBatchStatusResponse"];
|
|
12384
14740
|
};
|
|
12385
14741
|
};
|
|
12386
|
-
/** @description
|
|
12387
|
-
|
|
14742
|
+
/** @description Not Found */
|
|
14743
|
+
404: {
|
|
12388
14744
|
headers: {
|
|
12389
14745
|
[name: string]: unknown;
|
|
12390
14746
|
};
|
|
12391
14747
|
content: {
|
|
12392
14748
|
/** @example {
|
|
12393
|
-
* "code": "
|
|
12394
|
-
* "
|
|
12395
|
-
* "
|
|
12396
|
-
* "
|
|
12397
|
-
* "
|
|
14749
|
+
* "code": "ERROR_BATCH_NOT_FOUND",
|
|
14750
|
+
* "correlation_id": "Additional error context.",
|
|
14751
|
+
* "detail": "No batch found with correlation_id 'Additional error context.'",
|
|
14752
|
+
* "status": 404,
|
|
14753
|
+
* "title": "Batch Operation Error",
|
|
14754
|
+
* "type": "batch-not-found"
|
|
12398
14755
|
* } */
|
|
12399
14756
|
"application/problem+json": components["schemas"]["Problem"];
|
|
12400
14757
|
};
|
|
12401
14758
|
};
|
|
12402
|
-
/** @description
|
|
12403
|
-
|
|
14759
|
+
/** @description Validation Error */
|
|
14760
|
+
422: {
|
|
14761
|
+
headers: {
|
|
14762
|
+
[name: string]: unknown;
|
|
14763
|
+
};
|
|
14764
|
+
content: {
|
|
14765
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
14766
|
+
};
|
|
14767
|
+
};
|
|
14768
|
+
/** @description Service Unavailable */
|
|
14769
|
+
503: {
|
|
12404
14770
|
headers: {
|
|
12405
14771
|
[name: string]: unknown;
|
|
12406
14772
|
};
|
|
12407
14773
|
content: {
|
|
12408
14774
|
/** @example {
|
|
12409
|
-
* "code": "
|
|
12410
|
-
* "
|
|
12411
|
-
* "
|
|
12412
|
-
* "
|
|
12413
|
-
* "
|
|
14775
|
+
* "code": "ERROR_BATCH_STATUS_FETCH_FAILED",
|
|
14776
|
+
* "correlation_id": "Additional error context.",
|
|
14777
|
+
* "detail": "Failed to fetch batch status for correlation_id 'Additional error context.'",
|
|
14778
|
+
* "status": 503,
|
|
14779
|
+
* "title": "Batch Operation Error",
|
|
14780
|
+
* "type": "batch-status-fetch"
|
|
12414
14781
|
* } */
|
|
12415
14782
|
"application/problem+json": components["schemas"]["Problem"];
|
|
12416
14783
|
};
|
|
12417
14784
|
};
|
|
14785
|
+
};
|
|
14786
|
+
};
|
|
14787
|
+
delete_batch_v1_jobs__batch_id__delete: {
|
|
14788
|
+
parameters: {
|
|
14789
|
+
query?: never;
|
|
14790
|
+
header?: never;
|
|
14791
|
+
path: {
|
|
14792
|
+
/** @description Batch ID */
|
|
14793
|
+
batch_id: TypeId<"batch">;
|
|
14794
|
+
};
|
|
14795
|
+
cookie?: never;
|
|
14796
|
+
};
|
|
14797
|
+
requestBody?: never;
|
|
14798
|
+
responses: {
|
|
14799
|
+
/** @description Successful Response */
|
|
14800
|
+
204: {
|
|
14801
|
+
headers: {
|
|
14802
|
+
[name: string]: unknown;
|
|
14803
|
+
};
|
|
14804
|
+
content?: never;
|
|
14805
|
+
};
|
|
12418
14806
|
/** @description Not Found */
|
|
12419
14807
|
404: {
|
|
12420
14808
|
headers: {
|
|
@@ -12422,11 +14810,12 @@ export interface operations {
|
|
|
12422
14810
|
};
|
|
12423
14811
|
content: {
|
|
12424
14812
|
/** @example {
|
|
12425
|
-
* "code": "
|
|
12426
|
-
* "
|
|
14813
|
+
* "code": "ERROR_BATCH_NOT_FOUND",
|
|
14814
|
+
* "correlation_id": "Additional error context.",
|
|
14815
|
+
* "detail": "No batch found with correlation_id 'Additional error context.'",
|
|
12427
14816
|
* "status": 404,
|
|
12428
|
-
* "title": "
|
|
12429
|
-
* "type": "
|
|
14817
|
+
* "title": "Batch Operation Error",
|
|
14818
|
+
* "type": "batch-not-found"
|
|
12430
14819
|
* } */
|
|
12431
14820
|
"application/problem+json": components["schemas"]["Problem"];
|
|
12432
14821
|
};
|
|
@@ -12442,46 +14831,49 @@ export interface operations {
|
|
|
12442
14831
|
};
|
|
12443
14832
|
};
|
|
12444
14833
|
};
|
|
12445
|
-
|
|
14834
|
+
get_batch_jobs_v1_jobs__batch_id__jobs_get: {
|
|
12446
14835
|
parameters: {
|
|
12447
14836
|
query?: {
|
|
12448
|
-
|
|
12449
|
-
|
|
12450
|
-
|
|
12451
|
-
|
|
12452
|
-
|
|
12453
|
-
|
|
12454
|
-
acknowledged?: boolean | null;
|
|
14837
|
+
/** @description Filter by job status (repeatable) */
|
|
14838
|
+
status?: components["schemas"]["JobStatus"][] | null;
|
|
14839
|
+
/** @description Sort field */
|
|
14840
|
+
sort_by?: components["schemas"]["BatchSortField"] | null;
|
|
14841
|
+
/** @description Sort order */
|
|
14842
|
+
sort_order?: components["schemas"]["SortOrder"] | null;
|
|
12455
14843
|
page?: number;
|
|
12456
14844
|
page_size?: number;
|
|
12457
14845
|
};
|
|
12458
14846
|
header?: never;
|
|
12459
|
-
path
|
|
14847
|
+
path: {
|
|
14848
|
+
/** @description Batch ID */
|
|
14849
|
+
batch_id: TypeId<"batch">;
|
|
14850
|
+
};
|
|
12460
14851
|
cookie?: never;
|
|
12461
14852
|
};
|
|
12462
14853
|
requestBody?: never;
|
|
12463
14854
|
responses: {
|
|
12464
|
-
/** @description
|
|
14855
|
+
/** @description Batch jobs retrieved successfully */
|
|
12465
14856
|
200: {
|
|
12466
14857
|
headers: {
|
|
12467
14858
|
[name: string]: unknown;
|
|
12468
14859
|
};
|
|
12469
14860
|
content: {
|
|
12470
|
-
"application/json": components["schemas"]["
|
|
14861
|
+
"application/json": components["schemas"]["Pagination_JobResponse_"];
|
|
12471
14862
|
};
|
|
12472
14863
|
};
|
|
12473
|
-
/** @description
|
|
12474
|
-
|
|
14864
|
+
/** @description Not Found */
|
|
14865
|
+
404: {
|
|
12475
14866
|
headers: {
|
|
12476
14867
|
[name: string]: unknown;
|
|
12477
14868
|
};
|
|
12478
14869
|
content: {
|
|
12479
14870
|
/** @example {
|
|
12480
|
-
* "code": "
|
|
12481
|
-
* "
|
|
12482
|
-
* "
|
|
12483
|
-
* "
|
|
12484
|
-
* "
|
|
14871
|
+
* "code": "ERROR_BATCH_NOT_FOUND",
|
|
14872
|
+
* "correlation_id": "Additional error context.",
|
|
14873
|
+
* "detail": "No batch found with correlation_id 'Additional error context.'",
|
|
14874
|
+
* "status": 404,
|
|
14875
|
+
* "title": "Batch Operation Error",
|
|
14876
|
+
* "type": "batch-not-found"
|
|
12485
14877
|
* } */
|
|
12486
14878
|
"application/problem+json": components["schemas"]["Problem"];
|
|
12487
14879
|
};
|
|
@@ -12495,43 +14887,43 @@ export interface operations {
|
|
|
12495
14887
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
12496
14888
|
};
|
|
12497
14889
|
};
|
|
14890
|
+
/** @description Service Unavailable */
|
|
14891
|
+
503: {
|
|
14892
|
+
headers: {
|
|
14893
|
+
[name: string]: unknown;
|
|
14894
|
+
};
|
|
14895
|
+
content: {
|
|
14896
|
+
/** @example {
|
|
14897
|
+
* "code": "ERROR_BATCH_STATUS_FETCH_FAILED",
|
|
14898
|
+
* "correlation_id": "Additional error context.",
|
|
14899
|
+
* "detail": "Failed to fetch batch status for correlation_id 'Additional error context.'",
|
|
14900
|
+
* "status": 503,
|
|
14901
|
+
* "title": "Batch Operation Error",
|
|
14902
|
+
* "type": "batch-status-fetch"
|
|
14903
|
+
* } */
|
|
14904
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
14905
|
+
};
|
|
14906
|
+
};
|
|
12498
14907
|
};
|
|
12499
14908
|
};
|
|
12500
|
-
|
|
14909
|
+
pause_batch_v1_jobs__batch_id__pause_post: {
|
|
12501
14910
|
parameters: {
|
|
12502
14911
|
query?: never;
|
|
12503
14912
|
header?: never;
|
|
12504
14913
|
path: {
|
|
12505
|
-
|
|
14914
|
+
/** @description Batch ID */
|
|
14915
|
+
batch_id: TypeId<"batch">;
|
|
12506
14916
|
};
|
|
12507
14917
|
cookie?: never;
|
|
12508
14918
|
};
|
|
12509
14919
|
requestBody?: never;
|
|
12510
14920
|
responses: {
|
|
12511
14921
|
/** @description Successful Response */
|
|
12512
|
-
|
|
12513
|
-
headers: {
|
|
12514
|
-
[name: string]: unknown;
|
|
12515
|
-
};
|
|
12516
|
-
content: {
|
|
12517
|
-
"application/json": components["schemas"]["EventSchema"];
|
|
12518
|
-
};
|
|
12519
|
-
};
|
|
12520
|
-
/** @description Unauthorized */
|
|
12521
|
-
401: {
|
|
14922
|
+
204: {
|
|
12522
14923
|
headers: {
|
|
12523
14924
|
[name: string]: unknown;
|
|
12524
14925
|
};
|
|
12525
|
-
content
|
|
12526
|
-
/** @example {
|
|
12527
|
-
* "code": "ERROR_AUTHENTICATION",
|
|
12528
|
-
* "detail": "Additional error context.",
|
|
12529
|
-
* "status": 401,
|
|
12530
|
-
* "title": "Authentication Error",
|
|
12531
|
-
* "type": "authentication"
|
|
12532
|
-
* } */
|
|
12533
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
12534
|
-
};
|
|
14926
|
+
content?: never;
|
|
12535
14927
|
};
|
|
12536
14928
|
/** @description Not Found */
|
|
12537
14929
|
404: {
|
|
@@ -12540,12 +14932,12 @@ export interface operations {
|
|
|
12540
14932
|
};
|
|
12541
14933
|
content: {
|
|
12542
14934
|
/** @example {
|
|
12543
|
-
* "code": "
|
|
12544
|
-
* "
|
|
12545
|
-
* "
|
|
14935
|
+
* "code": "ERROR_BATCH_NOT_FOUND",
|
|
14936
|
+
* "correlation_id": "Additional error context.",
|
|
14937
|
+
* "detail": "No batch found with correlation_id 'Additional error context.'",
|
|
12546
14938
|
* "status": 404,
|
|
12547
|
-
* "title": "
|
|
12548
|
-
* "type": "
|
|
14939
|
+
* "title": "Batch Operation Error",
|
|
14940
|
+
* "type": "batch-not-found"
|
|
12549
14941
|
* } */
|
|
12550
14942
|
"application/problem+json": components["schemas"]["Problem"];
|
|
12551
14943
|
};
|
|
@@ -12561,12 +14953,13 @@ export interface operations {
|
|
|
12561
14953
|
};
|
|
12562
14954
|
};
|
|
12563
14955
|
};
|
|
12564
|
-
|
|
14956
|
+
resume_batch_v1_jobs__batch_id__resume_post: {
|
|
12565
14957
|
parameters: {
|
|
12566
14958
|
query?: never;
|
|
12567
14959
|
header?: never;
|
|
12568
14960
|
path: {
|
|
12569
|
-
|
|
14961
|
+
/** @description Batch ID */
|
|
14962
|
+
batch_id: TypeId<"batch">;
|
|
12570
14963
|
};
|
|
12571
14964
|
cookie?: never;
|
|
12572
14965
|
};
|
|
@@ -12579,22 +14972,6 @@ export interface operations {
|
|
|
12579
14972
|
};
|
|
12580
14973
|
content?: never;
|
|
12581
14974
|
};
|
|
12582
|
-
/** @description Unauthorized */
|
|
12583
|
-
401: {
|
|
12584
|
-
headers: {
|
|
12585
|
-
[name: string]: unknown;
|
|
12586
|
-
};
|
|
12587
|
-
content: {
|
|
12588
|
-
/** @example {
|
|
12589
|
-
* "code": "ERROR_AUTHENTICATION",
|
|
12590
|
-
* "detail": "Additional error context.",
|
|
12591
|
-
* "status": 401,
|
|
12592
|
-
* "title": "Authentication Error",
|
|
12593
|
-
* "type": "authentication"
|
|
12594
|
-
* } */
|
|
12595
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
12596
|
-
};
|
|
12597
|
-
};
|
|
12598
14975
|
/** @description Not Found */
|
|
12599
14976
|
404: {
|
|
12600
14977
|
headers: {
|
|
@@ -12602,12 +14979,12 @@ export interface operations {
|
|
|
12602
14979
|
};
|
|
12603
14980
|
content: {
|
|
12604
14981
|
/** @example {
|
|
12605
|
-
* "code": "
|
|
12606
|
-
* "
|
|
12607
|
-
* "
|
|
14982
|
+
* "code": "ERROR_BATCH_NOT_FOUND",
|
|
14983
|
+
* "correlation_id": "Additional error context.",
|
|
14984
|
+
* "detail": "No batch found with correlation_id 'Additional error context.'",
|
|
12608
14985
|
* "status": 404,
|
|
12609
|
-
* "title": "
|
|
12610
|
-
* "type": "
|
|
14986
|
+
* "title": "Batch Operation Error",
|
|
14987
|
+
* "type": "batch-not-found"
|
|
12611
14988
|
* } */
|
|
12612
14989
|
"application/problem+json": components["schemas"]["Problem"];
|
|
12613
14990
|
};
|
|
@@ -14239,6 +16616,138 @@ export interface operations {
|
|
|
14239
16616
|
};
|
|
14240
16617
|
};
|
|
14241
16618
|
};
|
|
16619
|
+
list_reports_v1_reports_get: {
|
|
16620
|
+
parameters: {
|
|
16621
|
+
query?: {
|
|
16622
|
+
page?: number;
|
|
16623
|
+
page_size?: number;
|
|
16624
|
+
report_type?: components["schemas"]["ReportType"][] | null;
|
|
16625
|
+
status?: components["schemas"]["ReportStatus"][] | null;
|
|
16626
|
+
trigger_type?: components["schemas"]["ReportTriggerType"] | null;
|
|
16627
|
+
created_after?: Date | null;
|
|
16628
|
+
created_before?: Date | null;
|
|
16629
|
+
};
|
|
16630
|
+
header?: never;
|
|
16631
|
+
path?: never;
|
|
16632
|
+
cookie?: never;
|
|
16633
|
+
};
|
|
16634
|
+
requestBody?: never;
|
|
16635
|
+
responses: {
|
|
16636
|
+
/** @description Successful Response */
|
|
16637
|
+
200: {
|
|
16638
|
+
headers: {
|
|
16639
|
+
[name: string]: unknown;
|
|
16640
|
+
};
|
|
16641
|
+
content: {
|
|
16642
|
+
"application/json": components["schemas"]["PublicReportListRes"];
|
|
16643
|
+
};
|
|
16644
|
+
};
|
|
16645
|
+
/** @description Validation Error */
|
|
16646
|
+
422: {
|
|
16647
|
+
headers: {
|
|
16648
|
+
[name: string]: unknown;
|
|
16649
|
+
};
|
|
16650
|
+
content: {
|
|
16651
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
16652
|
+
};
|
|
16653
|
+
};
|
|
16654
|
+
};
|
|
16655
|
+
};
|
|
16656
|
+
create_report_v1_reports_post: {
|
|
16657
|
+
parameters: {
|
|
16658
|
+
query?: never;
|
|
16659
|
+
header?: never;
|
|
16660
|
+
path?: never;
|
|
16661
|
+
cookie?: never;
|
|
16662
|
+
};
|
|
16663
|
+
requestBody?: {
|
|
16664
|
+
content: {
|
|
16665
|
+
"application/json": components["schemas"]["CreateReportReq"] | null;
|
|
16666
|
+
};
|
|
16667
|
+
};
|
|
16668
|
+
responses: {
|
|
16669
|
+
/** @description Successful Response */
|
|
16670
|
+
202: {
|
|
16671
|
+
headers: {
|
|
16672
|
+
[name: string]: unknown;
|
|
16673
|
+
};
|
|
16674
|
+
content: {
|
|
16675
|
+
"application/json": unknown;
|
|
16676
|
+
};
|
|
16677
|
+
};
|
|
16678
|
+
/** @description Validation Error */
|
|
16679
|
+
422: {
|
|
16680
|
+
headers: {
|
|
16681
|
+
[name: string]: unknown;
|
|
16682
|
+
};
|
|
16683
|
+
content: {
|
|
16684
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
16685
|
+
};
|
|
16686
|
+
};
|
|
16687
|
+
};
|
|
16688
|
+
};
|
|
16689
|
+
get_report_v1_reports__report_id__get: {
|
|
16690
|
+
parameters: {
|
|
16691
|
+
query?: never;
|
|
16692
|
+
header?: never;
|
|
16693
|
+
path: {
|
|
16694
|
+
report_id: string;
|
|
16695
|
+
};
|
|
16696
|
+
cookie?: never;
|
|
16697
|
+
};
|
|
16698
|
+
requestBody?: never;
|
|
16699
|
+
responses: {
|
|
16700
|
+
/** @description Successful Response */
|
|
16701
|
+
200: {
|
|
16702
|
+
headers: {
|
|
16703
|
+
[name: string]: unknown;
|
|
16704
|
+
};
|
|
16705
|
+
content: {
|
|
16706
|
+
"application/json": components["schemas"]["PublicReportRes"];
|
|
16707
|
+
};
|
|
16708
|
+
};
|
|
16709
|
+
/** @description Validation Error */
|
|
16710
|
+
422: {
|
|
16711
|
+
headers: {
|
|
16712
|
+
[name: string]: unknown;
|
|
16713
|
+
};
|
|
16714
|
+
content: {
|
|
16715
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
16716
|
+
};
|
|
16717
|
+
};
|
|
16718
|
+
};
|
|
16719
|
+
};
|
|
16720
|
+
download_report_v1_reports__report_id__download_get: {
|
|
16721
|
+
parameters: {
|
|
16722
|
+
query?: never;
|
|
16723
|
+
header?: never;
|
|
16724
|
+
path: {
|
|
16725
|
+
report_id: string;
|
|
16726
|
+
};
|
|
16727
|
+
cookie?: never;
|
|
16728
|
+
};
|
|
16729
|
+
requestBody?: never;
|
|
16730
|
+
responses: {
|
|
16731
|
+
/** @description Successful Response */
|
|
16732
|
+
200: {
|
|
16733
|
+
headers: {
|
|
16734
|
+
[name: string]: unknown;
|
|
16735
|
+
};
|
|
16736
|
+
content: {
|
|
16737
|
+
"application/json": unknown;
|
|
16738
|
+
};
|
|
16739
|
+
};
|
|
16740
|
+
/** @description Validation Error */
|
|
16741
|
+
422: {
|
|
16742
|
+
headers: {
|
|
16743
|
+
[name: string]: unknown;
|
|
16744
|
+
};
|
|
16745
|
+
content: {
|
|
16746
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
16747
|
+
};
|
|
16748
|
+
};
|
|
16749
|
+
};
|
|
16750
|
+
};
|
|
14242
16751
|
get_tld_specifications_v1_tlds__get: {
|
|
14243
16752
|
parameters: {
|
|
14244
16753
|
query?: {
|