@opusdns/api 0.43.0 → 0.45.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/keys.ts +238 -0
- package/src/helpers/requests.d.ts +53 -1
- package/src/helpers/responses.d.ts +56 -1
- package/src/helpers/schemas.d.ts +32 -0
- package/src/openapi.yaml +95 -1
- package/src/schema.d.ts +193 -96
package/src/schema.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { TypeId } from "typeid-js";
|
|
2
2
|
export interface paths {
|
|
3
3
|
"/v1/auth/client_credentials": {
|
|
4
4
|
parameters: {
|
|
@@ -600,6 +600,23 @@ export interface paths {
|
|
|
600
600
|
patch?: never;
|
|
601
601
|
trace?: never;
|
|
602
602
|
};
|
|
603
|
+
"/v1/domains/{domain_reference}/restore": {
|
|
604
|
+
parameters: {
|
|
605
|
+
query?: never;
|
|
606
|
+
header?: never;
|
|
607
|
+
path?: never;
|
|
608
|
+
cookie?: never;
|
|
609
|
+
};
|
|
610
|
+
get?: never;
|
|
611
|
+
put?: never;
|
|
612
|
+
/** Restore Domain */
|
|
613
|
+
post: operations["restore_domain_v1_domains__domain_reference__restore_post"];
|
|
614
|
+
delete?: never;
|
|
615
|
+
options?: never;
|
|
616
|
+
head?: never;
|
|
617
|
+
patch?: never;
|
|
618
|
+
trace?: never;
|
|
619
|
+
};
|
|
603
620
|
"/v1/domains/{domain_reference}/transfer": {
|
|
604
621
|
parameters: {
|
|
605
622
|
query?: never;
|
|
@@ -1268,7 +1285,7 @@ export interface components {
|
|
|
1268
1285
|
* Client Id
|
|
1269
1286
|
* @description The organization ID associated with the credentials.
|
|
1270
1287
|
*/
|
|
1271
|
-
client_id?:
|
|
1288
|
+
client_id?: TypeId<"organization"> | null;
|
|
1272
1289
|
/**
|
|
1273
1290
|
* Client Secret
|
|
1274
1291
|
* @description Client secret for authentication.
|
|
@@ -1386,10 +1403,10 @@ export interface components {
|
|
|
1386
1403
|
* Format: typeid
|
|
1387
1404
|
* @description The contact id of the contact
|
|
1388
1405
|
*/
|
|
1389
|
-
contact_id:
|
|
1406
|
+
contact_id: TypeId<"contact">;
|
|
1390
1407
|
};
|
|
1391
1408
|
ContactIdList: {
|
|
1392
|
-
[key: string]:
|
|
1409
|
+
[key: string]: TypeId<"contact">;
|
|
1393
1410
|
};
|
|
1394
1411
|
/** ContactResponse */
|
|
1395
1412
|
ContactResponse: {
|
|
@@ -1477,7 +1494,7 @@ export interface components {
|
|
|
1477
1494
|
* Contact Id
|
|
1478
1495
|
* Format: typeid
|
|
1479
1496
|
*/
|
|
1480
|
-
contact_id?:
|
|
1497
|
+
contact_id?: TypeId<"contact">;
|
|
1481
1498
|
/**
|
|
1482
1499
|
* Country
|
|
1483
1500
|
* @description The country of the contact
|
|
@@ -1531,7 +1548,7 @@ export interface components {
|
|
|
1531
1548
|
* @description The organization that owns the domain
|
|
1532
1549
|
* @default None
|
|
1533
1550
|
*/
|
|
1534
|
-
organization_id:
|
|
1551
|
+
organization_id: TypeId<"organization">;
|
|
1535
1552
|
/**
|
|
1536
1553
|
* Phone
|
|
1537
1554
|
* Format: phone
|
|
@@ -1577,12 +1594,12 @@ export interface components {
|
|
|
1577
1594
|
* @description The contact that is being verified
|
|
1578
1595
|
* @default None
|
|
1579
1596
|
*/
|
|
1580
|
-
contact_id:
|
|
1597
|
+
contact_id: TypeId<"contact">;
|
|
1581
1598
|
/**
|
|
1582
1599
|
* Contact Verification Id
|
|
1583
1600
|
* Format: typeid
|
|
1584
1601
|
*/
|
|
1585
|
-
contact_verification_id?:
|
|
1602
|
+
contact_verification_id?: TypeId<"contact_verification">;
|
|
1586
1603
|
/**
|
|
1587
1604
|
* Created On
|
|
1588
1605
|
* Format: date-time
|
|
@@ -1626,12 +1643,12 @@ export interface components {
|
|
|
1626
1643
|
* @description The contact that is being verified
|
|
1627
1644
|
* @default None
|
|
1628
1645
|
*/
|
|
1629
|
-
contact_id:
|
|
1646
|
+
contact_id: TypeId<"contact">;
|
|
1630
1647
|
/**
|
|
1631
1648
|
* Contact Verification Id
|
|
1632
1649
|
* Format: typeid
|
|
1633
1650
|
*/
|
|
1634
|
-
contact_verification_id?:
|
|
1651
|
+
contact_verification_id?: TypeId<"contact_verification">;
|
|
1635
1652
|
/**
|
|
1636
1653
|
* Created On
|
|
1637
1654
|
* Format: date-time
|
|
@@ -1670,12 +1687,12 @@ export interface components {
|
|
|
1670
1687
|
* @description The contact that is being verified
|
|
1671
1688
|
* @default None
|
|
1672
1689
|
*/
|
|
1673
|
-
contact_id:
|
|
1690
|
+
contact_id: TypeId<"contact">;
|
|
1674
1691
|
/**
|
|
1675
1692
|
* Contact Verification Id
|
|
1676
1693
|
* Format: typeid
|
|
1677
1694
|
*/
|
|
1678
|
-
contact_verification_id?:
|
|
1695
|
+
contact_verification_id?: TypeId<"contact_verification">;
|
|
1679
1696
|
/**
|
|
1680
1697
|
* Created On
|
|
1681
1698
|
* Format: date-time
|
|
@@ -2013,7 +2030,7 @@ export interface components {
|
|
|
2013
2030
|
* Format: typeid
|
|
2014
2031
|
* @description The contact id of the contact
|
|
2015
2032
|
*/
|
|
2016
|
-
contact_id:
|
|
2033
|
+
contact_id: TypeId<"contact">;
|
|
2017
2034
|
/** @description The type of contact */
|
|
2018
2035
|
contact_type: components["schemas"]["DomainContactType"];
|
|
2019
2036
|
};
|
|
@@ -2104,14 +2121,14 @@ export interface components {
|
|
|
2104
2121
|
* Domain Dnssec Data Id
|
|
2105
2122
|
* Format: typeid
|
|
2106
2123
|
*/
|
|
2107
|
-
domain_dnssec_data_id?:
|
|
2124
|
+
domain_dnssec_data_id?: TypeId<"domain_dnssec">;
|
|
2108
2125
|
/**
|
|
2109
2126
|
* Domain Id
|
|
2110
2127
|
* Format: typeid
|
|
2111
2128
|
* @description The domain this DNSSEC record belongs to
|
|
2112
2129
|
* @default None
|
|
2113
2130
|
*/
|
|
2114
|
-
domain_id:
|
|
2131
|
+
domain_id: TypeId<"domain">;
|
|
2115
2132
|
/**
|
|
2116
2133
|
* Flags
|
|
2117
2134
|
* @description DNSKEY flags for key records
|
|
@@ -2283,7 +2300,7 @@ export interface components {
|
|
|
2283
2300
|
* Domain Id
|
|
2284
2301
|
* Format: typeid
|
|
2285
2302
|
*/
|
|
2286
|
-
domain_id?:
|
|
2303
|
+
domain_id?: TypeId<"domain">;
|
|
2287
2304
|
/**
|
|
2288
2305
|
* Expires On
|
|
2289
2306
|
* @description When the domain expires
|
|
@@ -2305,7 +2322,7 @@ export interface components {
|
|
|
2305
2322
|
* @description The organization that owns the domain
|
|
2306
2323
|
* @default None
|
|
2307
2324
|
*/
|
|
2308
|
-
owner_id:
|
|
2325
|
+
owner_id: TypeId<"organization">;
|
|
2309
2326
|
/**
|
|
2310
2327
|
* Registered On
|
|
2311
2328
|
* @description When the domain was registered
|
|
@@ -2316,7 +2333,7 @@ export interface components {
|
|
|
2316
2333
|
* Format: typeid
|
|
2317
2334
|
* @default None
|
|
2318
2335
|
*/
|
|
2319
|
-
registry_account_id:
|
|
2336
|
+
registry_account_id: TypeId<"registry_account">;
|
|
2320
2337
|
/**
|
|
2321
2338
|
* Registry Statuses
|
|
2322
2339
|
* @description All the domain statuses
|
|
@@ -2352,6 +2369,51 @@ export interface components {
|
|
|
2352
2369
|
*/
|
|
2353
2370
|
updated_on?: Date;
|
|
2354
2371
|
};
|
|
2372
|
+
/** DomainRestoreRequest */
|
|
2373
|
+
DomainRestoreRequest: {
|
|
2374
|
+
/**
|
|
2375
|
+
* Additional Info
|
|
2376
|
+
* @description Additional information to include in the restore operation
|
|
2377
|
+
*/
|
|
2378
|
+
additional_info?: string | null;
|
|
2379
|
+
/**
|
|
2380
|
+
* Auto Renew
|
|
2381
|
+
* @description Whether to automatically renew the domain after restore
|
|
2382
|
+
* @default true
|
|
2383
|
+
*/
|
|
2384
|
+
auto_renew: boolean;
|
|
2385
|
+
/**
|
|
2386
|
+
* Reason
|
|
2387
|
+
* @description Reason for restoring the domain
|
|
2388
|
+
*/
|
|
2389
|
+
reason: string;
|
|
2390
|
+
};
|
|
2391
|
+
/** DomainRestoreResponse */
|
|
2392
|
+
DomainRestoreResponse: {
|
|
2393
|
+
/**
|
|
2394
|
+
* Domain Id
|
|
2395
|
+
* Format: typeid
|
|
2396
|
+
* @description The ID of the restored domain
|
|
2397
|
+
*/
|
|
2398
|
+
domain_id: TypeId<"domain">;
|
|
2399
|
+
/**
|
|
2400
|
+
* Expiration Date
|
|
2401
|
+
* Format: date-time
|
|
2402
|
+
* @description The new expiration date after restore
|
|
2403
|
+
*/
|
|
2404
|
+
expiration_date: Date;
|
|
2405
|
+
/**
|
|
2406
|
+
* Name
|
|
2407
|
+
* @description The name of the restored domain
|
|
2408
|
+
*/
|
|
2409
|
+
name: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* Restored At
|
|
2412
|
+
* Format: date-time
|
|
2413
|
+
* @description When the domain restore operation was completed
|
|
2414
|
+
*/
|
|
2415
|
+
restored_at: Date;
|
|
2416
|
+
};
|
|
2355
2417
|
/** DomainSearchMeta */
|
|
2356
2418
|
DomainSearchMeta: {
|
|
2357
2419
|
/** Processing Time Ms */
|
|
@@ -2446,7 +2508,7 @@ export interface components {
|
|
|
2446
2508
|
* Format: typeid
|
|
2447
2509
|
* @description The organization ID
|
|
2448
2510
|
*/
|
|
2449
|
-
organization_id:
|
|
2511
|
+
organization_id: TypeId<"organization">;
|
|
2450
2512
|
};
|
|
2451
2513
|
/** DomainTransferIn */
|
|
2452
2514
|
DomainTransferIn: {
|
|
@@ -2553,7 +2615,7 @@ export interface components {
|
|
|
2553
2615
|
* Event Id
|
|
2554
2616
|
* Format: typeid
|
|
2555
2617
|
*/
|
|
2556
|
-
event_id?:
|
|
2618
|
+
event_id?: TypeId<"epp_event">;
|
|
2557
2619
|
/**
|
|
2558
2620
|
* Object Id
|
|
2559
2621
|
* @description The id of the object that the event is about
|
|
@@ -2588,7 +2650,7 @@ export interface components {
|
|
|
2588
2650
|
* Event Id
|
|
2589
2651
|
* Format: typeid
|
|
2590
2652
|
*/
|
|
2591
|
-
event_id?:
|
|
2653
|
+
event_id?: TypeId<"epp_event">;
|
|
2592
2654
|
/**
|
|
2593
2655
|
* Message Queue Id
|
|
2594
2656
|
* @description A composite key with the registry account + message queue ID from the poll operation.
|
|
@@ -2613,14 +2675,14 @@ export interface components {
|
|
|
2613
2675
|
* Source Event Id
|
|
2614
2676
|
* @description The reference of the original registry event (if any) that triggered this customer-facing event
|
|
2615
2677
|
*/
|
|
2616
|
-
source_event_id?:
|
|
2678
|
+
source_event_id?: TypeId<"epp_event"> | null;
|
|
2617
2679
|
/** @description The specific type/result of operation (considering the type property), more detailed (e.g., 'NOTIFICATION' with the 'DOMAIN_MODIFICATION' class) */
|
|
2618
2680
|
subtype?: components["schemas"]["EventSubtype"] | null;
|
|
2619
2681
|
/**
|
|
2620
2682
|
* Target
|
|
2621
2683
|
* @description The target of the event
|
|
2622
2684
|
*/
|
|
2623
|
-
target?:
|
|
2685
|
+
target?: TypeId<"organization"> | null;
|
|
2624
2686
|
/** @description The type of the event - indicates the kind of operation occurring (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION') */
|
|
2625
2687
|
type?: components["schemas"]["EventType"] | null;
|
|
2626
2688
|
};
|
|
@@ -2701,7 +2763,7 @@ export interface components {
|
|
|
2701
2763
|
* Organization Id
|
|
2702
2764
|
* Format: typeid
|
|
2703
2765
|
*/
|
|
2704
|
-
organization_id?:
|
|
2766
|
+
organization_id?: TypeId<"organization">;
|
|
2705
2767
|
};
|
|
2706
2768
|
/** IpRestrictionResponse */
|
|
2707
2769
|
IpRestrictionResponse: {
|
|
@@ -2724,7 +2786,7 @@ export interface components {
|
|
|
2724
2786
|
* Organization Id
|
|
2725
2787
|
* Format: typeid
|
|
2726
2788
|
*/
|
|
2727
|
-
organization_id:
|
|
2789
|
+
organization_id: TypeId<"organization">;
|
|
2728
2790
|
};
|
|
2729
2791
|
/** IpRestrictionUpdate */
|
|
2730
2792
|
IpRestrictionUpdate: {
|
|
@@ -2845,7 +2907,7 @@ export interface components {
|
|
|
2845
2907
|
* Notification Id
|
|
2846
2908
|
* Format: typeid
|
|
2847
2909
|
*/
|
|
2848
|
-
notification_id?:
|
|
2910
|
+
notification_id?: TypeId<"notification">;
|
|
2849
2911
|
/**
|
|
2850
2912
|
* Publish Date
|
|
2851
2913
|
* Format: date-time
|
|
@@ -2934,7 +2996,7 @@ export interface components {
|
|
|
2934
2996
|
* Notification Id
|
|
2935
2997
|
* Format: typeid
|
|
2936
2998
|
*/
|
|
2937
|
-
notification_id?:
|
|
2999
|
+
notification_id?: TypeId<"notification">;
|
|
2938
3000
|
/**
|
|
2939
3001
|
* Publish Date
|
|
2940
3002
|
* Format: date-time
|
|
@@ -3058,12 +3120,12 @@ export interface components {
|
|
|
3058
3120
|
* Format: typeid
|
|
3059
3121
|
* @description Unique identifier for the organization.
|
|
3060
3122
|
*/
|
|
3061
|
-
organization_id?:
|
|
3123
|
+
organization_id?: TypeId<"organization">;
|
|
3062
3124
|
/**
|
|
3063
3125
|
* Parent Organization Id
|
|
3064
3126
|
* @description ID of the parent organization.
|
|
3065
3127
|
*/
|
|
3066
|
-
parent_organization_id?:
|
|
3128
|
+
parent_organization_id?: TypeId<"organization"> | null;
|
|
3067
3129
|
/**
|
|
3068
3130
|
* Postal Code
|
|
3069
3131
|
* @description Postal code of the organization's address.
|
|
@@ -3255,7 +3317,7 @@ export interface components {
|
|
|
3255
3317
|
* Parent Organization Id
|
|
3256
3318
|
* @description ID of the parent organization.
|
|
3257
3319
|
*/
|
|
3258
|
-
parent_organization_id?:
|
|
3320
|
+
parent_organization_id?: TypeId<"organization"> | null;
|
|
3259
3321
|
/**
|
|
3260
3322
|
* Postal Code
|
|
3261
3323
|
* @description Postal code of the organization's address.
|
|
@@ -3299,7 +3361,7 @@ export interface components {
|
|
|
3299
3361
|
* Format: typeid
|
|
3300
3362
|
* @description Unique identifier of the organization credential.
|
|
3301
3363
|
*/
|
|
3302
|
-
api_key_id:
|
|
3364
|
+
api_key_id: TypeId<"api_key">;
|
|
3303
3365
|
/**
|
|
3304
3366
|
* Api Key Name
|
|
3305
3367
|
* @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
|
|
@@ -3326,7 +3388,7 @@ export interface components {
|
|
|
3326
3388
|
* Format: typeid
|
|
3327
3389
|
* @default None
|
|
3328
3390
|
*/
|
|
3329
|
-
organization_id:
|
|
3391
|
+
organization_id: TypeId<"organization">;
|
|
3330
3392
|
/** @description The status of the organization credential. */
|
|
3331
3393
|
readonly status: components["schemas"]["OrganizationCredentialStatus"];
|
|
3332
3394
|
};
|
|
@@ -3337,7 +3399,7 @@ export interface components {
|
|
|
3337
3399
|
* Format: typeid
|
|
3338
3400
|
* @description Unique identifier of the organization credential.
|
|
3339
3401
|
*/
|
|
3340
|
-
api_key:
|
|
3402
|
+
api_key: TypeId<"api_key">;
|
|
3341
3403
|
/**
|
|
3342
3404
|
* Api Key Description
|
|
3343
3405
|
* @description Description of the organization credential.
|
|
@@ -3353,7 +3415,7 @@ export interface components {
|
|
|
3353
3415
|
* Format: typeid
|
|
3354
3416
|
* @default None
|
|
3355
3417
|
*/
|
|
3356
|
-
client_id:
|
|
3418
|
+
client_id: TypeId<"organization">;
|
|
3357
3419
|
/**
|
|
3358
3420
|
* Client Secret
|
|
3359
3421
|
* @description Plaintext secret to be hashed (not stored directly in the DB).
|
|
@@ -3539,12 +3601,12 @@ export interface components {
|
|
|
3539
3601
|
* Format: typeid
|
|
3540
3602
|
* @description Unique identifier for the organization.
|
|
3541
3603
|
*/
|
|
3542
|
-
organization_id?:
|
|
3604
|
+
organization_id?: TypeId<"organization">;
|
|
3543
3605
|
/**
|
|
3544
3606
|
* Parent Organization Id
|
|
3545
3607
|
* @description ID of the parent organization.
|
|
3546
3608
|
*/
|
|
3547
|
-
parent_organization_id?:
|
|
3609
|
+
parent_organization_id?: TypeId<"organization"> | null;
|
|
3548
3610
|
/**
|
|
3549
3611
|
* Postal Code
|
|
3550
3612
|
* @description Postal code of the organization's address.
|
|
@@ -4121,7 +4183,7 @@ export interface components {
|
|
|
4121
4183
|
* @description The user's organization id
|
|
4122
4184
|
* @default None
|
|
4123
4185
|
*/
|
|
4124
|
-
organization_id:
|
|
4186
|
+
organization_id: TypeId<"organization">;
|
|
4125
4187
|
/**
|
|
4126
4188
|
* Phone
|
|
4127
4189
|
* @description The user's phone number
|
|
@@ -4138,7 +4200,7 @@ export interface components {
|
|
|
4138
4200
|
* User Id
|
|
4139
4201
|
* Format: typeid
|
|
4140
4202
|
*/
|
|
4141
|
-
user_id?:
|
|
4203
|
+
user_id?: TypeId<"user">;
|
|
4142
4204
|
/**
|
|
4143
4205
|
* Username
|
|
4144
4206
|
* @description The user's unique username
|
|
@@ -4231,7 +4293,7 @@ export interface components {
|
|
|
4231
4293
|
* @description Unique identifier for the notification
|
|
4232
4294
|
* @default None
|
|
4233
4295
|
*/
|
|
4234
|
-
notification_id:
|
|
4296
|
+
notification_id: TypeId<"notification">;
|
|
4235
4297
|
/**
|
|
4236
4298
|
* @description Whether the user has read the notification
|
|
4237
4299
|
* @default unread
|
|
@@ -4248,12 +4310,12 @@ export interface components {
|
|
|
4248
4310
|
* Format: typeid
|
|
4249
4311
|
* @default None
|
|
4250
4312
|
*/
|
|
4251
|
-
user_id:
|
|
4313
|
+
user_id: TypeId<"user">;
|
|
4252
4314
|
/**
|
|
4253
4315
|
* User Notification Id
|
|
4254
4316
|
* Format: typeid
|
|
4255
4317
|
*/
|
|
4256
|
-
user_notification_id?:
|
|
4318
|
+
user_notification_id?: TypeId<"user_notification">;
|
|
4257
4319
|
};
|
|
4258
4320
|
/**
|
|
4259
4321
|
* UserNotificationStatus
|
|
@@ -4272,7 +4334,7 @@ export interface components {
|
|
|
4272
4334
|
* User Notification Id
|
|
4273
4335
|
* Format: typeid
|
|
4274
4336
|
*/
|
|
4275
|
-
user_notification_id?:
|
|
4337
|
+
user_notification_id?: TypeId<"user_notification">;
|
|
4276
4338
|
};
|
|
4277
4339
|
/** UserPasswordResetEmailResponse */
|
|
4278
4340
|
UserPasswordResetEmailResponse: {
|
|
@@ -4379,12 +4441,12 @@ export interface components {
|
|
|
4379
4441
|
* @description The user's id
|
|
4380
4442
|
* @default None
|
|
4381
4443
|
*/
|
|
4382
|
-
user_id:
|
|
4444
|
+
user_id: TypeId<"user">;
|
|
4383
4445
|
/**
|
|
4384
4446
|
* User Verification Id
|
|
4385
4447
|
* Format: typeid
|
|
4386
4448
|
*/
|
|
4387
|
-
user_verification_id?:
|
|
4449
|
+
user_verification_id?: TypeId<"user_verification">;
|
|
4388
4450
|
/**
|
|
4389
4451
|
* Verified On
|
|
4390
4452
|
* @description The date the verification was verified
|
|
@@ -4423,12 +4485,12 @@ export interface components {
|
|
|
4423
4485
|
* @description The user's id
|
|
4424
4486
|
* @default None
|
|
4425
4487
|
*/
|
|
4426
|
-
user_id:
|
|
4488
|
+
user_id: TypeId<"user">;
|
|
4427
4489
|
/**
|
|
4428
4490
|
* User Verification Id
|
|
4429
4491
|
* Format: typeid
|
|
4430
4492
|
*/
|
|
4431
|
-
user_verification_id?:
|
|
4493
|
+
user_verification_id?: TypeId<"user_verification">;
|
|
4432
4494
|
/**
|
|
4433
4495
|
* Verified On
|
|
4434
4496
|
* @description The date the verification was verified
|
|
@@ -4467,12 +4529,12 @@ export interface components {
|
|
|
4467
4529
|
* @description The user's id
|
|
4468
4530
|
* @default None
|
|
4469
4531
|
*/
|
|
4470
|
-
user_id:
|
|
4532
|
+
user_id: TypeId<"user">;
|
|
4471
4533
|
/**
|
|
4472
4534
|
* User Verification Id
|
|
4473
4535
|
* Format: typeid
|
|
4474
4536
|
*/
|
|
4475
|
-
user_verification_id?:
|
|
4537
|
+
user_verification_id?: TypeId<"user_verification">;
|
|
4476
4538
|
/**
|
|
4477
4539
|
* Verified On
|
|
4478
4540
|
* @description The date the verification was verified
|
|
@@ -4516,7 +4578,7 @@ export interface components {
|
|
|
4516
4578
|
* @description The user's organization id
|
|
4517
4579
|
* @default None
|
|
4518
4580
|
*/
|
|
4519
|
-
organization_id:
|
|
4581
|
+
organization_id: TypeId<"organization">;
|
|
4520
4582
|
/**
|
|
4521
4583
|
* Phone
|
|
4522
4584
|
* @description The user's phone number
|
|
@@ -4540,7 +4602,7 @@ export interface components {
|
|
|
4540
4602
|
* User Id
|
|
4541
4603
|
* Format: typeid
|
|
4542
4604
|
*/
|
|
4543
|
-
user_id?:
|
|
4605
|
+
user_id?: TypeId<"user">;
|
|
4544
4606
|
/**
|
|
4545
4607
|
* Username
|
|
4546
4608
|
* @description The user's unique username
|
|
@@ -4584,7 +4646,7 @@ export interface components {
|
|
|
4584
4646
|
* @description The user's organization id
|
|
4585
4647
|
* @default None
|
|
4586
4648
|
*/
|
|
4587
|
-
organization_id:
|
|
4649
|
+
organization_id: TypeId<"organization">;
|
|
4588
4650
|
/** Permissions */
|
|
4589
4651
|
permissions?: components["schemas"]["Permission"][] | null;
|
|
4590
4652
|
/**
|
|
@@ -4612,7 +4674,7 @@ export interface components {
|
|
|
4612
4674
|
* User Id
|
|
4613
4675
|
* Format: typeid
|
|
4614
4676
|
*/
|
|
4615
|
-
user_id?:
|
|
4677
|
+
user_id?: TypeId<"user">;
|
|
4616
4678
|
/**
|
|
4617
4679
|
* Username
|
|
4618
4680
|
* @description The user's unique username
|
|
@@ -4777,7 +4839,7 @@ export interface operations {
|
|
|
4777
4839
|
query?: never;
|
|
4778
4840
|
header?: never;
|
|
4779
4841
|
path: {
|
|
4780
|
-
api_key_id:
|
|
4842
|
+
api_key_id: TypeId<"api_key">;
|
|
4781
4843
|
};
|
|
4782
4844
|
cookie?: never;
|
|
4783
4845
|
};
|
|
@@ -5377,7 +5439,7 @@ export interface operations {
|
|
|
5377
5439
|
query?: never;
|
|
5378
5440
|
header?: never;
|
|
5379
5441
|
path: {
|
|
5380
|
-
contact_id:
|
|
5442
|
+
contact_id: TypeId<"contact">;
|
|
5381
5443
|
};
|
|
5382
5444
|
cookie?: never;
|
|
5383
5445
|
};
|
|
@@ -5425,7 +5487,7 @@ export interface operations {
|
|
|
5425
5487
|
query?: never;
|
|
5426
5488
|
header?: never;
|
|
5427
5489
|
path: {
|
|
5428
|
-
contact_id:
|
|
5490
|
+
contact_id: TypeId<"contact">;
|
|
5429
5491
|
};
|
|
5430
5492
|
cookie?: never;
|
|
5431
5493
|
};
|
|
@@ -5514,7 +5576,7 @@ export interface operations {
|
|
|
5514
5576
|
query?: never;
|
|
5515
5577
|
header?: never;
|
|
5516
5578
|
path: {
|
|
5517
|
-
contact_id:
|
|
5579
|
+
contact_id: TypeId<"contact">;
|
|
5518
5580
|
};
|
|
5519
5581
|
cookie?: never;
|
|
5520
5582
|
};
|
|
@@ -5580,7 +5642,7 @@ export interface operations {
|
|
|
5580
5642
|
};
|
|
5581
5643
|
header?: never;
|
|
5582
5644
|
path: {
|
|
5583
|
-
contact_id:
|
|
5645
|
+
contact_id: TypeId<"contact">;
|
|
5584
5646
|
};
|
|
5585
5647
|
cookie?: never;
|
|
5586
5648
|
};
|
|
@@ -5669,7 +5731,7 @@ export interface operations {
|
|
|
5669
5731
|
};
|
|
5670
5732
|
header?: never;
|
|
5671
5733
|
path: {
|
|
5672
|
-
contact_id:
|
|
5734
|
+
contact_id: TypeId<"contact">;
|
|
5673
5735
|
};
|
|
5674
5736
|
cookie?: never;
|
|
5675
5737
|
};
|
|
@@ -5749,7 +5811,7 @@ export interface operations {
|
|
|
5749
5811
|
query?: never;
|
|
5750
5812
|
header?: never;
|
|
5751
5813
|
path: {
|
|
5752
|
-
contact_id:
|
|
5814
|
+
contact_id: TypeId<"contact">;
|
|
5753
5815
|
};
|
|
5754
5816
|
cookie?: never;
|
|
5755
5817
|
};
|
|
@@ -6476,7 +6538,7 @@ export interface operations {
|
|
|
6476
6538
|
query?: never;
|
|
6477
6539
|
header?: never;
|
|
6478
6540
|
path: {
|
|
6479
|
-
domain_reference:
|
|
6541
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6480
6542
|
};
|
|
6481
6543
|
cookie?: never;
|
|
6482
6544
|
};
|
|
@@ -6524,7 +6586,7 @@ export interface operations {
|
|
|
6524
6586
|
query?: never;
|
|
6525
6587
|
header?: never;
|
|
6526
6588
|
path: {
|
|
6527
|
-
domain_reference:
|
|
6589
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6528
6590
|
};
|
|
6529
6591
|
cookie?: never;
|
|
6530
6592
|
};
|
|
@@ -6588,7 +6650,7 @@ export interface operations {
|
|
|
6588
6650
|
query?: never;
|
|
6589
6651
|
header?: never;
|
|
6590
6652
|
path: {
|
|
6591
|
-
domain_reference:
|
|
6653
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6592
6654
|
};
|
|
6593
6655
|
cookie?: never;
|
|
6594
6656
|
};
|
|
@@ -6632,7 +6694,7 @@ export interface operations {
|
|
|
6632
6694
|
query?: never;
|
|
6633
6695
|
header?: never;
|
|
6634
6696
|
path: {
|
|
6635
|
-
domain_reference:
|
|
6697
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6636
6698
|
};
|
|
6637
6699
|
cookie?: never;
|
|
6638
6700
|
};
|
|
@@ -6680,7 +6742,7 @@ export interface operations {
|
|
|
6680
6742
|
query?: never;
|
|
6681
6743
|
header?: never;
|
|
6682
6744
|
path: {
|
|
6683
|
-
domain_reference:
|
|
6745
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6684
6746
|
};
|
|
6685
6747
|
cookie?: never;
|
|
6686
6748
|
};
|
|
@@ -6732,7 +6794,7 @@ export interface operations {
|
|
|
6732
6794
|
query?: never;
|
|
6733
6795
|
header?: never;
|
|
6734
6796
|
path: {
|
|
6735
|
-
domain_reference:
|
|
6797
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6736
6798
|
};
|
|
6737
6799
|
cookie?: never;
|
|
6738
6800
|
};
|
|
@@ -6778,7 +6840,7 @@ export interface operations {
|
|
|
6778
6840
|
query?: never;
|
|
6779
6841
|
header?: never;
|
|
6780
6842
|
path: {
|
|
6781
|
-
domain_reference:
|
|
6843
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6782
6844
|
};
|
|
6783
6845
|
cookie?: never;
|
|
6784
6846
|
};
|
|
@@ -6824,7 +6886,7 @@ export interface operations {
|
|
|
6824
6886
|
query?: never;
|
|
6825
6887
|
header?: never;
|
|
6826
6888
|
path: {
|
|
6827
|
-
domain_reference:
|
|
6889
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6828
6890
|
};
|
|
6829
6891
|
cookie?: never;
|
|
6830
6892
|
};
|
|
@@ -6872,7 +6934,7 @@ export interface operations {
|
|
|
6872
6934
|
query?: never;
|
|
6873
6935
|
header?: never;
|
|
6874
6936
|
path: {
|
|
6875
|
-
domain_reference:
|
|
6937
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6876
6938
|
};
|
|
6877
6939
|
cookie?: never;
|
|
6878
6940
|
};
|
|
@@ -6902,12 +6964,47 @@ export interface operations {
|
|
|
6902
6964
|
};
|
|
6903
6965
|
};
|
|
6904
6966
|
};
|
|
6967
|
+
restore_domain_v1_domains__domain_reference__restore_post: {
|
|
6968
|
+
parameters: {
|
|
6969
|
+
query?: never;
|
|
6970
|
+
header?: never;
|
|
6971
|
+
path: {
|
|
6972
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6973
|
+
};
|
|
6974
|
+
cookie?: never;
|
|
6975
|
+
};
|
|
6976
|
+
requestBody: {
|
|
6977
|
+
content: {
|
|
6978
|
+
"application/json": components["schemas"]["DomainRestoreRequest"];
|
|
6979
|
+
};
|
|
6980
|
+
};
|
|
6981
|
+
responses: {
|
|
6982
|
+
/** @description Successful Response */
|
|
6983
|
+
200: {
|
|
6984
|
+
headers: {
|
|
6985
|
+
[name: string]: unknown;
|
|
6986
|
+
};
|
|
6987
|
+
content: {
|
|
6988
|
+
"application/json": components["schemas"]["DomainRestoreResponse"];
|
|
6989
|
+
};
|
|
6990
|
+
};
|
|
6991
|
+
/** @description Validation Error */
|
|
6992
|
+
422: {
|
|
6993
|
+
headers: {
|
|
6994
|
+
[name: string]: unknown;
|
|
6995
|
+
};
|
|
6996
|
+
content: {
|
|
6997
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
6998
|
+
};
|
|
6999
|
+
};
|
|
7000
|
+
};
|
|
7001
|
+
};
|
|
6905
7002
|
cancel_domain_transfer_v1_domains__domain_reference__transfer_delete: {
|
|
6906
7003
|
parameters: {
|
|
6907
7004
|
query?: never;
|
|
6908
7005
|
header?: never;
|
|
6909
7006
|
path: {
|
|
6910
|
-
domain_reference:
|
|
7007
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6911
7008
|
};
|
|
6912
7009
|
cookie?: never;
|
|
6913
7010
|
};
|
|
@@ -7277,7 +7374,7 @@ export interface operations {
|
|
|
7277
7374
|
query?: never;
|
|
7278
7375
|
header?: never;
|
|
7279
7376
|
path: {
|
|
7280
|
-
event_id:
|
|
7377
|
+
event_id: TypeId<"epp_event">;
|
|
7281
7378
|
};
|
|
7282
7379
|
cookie?: never;
|
|
7283
7380
|
};
|
|
@@ -7341,7 +7438,7 @@ export interface operations {
|
|
|
7341
7438
|
query?: never;
|
|
7342
7439
|
header?: never;
|
|
7343
7440
|
path: {
|
|
7344
|
-
event_id:
|
|
7441
|
+
event_id: TypeId<"epp_event">;
|
|
7345
7442
|
};
|
|
7346
7443
|
cookie?: never;
|
|
7347
7444
|
};
|
|
@@ -7401,7 +7498,7 @@ export interface operations {
|
|
|
7401
7498
|
list_notifications_v1_notifications_get: {
|
|
7402
7499
|
parameters: {
|
|
7403
7500
|
query: {
|
|
7404
|
-
user_id:
|
|
7501
|
+
user_id: TypeId<"user">;
|
|
7405
7502
|
page?: number;
|
|
7406
7503
|
page_size?: number;
|
|
7407
7504
|
};
|
|
@@ -7467,11 +7564,11 @@ export interface operations {
|
|
|
7467
7564
|
get_notification_v1_notifications__notification_id__get: {
|
|
7468
7565
|
parameters: {
|
|
7469
7566
|
query: {
|
|
7470
|
-
user_id:
|
|
7567
|
+
user_id: TypeId<"user">;
|
|
7471
7568
|
};
|
|
7472
7569
|
header?: never;
|
|
7473
7570
|
path: {
|
|
7474
|
-
notification_id:
|
|
7571
|
+
notification_id: TypeId<"notification">;
|
|
7475
7572
|
};
|
|
7476
7573
|
cookie?: never;
|
|
7477
7574
|
};
|
|
@@ -7502,7 +7599,7 @@ export interface operations {
|
|
|
7502
7599
|
query?: never;
|
|
7503
7600
|
header?: never;
|
|
7504
7601
|
path: {
|
|
7505
|
-
notification_id:
|
|
7602
|
+
notification_id: TypeId<"notification">;
|
|
7506
7603
|
};
|
|
7507
7604
|
cookie?: never;
|
|
7508
7605
|
};
|
|
@@ -7537,7 +7634,7 @@ export interface operations {
|
|
|
7537
7634
|
query?: never;
|
|
7538
7635
|
header?: never;
|
|
7539
7636
|
path: {
|
|
7540
|
-
notification_id:
|
|
7637
|
+
notification_id: TypeId<"notification">;
|
|
7541
7638
|
};
|
|
7542
7639
|
cookie?: never;
|
|
7543
7640
|
};
|
|
@@ -7568,7 +7665,7 @@ export interface operations {
|
|
|
7568
7665
|
query?: never;
|
|
7569
7666
|
header?: never;
|
|
7570
7667
|
path: {
|
|
7571
|
-
notification_id:
|
|
7668
|
+
notification_id: TypeId<"notification">;
|
|
7572
7669
|
};
|
|
7573
7670
|
cookie?: never;
|
|
7574
7671
|
};
|
|
@@ -7662,7 +7759,7 @@ export interface operations {
|
|
|
7662
7759
|
get_attributes_v1_organizations_attributes_get: {
|
|
7663
7760
|
parameters: {
|
|
7664
7761
|
query?: {
|
|
7665
|
-
organization_id?:
|
|
7762
|
+
organization_id?: TypeId<"organization"> | null;
|
|
7666
7763
|
/** @description Optional list of attribute keys to filter */
|
|
7667
7764
|
keys?: string[] | null;
|
|
7668
7765
|
};
|
|
@@ -7695,7 +7792,7 @@ export interface operations {
|
|
|
7695
7792
|
update_attributes_v1_organizations_attributes_patch: {
|
|
7696
7793
|
parameters: {
|
|
7697
7794
|
query?: {
|
|
7698
|
-
organization_id?:
|
|
7795
|
+
organization_id?: TypeId<"organization"> | null;
|
|
7699
7796
|
};
|
|
7700
7797
|
header?: never;
|
|
7701
7798
|
path?: never;
|
|
@@ -7735,7 +7832,7 @@ export interface operations {
|
|
|
7735
7832
|
};
|
|
7736
7833
|
header?: never;
|
|
7737
7834
|
path: {
|
|
7738
|
-
organization_id:
|
|
7835
|
+
organization_id: TypeId<"organization"> | null;
|
|
7739
7836
|
};
|
|
7740
7837
|
cookie?: never;
|
|
7741
7838
|
};
|
|
@@ -7766,7 +7863,7 @@ export interface operations {
|
|
|
7766
7863
|
query?: never;
|
|
7767
7864
|
header?: never;
|
|
7768
7865
|
path: {
|
|
7769
|
-
organization_id:
|
|
7866
|
+
organization_id: TypeId<"organization"> | null;
|
|
7770
7867
|
};
|
|
7771
7868
|
cookie?: never;
|
|
7772
7869
|
};
|
|
@@ -8001,7 +8098,7 @@ export interface operations {
|
|
|
8001
8098
|
query?: never;
|
|
8002
8099
|
header?: never;
|
|
8003
8100
|
path: {
|
|
8004
|
-
organization_id:
|
|
8101
|
+
organization_id: TypeId<"organization">;
|
|
8005
8102
|
};
|
|
8006
8103
|
cookie?: never;
|
|
8007
8104
|
};
|
|
@@ -8032,7 +8129,7 @@ export interface operations {
|
|
|
8032
8129
|
query?: never;
|
|
8033
8130
|
header?: never;
|
|
8034
8131
|
path: {
|
|
8035
|
-
organization_id:
|
|
8132
|
+
organization_id: TypeId<"organization">;
|
|
8036
8133
|
};
|
|
8037
8134
|
cookie?: never;
|
|
8038
8135
|
};
|
|
@@ -8061,7 +8158,7 @@ export interface operations {
|
|
|
8061
8158
|
query?: never;
|
|
8062
8159
|
header?: never;
|
|
8063
8160
|
path: {
|
|
8064
|
-
organization_id:
|
|
8161
|
+
organization_id: TypeId<"organization">;
|
|
8065
8162
|
};
|
|
8066
8163
|
cookie?: never;
|
|
8067
8164
|
};
|
|
@@ -8096,7 +8193,7 @@ export interface operations {
|
|
|
8096
8193
|
query?: never;
|
|
8097
8194
|
header?: never;
|
|
8098
8195
|
path: {
|
|
8099
|
-
organization_id:
|
|
8196
|
+
organization_id: TypeId<"organization">;
|
|
8100
8197
|
};
|
|
8101
8198
|
cookie?: never;
|
|
8102
8199
|
};
|
|
@@ -8130,7 +8227,7 @@ export interface operations {
|
|
|
8130
8227
|
};
|
|
8131
8228
|
header?: never;
|
|
8132
8229
|
path: {
|
|
8133
|
-
organization_id:
|
|
8230
|
+
organization_id: TypeId<"organization">;
|
|
8134
8231
|
product_type: components["schemas"]["BillingTransactionProductType"];
|
|
8135
8232
|
};
|
|
8136
8233
|
cookie?: never;
|
|
@@ -8625,7 +8722,7 @@ export interface operations {
|
|
|
8625
8722
|
};
|
|
8626
8723
|
header?: never;
|
|
8627
8724
|
path: {
|
|
8628
|
-
user_id:
|
|
8725
|
+
user_id: TypeId<"user">;
|
|
8629
8726
|
};
|
|
8630
8727
|
cookie?: never;
|
|
8631
8728
|
};
|
|
@@ -8656,7 +8753,7 @@ export interface operations {
|
|
|
8656
8753
|
query?: never;
|
|
8657
8754
|
header?: never;
|
|
8658
8755
|
path: {
|
|
8659
|
-
user_id:
|
|
8756
|
+
user_id: TypeId<"user">;
|
|
8660
8757
|
};
|
|
8661
8758
|
cookie?: never;
|
|
8662
8759
|
};
|
|
@@ -8701,7 +8798,7 @@ export interface operations {
|
|
|
8701
8798
|
query?: never;
|
|
8702
8799
|
header?: never;
|
|
8703
8800
|
path: {
|
|
8704
|
-
user_id:
|
|
8801
|
+
user_id: TypeId<"user">;
|
|
8705
8802
|
};
|
|
8706
8803
|
cookie?: never;
|
|
8707
8804
|
};
|
|
@@ -8736,7 +8833,7 @@ export interface operations {
|
|
|
8736
8833
|
query?: never;
|
|
8737
8834
|
header?: never;
|
|
8738
8835
|
path: {
|
|
8739
|
-
user_id:
|
|
8836
|
+
user_id: TypeId<"user">;
|
|
8740
8837
|
};
|
|
8741
8838
|
cookie?: never;
|
|
8742
8839
|
};
|
|
@@ -8767,7 +8864,7 @@ export interface operations {
|
|
|
8767
8864
|
query?: never;
|
|
8768
8865
|
header?: never;
|
|
8769
8866
|
path: {
|
|
8770
|
-
user_id:
|
|
8867
|
+
user_id: TypeId<"user">;
|
|
8771
8868
|
};
|
|
8772
8869
|
cookie?: never;
|
|
8773
8870
|
};
|
|
@@ -8798,7 +8895,7 @@ export interface operations {
|
|
|
8798
8895
|
query?: never;
|
|
8799
8896
|
header?: never;
|
|
8800
8897
|
path: {
|
|
8801
|
-
user_id:
|
|
8898
|
+
user_id: TypeId<"user">;
|
|
8802
8899
|
};
|
|
8803
8900
|
cookie?: never;
|
|
8804
8901
|
};
|
|
@@ -8833,7 +8930,7 @@ export interface operations {
|
|
|
8833
8930
|
query?: never;
|
|
8834
8931
|
header?: never;
|
|
8835
8932
|
path: {
|
|
8836
|
-
user_id:
|
|
8933
|
+
user_id: TypeId<"user">;
|
|
8837
8934
|
};
|
|
8838
8935
|
cookie?: never;
|
|
8839
8936
|
};
|
|
@@ -8882,7 +8979,7 @@ export interface operations {
|
|
|
8882
8979
|
};
|
|
8883
8980
|
header?: never;
|
|
8884
8981
|
path: {
|
|
8885
|
-
user_id:
|
|
8982
|
+
user_id: TypeId<"user">;
|
|
8886
8983
|
};
|
|
8887
8984
|
cookie?: never;
|
|
8888
8985
|
};
|
|
@@ -8961,7 +9058,7 @@ export interface operations {
|
|
|
8961
9058
|
query?: never;
|
|
8962
9059
|
header?: never;
|
|
8963
9060
|
path: {
|
|
8964
|
-
user_id:
|
|
9061
|
+
user_id: TypeId<"user">;
|
|
8965
9062
|
};
|
|
8966
9063
|
cookie?: never;
|
|
8967
9064
|
};
|
|
@@ -9008,7 +9105,7 @@ export interface operations {
|
|
|
9008
9105
|
};
|
|
9009
9106
|
header?: never;
|
|
9010
9107
|
path: {
|
|
9011
|
-
user_id:
|
|
9108
|
+
user_id: TypeId<"user">;
|
|
9012
9109
|
};
|
|
9013
9110
|
cookie?: never;
|
|
9014
9111
|
};
|