@opusdns/api 0.78.0 → 0.80.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/src/schema.d.ts CHANGED
@@ -1,74 +1,5 @@
1
1
  import { TypeId } from "typeid-js";
2
2
  export interface paths {
3
- "/v1/auth/client_credentials": {
4
- parameters: {
5
- query?: never;
6
- header?: never;
7
- path?: never;
8
- cookie?: never;
9
- };
10
- /** List all API keys */
11
- get: operations["list_api_keys_v1_auth_client_credentials_get"];
12
- put?: never;
13
- /** Issue an API key */
14
- post: operations["issue_api_key_v1_auth_client_credentials_post"];
15
- delete?: never;
16
- options?: never;
17
- head?: never;
18
- patch?: never;
19
- trace?: never;
20
- };
21
- "/v1/auth/client_credentials/{api_key_id}": {
22
- parameters: {
23
- query?: never;
24
- header?: never;
25
- path?: never;
26
- cookie?: never;
27
- };
28
- get?: never;
29
- put?: never;
30
- post?: never;
31
- /** Delete an API key */
32
- delete: operations["delete_api_key_v1_auth_client_credentials__api_key_id__delete"];
33
- options?: never;
34
- head?: never;
35
- patch?: never;
36
- trace?: never;
37
- };
38
- "/v1/auth/logout": {
39
- parameters: {
40
- query?: never;
41
- header?: never;
42
- path?: never;
43
- cookie?: never;
44
- };
45
- get?: never;
46
- put?: never;
47
- /** Logout */
48
- post: operations["logout_v1_auth_logout_post"];
49
- delete?: never;
50
- options?: never;
51
- head?: never;
52
- patch?: never;
53
- trace?: never;
54
- };
55
- "/v1/auth/signup": {
56
- parameters: {
57
- query?: never;
58
- header?: never;
59
- path?: never;
60
- cookie?: never;
61
- };
62
- get?: never;
63
- put?: never;
64
- /** Signup */
65
- post: operations["signup_v1_auth_signup_post"];
66
- delete?: never;
67
- options?: never;
68
- head?: never;
69
- patch?: never;
70
- trace?: never;
71
- };
72
3
  "/v1/auth/token": {
73
4
  parameters: {
74
5
  query?: never;
@@ -1300,11 +1231,6 @@ export interface paths {
1300
1231
  export type webhooks = Record<string, never>;
1301
1232
  export interface components {
1302
1233
  schemas: {
1303
- /**
1304
- * AgreementType
1305
- * @enum {string}
1306
- */
1307
- AgreementType: "terms_and_conditions" | "master_service_agreement" | "acting_as_trader";
1308
1234
  /**
1309
1235
  * AllocationMethodType
1310
1236
  * @enum {string}
@@ -1393,6 +1319,7 @@ export interface components {
1393
1319
  /**
1394
1320
  * Billing Transaction Id
1395
1321
  * Format: typeid
1322
+ * @example billing_transaction_01h45ytscbebyvny4gc8cr8ma2
1396
1323
  */
1397
1324
  billing_transaction_id?: TypeId<"billing_transaction">;
1398
1325
  /**
@@ -1452,31 +1379,6 @@ export interface components {
1452
1379
  * @enum {string}
1453
1380
  */
1454
1381
  BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
1455
- /** Body_issue_organization_token_v1_auth_token_post */
1456
- Body_issue_organization_token_v1_auth_token_post: {
1457
- /**
1458
- * Client Id
1459
- * @description The organization ID associated with the credentials.
1460
- */
1461
- client_id?: TypeId<"organization"> | null;
1462
- /**
1463
- * Client Secret
1464
- * @description Client secret for authentication.
1465
- */
1466
- client_secret?: string | null;
1467
- /** @description The grant type for the authentication request. */
1468
- grant_type?: components["schemas"]["GrantType"];
1469
- /**
1470
- * Password
1471
- * @description Password for the user.
1472
- */
1473
- password?: string | null;
1474
- /**
1475
- * Username
1476
- * @description Username for authentication.
1477
- */
1478
- username?: string | null;
1479
- };
1480
1382
  /** CheckoutSessionRequest */
1481
1383
  CheckoutSessionRequest: Record<string, never>;
1482
1384
  /** CheckoutSessionResponse */
@@ -1564,6 +1466,7 @@ export interface components {
1564
1466
  * Phone
1565
1467
  * Format: phone
1566
1468
  * @description The contact's phone number
1469
+ * @example +1.2125552368
1567
1470
  */
1568
1471
  phone: string;
1569
1472
  /**
@@ -1600,6 +1503,7 @@ export interface components {
1600
1503
  * Contact Id
1601
1504
  * Format: typeid
1602
1505
  * @description The contact id of the contact
1506
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1603
1507
  */
1604
1508
  contact_id: TypeId<"contact">;
1605
1509
  };
@@ -1653,6 +1557,7 @@ export interface components {
1653
1557
  * Phone
1654
1558
  * Format: phone
1655
1559
  * @description The contact's phone number
1560
+ * @example +1.2125552368
1656
1561
  */
1657
1562
  phone: string;
1658
1563
  /**
@@ -1704,6 +1609,7 @@ export interface components {
1704
1609
  /**
1705
1610
  * Contact Id
1706
1611
  * Format: typeid
1612
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1707
1613
  */
1708
1614
  contact_id?: TypeId<"contact">;
1709
1615
  /**
@@ -1758,12 +1664,14 @@ export interface components {
1758
1664
  * Format: typeid
1759
1665
  * @description The organization that owns the domain
1760
1666
  * @default None
1667
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
1761
1668
  */
1762
1669
  organization_id: TypeId<"organization">;
1763
1670
  /**
1764
1671
  * Phone
1765
1672
  * Format: phone
1766
1673
  * @description The contact's phone number
1674
+ * @example +1.2125552368
1767
1675
  */
1768
1676
  phone: string;
1769
1677
  /**
@@ -1804,11 +1712,13 @@ export interface components {
1804
1712
  * Format: typeid
1805
1713
  * @description The contact that is being verified
1806
1714
  * @default None
1715
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1807
1716
  */
1808
1717
  contact_id: TypeId<"contact">;
1809
1718
  /**
1810
1719
  * Contact Verification Id
1811
1720
  * Format: typeid
1721
+ * @example contact_verification_01h45ytscbebyvny4gc8cr8ma2
1812
1722
  */
1813
1723
  contact_verification_id?: TypeId<"contact_verification">;
1814
1724
  /**
@@ -1853,11 +1763,13 @@ export interface components {
1853
1763
  * Format: typeid
1854
1764
  * @description The contact that is being verified
1855
1765
  * @default None
1766
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1856
1767
  */
1857
1768
  contact_id: TypeId<"contact">;
1858
1769
  /**
1859
1770
  * Contact Verification Id
1860
1771
  * Format: typeid
1772
+ * @example contact_verification_01h45ytscbebyvny4gc8cr8ma2
1861
1773
  */
1862
1774
  contact_verification_id?: TypeId<"contact_verification">;
1863
1775
  /**
@@ -1897,11 +1809,13 @@ export interface components {
1897
1809
  * Format: typeid
1898
1810
  * @description The contact that is being verified
1899
1811
  * @default None
1812
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1900
1813
  */
1901
1814
  contact_id: TypeId<"contact">;
1902
1815
  /**
1903
1816
  * Contact Verification Id
1904
1817
  * Format: typeid
1818
+ * @example contact_verification_01h45ytscbebyvny4gc8cr8ma2
1905
1819
  */
1906
1820
  contact_verification_id?: TypeId<"contact_verification">;
1907
1821
  /**
@@ -2293,6 +2207,7 @@ export interface components {
2293
2207
  * Contact Id
2294
2208
  * Format: typeid
2295
2209
  * @description The contact id of the contact
2210
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
2296
2211
  */
2297
2212
  contact_id: TypeId<"contact">;
2298
2213
  /** @description The type of contact */
@@ -2390,6 +2305,7 @@ export interface components {
2390
2305
  /**
2391
2306
  * Domain Dnssec Data Id
2392
2307
  * Format: typeid
2308
+ * @example domain_dnssec_01h45ytscbebyvny4gc8cr8ma2
2393
2309
  */
2394
2310
  domain_dnssec_data_id?: TypeId<"domain_dnssec">;
2395
2311
  /**
@@ -2397,6 +2313,7 @@ export interface components {
2397
2313
  * Format: typeid
2398
2314
  * @description The domain this DNSSEC record belongs to
2399
2315
  * @default None
2316
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
2400
2317
  */
2401
2318
  domain_id: TypeId<"domain">;
2402
2319
  /**
@@ -2458,6 +2375,8 @@ export interface components {
2458
2375
  /**
2459
2376
  * Grace Period
2460
2377
  * @description Grace period after expiration in ISO 8601 format (e.g., 5D, -7D)
2378
+ * @example P5D
2379
+ * @example P30D
2461
2380
  */
2462
2381
  grace_period?: string | null;
2463
2382
  /**
@@ -2489,11 +2408,20 @@ export interface components {
2489
2408
  };
2490
2409
  /** DomainNameParts */
2491
2410
  DomainNameParts: {
2492
- /** Domain */
2411
+ /**
2412
+ * Domain
2413
+ * @example example
2414
+ */
2493
2415
  domain?: string | null;
2494
- /** Subdomain */
2416
+ /**
2417
+ * Subdomain
2418
+ * @example foo
2419
+ */
2495
2420
  subdomain?: string | null;
2496
- /** Suffix */
2421
+ /**
2422
+ * Suffix
2423
+ * @example com
2424
+ */
2497
2425
  suffix?: string | null;
2498
2426
  };
2499
2427
  /** DomainPeriod */
@@ -2569,6 +2497,7 @@ export interface components {
2569
2497
  /**
2570
2498
  * Domain Id
2571
2499
  * Format: typeid
2500
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
2572
2501
  */
2573
2502
  domain_id?: TypeId<"domain">;
2574
2503
  /**
@@ -2579,6 +2508,7 @@ export interface components {
2579
2508
  /**
2580
2509
  * Name
2581
2510
  * @description The domain name
2511
+ * @example example.com
2582
2512
  */
2583
2513
  name: string;
2584
2514
  /**
@@ -2591,6 +2521,7 @@ export interface components {
2591
2521
  * Format: typeid
2592
2522
  * @description The organization that owns the domain
2593
2523
  * @default None
2524
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
2594
2525
  */
2595
2526
  owner_id: TypeId<"organization">;
2596
2527
  /**
@@ -2602,6 +2533,7 @@ export interface components {
2602
2533
  * Registry Account Id
2603
2534
  * Format: typeid
2604
2535
  * @default None
2536
+ * @example registry_account_01h45ytscbebyvny4gc8cr8ma2
2605
2537
  */
2606
2538
  registry_account_id: TypeId<"registry_account">;
2607
2539
  /**
@@ -2614,16 +2546,19 @@ export interface components {
2614
2546
  /**
2615
2547
  * Roid
2616
2548
  * @description The registry object id of the domain
2549
+ * @example D123456789-EXAMPLE-TEST
2617
2550
  */
2618
2551
  roid: string;
2619
2552
  /**
2620
2553
  * Sld
2621
2554
  * @description The second level domain
2555
+ * @example example
2622
2556
  */
2623
2557
  sld: string;
2624
2558
  /**
2625
2559
  * Tld
2626
2560
  * @description The top level domain of the domain
2561
+ * @example com
2627
2562
  */
2628
2563
  tld: string;
2629
2564
  /**
@@ -2664,6 +2599,7 @@ export interface components {
2664
2599
  * Domain Id
2665
2600
  * Format: typeid
2666
2601
  * @description The ID of the restored domain
2602
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
2667
2603
  */
2668
2604
  domain_id: TypeId<"domain">;
2669
2605
  /**
@@ -2777,6 +2713,7 @@ export interface components {
2777
2713
  * Organization Id
2778
2714
  * Format: typeid
2779
2715
  * @description The organization ID
2716
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
2780
2717
  */
2781
2718
  organization_id: TypeId<"organization">;
2782
2719
  };
@@ -2828,6 +2765,12 @@ export interface components {
2828
2765
  /**
2829
2766
  * Contacts
2830
2767
  * @description The new contacts of the domain
2768
+ * @example {
2769
+ * "admin": "contact_01h45ytscbebyvny4gc8cr8ma2",
2770
+ * "billing": "contact_01h45ytscbebyvny4gc8cr8ma2",
2771
+ * "registrant": "contact_01h45ytscbebyvny4gc8cr8ma2",
2772
+ * "tech": "contact_01h45ytscbebyvny4gc8cr8ma2"
2773
+ * }
2831
2774
  */
2832
2775
  contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
2833
2776
  /**
@@ -2897,6 +2840,7 @@ export interface components {
2897
2840
  /**
2898
2841
  * Event Id
2899
2842
  * Format: typeid
2843
+ * @example epp_event_01h45ytscbebyvny4gc8cr8ma2
2900
2844
  */
2901
2845
  event_id?: TypeId<"epp_event">;
2902
2846
  /**
@@ -2932,6 +2876,7 @@ export interface components {
2932
2876
  /**
2933
2877
  * Event Id
2934
2878
  * Format: typeid
2879
+ * @example epp_event_01h45ytscbebyvny4gc8cr8ma2
2935
2880
  */
2936
2881
  event_id?: TypeId<"epp_event">;
2937
2882
  /**
@@ -3046,11 +2991,16 @@ export interface components {
3046
2991
  * Ip Network
3047
2992
  * Format: ipvanynetwork
3048
2993
  * @description IP address or CIDR network range. Individual IPs can be specified without CIDR notation.
2994
+ * @example 192.0.2.1
2995
+ * @example 192.0.2.0/24
2996
+ * @example 2001:db8::1
2997
+ * @example 2001:db8::/32
3049
2998
  */
3050
2999
  ip_network: string;
3051
3000
  /**
3052
3001
  * Organization Id
3053
3002
  * Format: typeid
3003
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3054
3004
  */
3055
3005
  organization_id?: TypeId<"organization">;
3056
3006
  };
@@ -3065,6 +3015,10 @@ export interface components {
3065
3015
  * Ip Network
3066
3016
  * Format: ipvanynetwork
3067
3017
  * @description IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation.
3018
+ * @example 192.0.2.1/32
3019
+ * @example 192.0.2.0/24
3020
+ * @example 2001:db8::1/128
3021
+ * @example 2001:db8::/32
3068
3022
  */
3069
3023
  ip_network: string;
3070
3024
  /** Ip Restriction Id */
@@ -3074,6 +3028,7 @@ export interface components {
3074
3028
  /**
3075
3029
  * Organization Id
3076
3030
  * Format: typeid
3031
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3077
3032
  */
3078
3033
  organization_id: TypeId<"organization">;
3079
3034
  };
@@ -3087,6 +3042,10 @@ export interface components {
3087
3042
  /**
3088
3043
  * Ip Network
3089
3044
  * @description IP address or CIDR network range to replace the existing restriction.
3045
+ * @example 192.0.2.1
3046
+ * @example 192.0.2.0/24
3047
+ * @example 2001:db8::1
3048
+ * @example 2001:db8::/32
3090
3049
  */
3091
3050
  ip_network?: string | null;
3092
3051
  /**
@@ -3171,11 +3130,20 @@ export interface components {
3171
3130
  /**
3172
3131
  * Hostname
3173
3132
  * @description The name server of the domain
3133
+ * @example ns1.example.com
3174
3134
  */
3175
3135
  hostname: string;
3176
3136
  /**
3177
3137
  * Ip Addresses
3178
3138
  * @description The ip addresses of the name server
3139
+ * @example [
3140
+ * "0.0.0.0",
3141
+ * "127.0.0.1"
3142
+ * ]
3143
+ * @example [
3144
+ * "2001:db8::1",
3145
+ * "2001:db8::2"
3146
+ * ]
3179
3147
  */
3180
3148
  ip_addresses?: string[];
3181
3149
  };
@@ -3235,6 +3203,7 @@ export interface components {
3235
3203
  * Organization Id
3236
3204
  * Format: typeid
3237
3205
  * @description Unique identifier for the organization.
3206
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3238
3207
  */
3239
3208
  organization_id?: TypeId<"organization">;
3240
3209
  /**
@@ -3465,120 +3434,6 @@ export interface components {
3465
3434
  */
3466
3435
  users?: components["schemas"]["UserCreate"][];
3467
3436
  };
3468
- /** OrganizationCredential */
3469
- OrganizationCredential: {
3470
- /**
3471
- * Api Key Description
3472
- * @description Description of the organization credential.
3473
- */
3474
- api_key_description?: string | null;
3475
- /**
3476
- * Api Key Id
3477
- * Format: typeid
3478
- * @description Unique identifier of the organization credential.
3479
- */
3480
- api_key_id: TypeId<"api_key">;
3481
- /**
3482
- * Api Key Name
3483
- * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
3484
- */
3485
- api_key_name?: string | null;
3486
- /**
3487
- * Created On
3488
- * Format: date-time
3489
- * @description The date/time the entry was created on
3490
- */
3491
- created_on?: Date;
3492
- /**
3493
- * Deleted On
3494
- * @description The date/time the entry was deleted on
3495
- */
3496
- deleted_on?: Date | null;
3497
- /**
3498
- * Last Used On
3499
- * @description The date/time the entry was deleted on
3500
- */
3501
- last_used_on?: Date | null;
3502
- /**
3503
- * Organization Id
3504
- * Format: typeid
3505
- * @default None
3506
- */
3507
- organization_id: TypeId<"organization">;
3508
- /** @description The status of the organization credential. */
3509
- readonly status: components["schemas"]["OrganizationCredentialStatus"];
3510
- };
3511
- /** OrganizationCredentialCreated */
3512
- OrganizationCredentialCreated: {
3513
- /**
3514
- * Api Key
3515
- * Format: typeid
3516
- * @description Unique identifier of the organization credential.
3517
- */
3518
- api_key: TypeId<"api_key">;
3519
- /**
3520
- * Api Key Description
3521
- * @description Description of the organization credential.
3522
- */
3523
- api_key_description?: string | null;
3524
- /**
3525
- * Api Key Name
3526
- * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
3527
- */
3528
- api_key_name?: string | null;
3529
- /**
3530
- * Client Id
3531
- * Format: typeid
3532
- * @default None
3533
- */
3534
- client_id: TypeId<"organization">;
3535
- /**
3536
- * Client Secret
3537
- * @description Plaintext secret to be hashed (not stored directly in the DB).
3538
- */
3539
- client_secret?: string | null;
3540
- /**
3541
- * Created On
3542
- * Format: date-time
3543
- * @description The date/time the entry was created on
3544
- */
3545
- created_on?: Date;
3546
- /**
3547
- * Deleted On
3548
- * @description The date/time the entry was deleted on
3549
- */
3550
- deleted_on?: Date | null;
3551
- /**
3552
- * Last Used On
3553
- * @description The date/time the entry was deleted on
3554
- */
3555
- last_used_on?: Date | null;
3556
- /** @description The status of the organization credential. */
3557
- readonly status: components["schemas"]["OrganizationCredentialStatus"];
3558
- };
3559
- /** OrganizationCredentialExtra */
3560
- OrganizationCredentialExtra: {
3561
- /**
3562
- * Api Key Description
3563
- * @description Description of the organization credential.
3564
- */
3565
- api_key_description?: string | null;
3566
- /**
3567
- * Api Key Name
3568
- * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
3569
- */
3570
- api_key_name?: string | null;
3571
- /**
3572
- * Expires At
3573
- * @description The date and time the credential expiration.
3574
- */
3575
- expires_at?: Date | null;
3576
- };
3577
- /**
3578
- * OrganizationCredentialStatus
3579
- * @enum {string}
3580
- */
3581
- OrganizationCredentialStatus: "active" | "revoked";
3582
3437
  /**
3583
3438
  * OrganizationStatus
3584
3439
  * @enum {string}
@@ -3716,6 +3571,7 @@ export interface components {
3716
3571
  * Organization Id
3717
3572
  * Format: typeid
3718
3573
  * @description Unique identifier for the organization.
3574
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3719
3575
  */
3720
3576
  organization_id?: TypeId<"organization">;
3721
3577
  /**
@@ -3807,12 +3663,6 @@ export interface components {
3807
3663
  /** Results */
3808
3664
  results: components["schemas"]["EventResponse"][];
3809
3665
  };
3810
- /** Pagination[OrganizationCredential] */
3811
- Pagination_OrganizationCredential_: {
3812
- pagination: components["schemas"]["PaginationMetadata"];
3813
- /** Results */
3814
- results: components["schemas"]["OrganizationCredential"][];
3815
- };
3816
3666
  /** Pagination[Organization] */
3817
3667
  Pagination_Organization_: {
3818
3668
  pagination: components["schemas"]["PaginationMetadata"];
@@ -3827,7 +3677,10 @@ export interface components {
3827
3677
  };
3828
3678
  /** PasswordUpdate */
3829
3679
  PasswordUpdate: {
3830
- /** New Password */
3680
+ /**
3681
+ * New Password
3682
+ * @example correcthorsebatterystaple
3683
+ */
3831
3684
  new_password: string;
3832
3685
  };
3833
3686
  /**
@@ -3973,6 +3826,26 @@ export interface components {
3973
3826
  /** Problem type */
3974
3827
  type: string;
3975
3828
  };
3829
+ /** PublicAuthRequestForm */
3830
+ PublicAuthRequestForm: {
3831
+ /**
3832
+ * Client Id
3833
+ * Format: typeid
3834
+ * @description The organization ID associated with the credentials.
3835
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3836
+ */
3837
+ client_id: TypeId<"organization">;
3838
+ /**
3839
+ * Client Secret
3840
+ * @description Client secret for authentication.
3841
+ */
3842
+ client_secret: string;
3843
+ /**
3844
+ * Grant Type
3845
+ * @description The grant type for the authentication request (should always be 'client_credentials').
3846
+ */
3847
+ grant_type: string;
3848
+ };
3976
3849
  /** RdapBase */
3977
3850
  RdapBase: {
3978
3851
  /**
@@ -4065,25 +3938,6 @@ export interface components {
4065
3938
  */
4066
3939
  request: boolean;
4067
3940
  };
4068
- /** SignupCreate */
4069
- SignupCreate: {
4070
- /**
4071
- * Agreements
4072
- * @description User agreement acceptances.
4073
- */
4074
- agreements?: components["schemas"]["UserAgreementAcceptance"][] | null;
4075
- /** @description Organization signup. */
4076
- organization: components["schemas"]["OrganizationCreate"];
4077
- /** @description Terms of service acceptance (legacy). */
4078
- terms_of_service?: components["schemas"]["TermsOfServiceAccept"] | null;
4079
- /** @description User signup to platform. */
4080
- user: components["schemas"]["UserCreate"];
4081
- };
4082
- /** SignupResponse */
4083
- SignupResponse: {
4084
- organization: components["schemas"]["Organization"];
4085
- user: components["schemas"]["User"];
4086
- };
4087
3941
  /** SldLength */
4088
3942
  SldLength: {
4089
3943
  /**
@@ -4119,14 +3973,6 @@ export interface components {
4119
3973
  * @enum {string}
4120
3974
  */
4121
3975
  TLDType: "gTLD" | "ccTLD";
4122
- /** TermsOfServiceAccept */
4123
- TermsOfServiceAccept: {
4124
- /**
4125
- * Accepted
4126
- * @description The organization accepts Terms of Service.
4127
- */
4128
- accepted: boolean;
4129
- };
4130
3976
  /** TldBase */
4131
3977
  TldBase: {
4132
3978
  /**
@@ -4145,8 +3991,17 @@ export interface components {
4145
3991
  };
4146
3992
  /** TldResponseShort */
4147
3993
  TldResponseShort: {
4148
- /** Tld */
3994
+ /**
3995
+ * Tld
3996
+ * @example com
3997
+ * @example org
3998
+ * @example net
3999
+ */
4149
4000
  tld: string;
4001
+ /**
4002
+ * @example gTLD
4003
+ * @example ccTLD
4004
+ */
4150
4005
  type: components["schemas"]["TLDType"];
4151
4006
  };
4152
4007
  /** TldSpecificationResponse */
@@ -4314,18 +4169,23 @@ export interface components {
4314
4169
  * @description The user's last name
4315
4170
  */
4316
4171
  last_name: string;
4317
- /** Locale */
4172
+ /**
4173
+ * Locale
4174
+ * @example en_US
4175
+ */
4318
4176
  locale: string;
4319
4177
  /**
4320
4178
  * Organization Id
4321
4179
  * Format: typeid
4322
4180
  * @description The user's organization id
4323
4181
  * @default None
4182
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
4324
4183
  */
4325
4184
  organization_id: TypeId<"organization">;
4326
4185
  /**
4327
4186
  * Phone
4328
4187
  * @description The user's phone number
4188
+ * @example +1.2125552368
4329
4189
  */
4330
4190
  phone?: string | null;
4331
4191
  readonly status: components["schemas"]["UserStatus"];
@@ -4338,6 +4198,7 @@ export interface components {
4338
4198
  /**
4339
4199
  * User Id
4340
4200
  * Format: typeid
4201
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
4341
4202
  */
4342
4203
  user_id?: TypeId<"user">;
4343
4204
  /**
@@ -4346,26 +4207,6 @@ export interface components {
4346
4207
  */
4347
4208
  username: string;
4348
4209
  };
4349
- /** UserAgreementAcceptance */
4350
- UserAgreementAcceptance: {
4351
- /**
4352
- * Accepted
4353
- * @description Whether the agreement has been accepted.
4354
- */
4355
- accepted: boolean;
4356
- /** @description Type of agreement being accepted. */
4357
- type: components["schemas"]["AgreementType"];
4358
- /**
4359
- * Url
4360
- * @description URL where the agreement can be found.
4361
- */
4362
- url?: string | null;
4363
- /**
4364
- * Version
4365
- * @description Version of the agreement being accepted.
4366
- */
4367
- version?: string | null;
4368
- };
4369
4210
  /** UserAttributeBase */
4370
4211
  UserAttributeBase: {
4371
4212
  /**
@@ -4394,16 +4235,21 @@ export interface components {
4394
4235
  * @description The user's last name
4395
4236
  */
4396
4237
  last_name: string;
4397
- /** Locale */
4238
+ /**
4239
+ * Locale
4240
+ * @example en_US
4241
+ */
4398
4242
  locale: string;
4399
4243
  /**
4400
4244
  * Password
4401
4245
  * @description Plaintext password for hashing during creation
4246
+ * @example correcthorsebatterystaple
4402
4247
  */
4403
4248
  password: string;
4404
4249
  /**
4405
4250
  * Phone
4406
4251
  * @description The user's phone number
4252
+ * @example +1.2125552368
4407
4253
  */
4408
4254
  phone?: string | null;
4409
4255
  /**
@@ -4505,18 +4351,23 @@ export interface components {
4505
4351
  * @description The user's last name
4506
4352
  */
4507
4353
  last_name: string;
4508
- /** Locale */
4354
+ /**
4355
+ * Locale
4356
+ * @example en_US
4357
+ */
4509
4358
  locale: string;
4510
4359
  /**
4511
4360
  * Organization Id
4512
4361
  * Format: typeid
4513
4362
  * @description The user's organization id
4514
4363
  * @default None
4364
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
4515
4365
  */
4516
4366
  organization_id: TypeId<"organization">;
4517
4367
  /**
4518
4368
  * Phone
4519
4369
  * @description The user's phone number
4370
+ * @example +1.2125552368
4520
4371
  */
4521
4372
  phone?: string | null;
4522
4373
  readonly status: components["schemas"]["UserStatus"];
@@ -4529,6 +4380,16 @@ export interface components {
4529
4380
  /**
4530
4381
  * User Attributes
4531
4382
  * @description All of the user attributes
4383
+ * @example {
4384
+ * "array": [
4385
+ * 1,
4386
+ * 2,
4387
+ * 3
4388
+ * ],
4389
+ * "bool": true,
4390
+ * "number": 1,
4391
+ * "string": "value2"
4392
+ * }
4532
4393
  */
4533
4394
  user_attributes?: {
4534
4395
  [key: string]: components["schemas"]["JsonValue"];
@@ -4536,6 +4397,7 @@ export interface components {
4536
4397
  /**
4537
4398
  * User Id
4538
4399
  * Format: typeid
4400
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
4539
4401
  */
4540
4402
  user_id?: TypeId<"user">;
4541
4403
  /**
@@ -4573,13 +4435,17 @@ export interface components {
4573
4435
  * @description The user's last name
4574
4436
  */
4575
4437
  last_name: string;
4576
- /** Locale */
4438
+ /**
4439
+ * Locale
4440
+ * @example en_US
4441
+ */
4577
4442
  locale: string;
4578
4443
  /**
4579
4444
  * Organization Id
4580
4445
  * Format: typeid
4581
4446
  * @description The user's organization id
4582
4447
  * @default None
4448
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
4583
4449
  */
4584
4450
  organization_id: TypeId<"organization">;
4585
4451
  /** Permissions */
@@ -4587,6 +4453,7 @@ export interface components {
4587
4453
  /**
4588
4454
  * Phone
4589
4455
  * @description The user's phone number
4456
+ * @example +1.2125552368
4590
4457
  */
4591
4458
  phone?: string | null;
4592
4459
  /** Relations */
@@ -4601,6 +4468,16 @@ export interface components {
4601
4468
  /**
4602
4469
  * User Attributes
4603
4470
  * @description All of the user attributes
4471
+ * @example {
4472
+ * "array": [
4473
+ * 1,
4474
+ * 2,
4475
+ * 3
4476
+ * ],
4477
+ * "bool": true,
4478
+ * "number": 1,
4479
+ * "string": "value2"
4480
+ * }
4604
4481
  */
4605
4482
  user_attributes?: {
4606
4483
  [key: string]: components["schemas"]["JsonValue"];
@@ -4608,6 +4485,7 @@ export interface components {
4608
4485
  /**
4609
4486
  * User Id
4610
4487
  * Format: typeid
4488
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
4611
4489
  */
4612
4490
  user_id?: TypeId<"user">;
4613
4491
  /**
@@ -4704,6 +4582,7 @@ export interface components {
4704
4582
  /**
4705
4583
  * Domain
4706
4584
  * @description The domain name
4585
+ * @example example.com
4707
4586
  */
4708
4587
  domain: string;
4709
4588
  /** Reason */
@@ -4718,267 +4597,6 @@ export interface components {
4718
4597
  }
4719
4598
  export type $defs = Record<string, never>;
4720
4599
  export interface operations {
4721
- list_api_keys_v1_auth_client_credentials_get: {
4722
- parameters: {
4723
- query?: {
4724
- /** @description Optional status to filter the results */
4725
- status?: components["schemas"]["OrganizationCredentialStatus"] | null;
4726
- page?: number;
4727
- page_size?: number;
4728
- };
4729
- header?: never;
4730
- path?: never;
4731
- cookie?: never;
4732
- };
4733
- requestBody?: never;
4734
- responses: {
4735
- /** @description Successful Response */
4736
- 200: {
4737
- headers: {
4738
- [name: string]: unknown;
4739
- };
4740
- content: {
4741
- "application/json": components["schemas"]["Pagination_OrganizationCredential_"];
4742
- };
4743
- };
4744
- /** @description Unauthorized */
4745
- 401: {
4746
- headers: {
4747
- [name: string]: unknown;
4748
- };
4749
- content: {
4750
- /** @example {
4751
- * "code": "ERROR_AUTHENTICATION",
4752
- * "detail": "Additional error context.",
4753
- * "status": 401,
4754
- * "title": "Authentication Error",
4755
- * "type": "authentication"
4756
- * } */
4757
- "application/problem+json": components["schemas"]["Problem"];
4758
- };
4759
- };
4760
- /** @description Validation Error */
4761
- 422: {
4762
- headers: {
4763
- [name: string]: unknown;
4764
- };
4765
- content: {
4766
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4767
- };
4768
- };
4769
- };
4770
- };
4771
- issue_api_key_v1_auth_client_credentials_post: {
4772
- parameters: {
4773
- query?: never;
4774
- header?: never;
4775
- path?: never;
4776
- cookie?: never;
4777
- };
4778
- requestBody: {
4779
- content: {
4780
- "application/json": components["schemas"]["OrganizationCredentialExtra"];
4781
- };
4782
- };
4783
- responses: {
4784
- /** @description Successful Response */
4785
- 200: {
4786
- headers: {
4787
- [name: string]: unknown;
4788
- };
4789
- content: {
4790
- "application/json": components["schemas"]["OrganizationCredentialCreated"];
4791
- };
4792
- };
4793
- /** @description Unauthorized */
4794
- 401: {
4795
- headers: {
4796
- [name: string]: unknown;
4797
- };
4798
- content: {
4799
- /** @example {
4800
- * "code": "ERROR_AUTHENTICATION",
4801
- * "detail": "Additional error context.",
4802
- * "status": 401,
4803
- * "title": "Authentication Error",
4804
- * "type": "authentication"
4805
- * } */
4806
- "application/problem+json": components["schemas"]["Problem"];
4807
- };
4808
- };
4809
- /** @description Validation Error */
4810
- 422: {
4811
- headers: {
4812
- [name: string]: unknown;
4813
- };
4814
- content: {
4815
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4816
- };
4817
- };
4818
- };
4819
- };
4820
- delete_api_key_v1_auth_client_credentials__api_key_id__delete: {
4821
- parameters: {
4822
- query?: never;
4823
- header?: never;
4824
- path: {
4825
- api_key_id: TypeId<"api_key">;
4826
- };
4827
- cookie?: never;
4828
- };
4829
- requestBody?: never;
4830
- responses: {
4831
- /** @description Successful Response */
4832
- 204: {
4833
- headers: {
4834
- [name: string]: unknown;
4835
- };
4836
- content?: never;
4837
- };
4838
- /** @description Unauthorized */
4839
- 401: {
4840
- headers: {
4841
- [name: string]: unknown;
4842
- };
4843
- content: {
4844
- /** @example {
4845
- * "code": "ERROR_AUTHENTICATION",
4846
- * "detail": "Additional error context.",
4847
- * "status": 401,
4848
- * "title": "Authentication Error",
4849
- * "type": "authentication"
4850
- * } */
4851
- "application/problem+json": components["schemas"]["Problem"];
4852
- };
4853
- };
4854
- /** @description Not Found */
4855
- 404: {
4856
- headers: {
4857
- [name: string]: unknown;
4858
- };
4859
- content: {
4860
- /** @example {
4861
- * "code": "ERROR_ORGANIZATION_CREDENTIAL_NOT_FOUND",
4862
- * "credential_id": "Additional error context.",
4863
- * "detail": "Organization credential with ID Additional error context. not found",
4864
- * "status": 404,
4865
- * "title": "Organization Management Error",
4866
- * "type": "organization-credential-not-found"
4867
- * } */
4868
- "application/problem+json": components["schemas"]["Problem"];
4869
- };
4870
- };
4871
- /** @description Validation Error */
4872
- 422: {
4873
- headers: {
4874
- [name: string]: unknown;
4875
- };
4876
- content: {
4877
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4878
- };
4879
- };
4880
- };
4881
- };
4882
- logout_v1_auth_logout_post: {
4883
- parameters: {
4884
- query?: never;
4885
- header?: never;
4886
- path?: never;
4887
- cookie?: never;
4888
- };
4889
- requestBody?: never;
4890
- responses: {
4891
- /** @description Successful Response */
4892
- 204: {
4893
- headers: {
4894
- [name: string]: unknown;
4895
- };
4896
- content?: never;
4897
- };
4898
- /** @description Unauthorized */
4899
- 401: {
4900
- headers: {
4901
- [name: string]: unknown;
4902
- };
4903
- content: {
4904
- /** @example {
4905
- * "code": "ERROR_AUTHENTICATION",
4906
- * "detail": "Additional error context.",
4907
- * "status": 401,
4908
- * "title": "Authentication Error",
4909
- * "type": "authentication"
4910
- * } */
4911
- "application/problem+json": components["schemas"]["Problem"];
4912
- };
4913
- };
4914
- };
4915
- };
4916
- signup_v1_auth_signup_post: {
4917
- parameters: {
4918
- query?: never;
4919
- header?: never;
4920
- path?: never;
4921
- cookie?: never;
4922
- };
4923
- requestBody: {
4924
- content: {
4925
- "application/json": components["schemas"]["SignupCreate"];
4926
- };
4927
- };
4928
- responses: {
4929
- /** @description Successful Response */
4930
- 200: {
4931
- headers: {
4932
- [name: string]: unknown;
4933
- };
4934
- content: {
4935
- "application/json": components["schemas"]["SignupResponse"];
4936
- };
4937
- };
4938
- /** @description Forbidden */
4939
- 403: {
4940
- headers: {
4941
- [name: string]: unknown;
4942
- };
4943
- content: {
4944
- /** @example {
4945
- * "code": "ERROR_SIGNUP_NOT_ALLOWED",
4946
- * "detail": "Additional error context.",
4947
- * "status": 403,
4948
- * "title": "Organization Management Error",
4949
- * "type": "signup-not-allowed"
4950
- * } */
4951
- "application/problem+json": components["schemas"]["Problem"];
4952
- };
4953
- };
4954
- /** @description Conflict */
4955
- 409: {
4956
- headers: {
4957
- [name: string]: unknown;
4958
- };
4959
- content: {
4960
- /** @example {
4961
- * "code": "ERROR_USER_EXISTS",
4962
- * "detail": "User with username or email already exists",
4963
- * "status": 409,
4964
- * "title": "User Management Error",
4965
- * "type": "user-already-present",
4966
- * "user": "Additional error context."
4967
- * } */
4968
- "application/problem+json": components["schemas"]["Problem"];
4969
- };
4970
- };
4971
- /** @description Validation Error */
4972
- 422: {
4973
- headers: {
4974
- [name: string]: unknown;
4975
- };
4976
- content: {
4977
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4978
- };
4979
- };
4980
- };
4981
- };
4982
4600
  issue_organization_token_v1_auth_token_post: {
4983
4601
  parameters: {
4984
4602
  query?: never;
@@ -4988,7 +4606,7 @@ export interface operations {
4988
4606
  };
4989
4607
  requestBody?: {
4990
4608
  content: {
4991
- "application/x-www-form-urlencoded": components["schemas"]["Body_issue_organization_token_v1_auth_token_post"];
4609
+ "application/x-www-form-urlencoded": components["schemas"]["PublicAuthRequestForm"];
4992
4610
  };
4993
4611
  };
4994
4612
  responses: {