@opusdns/api 0.79.0 → 0.81.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
@@ -848,7 +848,7 @@ export interface paths {
848
848
  * Delete an organization
849
849
  * @description Permanently deletes an organization
850
850
  */
851
- delete: operations["delete_user_v1_organizations__organization_id__delete"];
851
+ delete: operations["delete_organization_v1_organizations__organization_id__delete"];
852
852
  options?: never;
853
853
  head?: never;
854
854
  /**
@@ -858,146 +858,6 @@ export interface paths {
858
858
  patch: operations["update_organization_v1_organizations__organization_id__patch"];
859
859
  trace?: never;
860
860
  };
861
- "/v1/organizations/{organization_id}/billing/checkout-sessions": {
862
- parameters: {
863
- query?: never;
864
- header?: never;
865
- path?: never;
866
- cookie?: never;
867
- };
868
- get?: never;
869
- put?: never;
870
- /**
871
- * Create checkout session
872
- * @description Create a checkout session for the organization
873
- */
874
- post: operations["get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post"];
875
- delete?: never;
876
- options?: never;
877
- head?: never;
878
- patch?: never;
879
- trace?: never;
880
- };
881
- "/v1/organizations/{organization_id}/billing/payment-methods": {
882
- parameters: {
883
- query?: never;
884
- header?: never;
885
- path?: never;
886
- cookie?: never;
887
- };
888
- /**
889
- * List all payment methods
890
- * @description List all available payment methods for the organization
891
- */
892
- get: operations["list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get"];
893
- put?: never;
894
- post?: never;
895
- delete?: never;
896
- options?: never;
897
- head?: never;
898
- patch?: never;
899
- trace?: never;
900
- };
901
- "/v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}": {
902
- parameters: {
903
- query?: never;
904
- header?: never;
905
- path?: never;
906
- cookie?: never;
907
- };
908
- get?: never;
909
- put?: never;
910
- post?: never;
911
- /**
912
- * Delete a payment method
913
- * @description Delete a payment method for the organization
914
- */
915
- delete: operations["delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete"];
916
- options?: never;
917
- head?: never;
918
- patch?: never;
919
- trace?: never;
920
- };
921
- "/v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default": {
922
- parameters: {
923
- query?: never;
924
- header?: never;
925
- path?: never;
926
- cookie?: never;
927
- };
928
- get?: never;
929
- put?: never;
930
- post?: never;
931
- delete?: never;
932
- options?: never;
933
- head?: never;
934
- /**
935
- * Set payment method as default
936
- * @description Set the provided payment method as default for the specified organization
937
- */
938
- patch: operations["update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch"];
939
- trace?: never;
940
- };
941
- "/v1/organizations/{organization_id}/billing/wallet/credits": {
942
- parameters: {
943
- query?: never;
944
- header?: never;
945
- path?: never;
946
- cookie?: never;
947
- };
948
- get?: never;
949
- put?: never;
950
- /**
951
- * Credit wallet
952
- * @description Credit the organization's wallet using the provided amount and payment method
953
- */
954
- post: operations["credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post"];
955
- delete?: never;
956
- options?: never;
957
- head?: never;
958
- patch?: never;
959
- trace?: never;
960
- };
961
- "/v1/organizations/{organization_id}/plan": {
962
- parameters: {
963
- query?: never;
964
- header?: never;
965
- path?: never;
966
- cookie?: never;
967
- };
968
- get?: never;
969
- put?: never;
970
- post?: never;
971
- delete?: never;
972
- options?: never;
973
- head?: never;
974
- /**
975
- * Update organization plan
976
- * @description Changes the plan for an organization
977
- */
978
- patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
979
- trace?: never;
980
- };
981
- "/v1/organizations/{organization_id}/plans": {
982
- parameters: {
983
- query?: never;
984
- header?: never;
985
- path?: never;
986
- cookie?: never;
987
- };
988
- /**
989
- * Get plans for an organization
990
- * @description Retrieves a list of plans for an organization
991
- */
992
- get: operations["get_current_available_plans_v1_organizations__organization_id__plans_get"];
993
- put?: never;
994
- post?: never;
995
- delete?: never;
996
- options?: never;
997
- head?: never;
998
- patch?: never;
999
- trace?: never;
1000
- };
1001
861
  "/v1/organizations/{organization_id}/pricing/product-type/{product_type}": {
1002
862
  parameters: {
1003
863
  query?: never;
@@ -1319,6 +1179,7 @@ export interface components {
1319
1179
  /**
1320
1180
  * Billing Transaction Id
1321
1181
  * Format: typeid
1182
+ * @example billing_transaction_01h45ytscbebyvny4gc8cr8ma2
1322
1183
  */
1323
1184
  billing_transaction_id?: TypeId<"billing_transaction">;
1324
1185
  /**
@@ -1378,16 +1239,6 @@ export interface components {
1378
1239
  * @enum {string}
1379
1240
  */
1380
1241
  BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
1381
- /** CheckoutSessionRequest */
1382
- CheckoutSessionRequest: Record<string, never>;
1383
- /** CheckoutSessionResponse */
1384
- CheckoutSessionResponse: {
1385
- /**
1386
- * Session Client Secret
1387
- * @description Checkout session client secret - meant to be used in the embedded checkout
1388
- */
1389
- session_client_secret: string;
1390
- };
1391
1242
  /**
1392
1243
  * ContactAttributeDefinition
1393
1244
  * @description Definition of a possible attribute for a TLD.
@@ -1465,6 +1316,7 @@ export interface components {
1465
1316
  * Phone
1466
1317
  * Format: phone
1467
1318
  * @description The contact's phone number
1319
+ * @example +1.2125552368
1468
1320
  */
1469
1321
  phone: string;
1470
1322
  /**
@@ -1501,6 +1353,7 @@ export interface components {
1501
1353
  * Contact Id
1502
1354
  * Format: typeid
1503
1355
  * @description The contact id of the contact
1356
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1504
1357
  */
1505
1358
  contact_id: TypeId<"contact">;
1506
1359
  };
@@ -1554,6 +1407,7 @@ export interface components {
1554
1407
  * Phone
1555
1408
  * Format: phone
1556
1409
  * @description The contact's phone number
1410
+ * @example +1.2125552368
1557
1411
  */
1558
1412
  phone: string;
1559
1413
  /**
@@ -1605,6 +1459,7 @@ export interface components {
1605
1459
  /**
1606
1460
  * Contact Id
1607
1461
  * Format: typeid
1462
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1608
1463
  */
1609
1464
  contact_id?: TypeId<"contact">;
1610
1465
  /**
@@ -1659,12 +1514,14 @@ export interface components {
1659
1514
  * Format: typeid
1660
1515
  * @description The organization that owns the domain
1661
1516
  * @default None
1517
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
1662
1518
  */
1663
1519
  organization_id: TypeId<"organization">;
1664
1520
  /**
1665
1521
  * Phone
1666
1522
  * Format: phone
1667
1523
  * @description The contact's phone number
1524
+ * @example +1.2125552368
1668
1525
  */
1669
1526
  phone: string;
1670
1527
  /**
@@ -1705,11 +1562,13 @@ export interface components {
1705
1562
  * Format: typeid
1706
1563
  * @description The contact that is being verified
1707
1564
  * @default None
1565
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1708
1566
  */
1709
1567
  contact_id: TypeId<"contact">;
1710
1568
  /**
1711
1569
  * Contact Verification Id
1712
1570
  * Format: typeid
1571
+ * @example contact_verification_01h45ytscbebyvny4gc8cr8ma2
1713
1572
  */
1714
1573
  contact_verification_id?: TypeId<"contact_verification">;
1715
1574
  /**
@@ -1754,11 +1613,13 @@ export interface components {
1754
1613
  * Format: typeid
1755
1614
  * @description The contact that is being verified
1756
1615
  * @default None
1616
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1757
1617
  */
1758
1618
  contact_id: TypeId<"contact">;
1759
1619
  /**
1760
1620
  * Contact Verification Id
1761
1621
  * Format: typeid
1622
+ * @example contact_verification_01h45ytscbebyvny4gc8cr8ma2
1762
1623
  */
1763
1624
  contact_verification_id?: TypeId<"contact_verification">;
1764
1625
  /**
@@ -1798,11 +1659,13 @@ export interface components {
1798
1659
  * Format: typeid
1799
1660
  * @description The contact that is being verified
1800
1661
  * @default None
1662
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
1801
1663
  */
1802
1664
  contact_id: TypeId<"contact">;
1803
1665
  /**
1804
1666
  * Contact Verification Id
1805
1667
  * Format: typeid
1668
+ * @example contact_verification_01h45ytscbebyvny4gc8cr8ma2
1806
1669
  */
1807
1670
  contact_verification_id?: TypeId<"contact_verification">;
1808
1671
  /**
@@ -1890,44 +1753,6 @@ export interface components {
1890
1753
  * @enum {string}
1891
1754
  */
1892
1755
  Currency: "USD" | "EUR";
1893
- /** CustomerCreditCardPaymentMethod */
1894
- CustomerCreditCardPaymentMethod: {
1895
- /**
1896
- * Brand
1897
- * @description Card brand
1898
- */
1899
- brand: string;
1900
- /**
1901
- * Country
1902
- * @description Country code
1903
- */
1904
- country?: string | null;
1905
- /**
1906
- * Exp Month
1907
- * @description Expiration month
1908
- */
1909
- exp_month: number;
1910
- /**
1911
- * Exp Year
1912
- * @description Expiration year
1913
- */
1914
- exp_year: number;
1915
- /**
1916
- * Id
1917
- * @description Payment method ID
1918
- */
1919
- id: string;
1920
- /**
1921
- * Is Default
1922
- * @description Whether this is the default payment method
1923
- */
1924
- is_default: boolean;
1925
- /**
1926
- * Last4
1927
- * @description Last four digits of the card
1928
- */
1929
- last4: string;
1930
- };
1931
1756
  /**
1932
1757
  * DeletePolicyType
1933
1758
  * @enum {string}
@@ -2194,6 +2019,7 @@ export interface components {
2194
2019
  * Contact Id
2195
2020
  * Format: typeid
2196
2021
  * @description The contact id of the contact
2022
+ * @example contact_01h45ytscbebyvny4gc8cr8ma2
2197
2023
  */
2198
2024
  contact_id: TypeId<"contact">;
2199
2025
  /** @description The type of contact */
@@ -2291,6 +2117,7 @@ export interface components {
2291
2117
  /**
2292
2118
  * Domain Dnssec Data Id
2293
2119
  * Format: typeid
2120
+ * @example domain_dnssec_01h45ytscbebyvny4gc8cr8ma2
2294
2121
  */
2295
2122
  domain_dnssec_data_id?: TypeId<"domain_dnssec">;
2296
2123
  /**
@@ -2298,6 +2125,7 @@ export interface components {
2298
2125
  * Format: typeid
2299
2126
  * @description The domain this DNSSEC record belongs to
2300
2127
  * @default None
2128
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
2301
2129
  */
2302
2130
  domain_id: TypeId<"domain">;
2303
2131
  /**
@@ -2359,6 +2187,8 @@ export interface components {
2359
2187
  /**
2360
2188
  * Grace Period
2361
2189
  * @description Grace period after expiration in ISO 8601 format (e.g., 5D, -7D)
2190
+ * @example P5D
2191
+ * @example P30D
2362
2192
  */
2363
2193
  grace_period?: string | null;
2364
2194
  /**
@@ -2390,11 +2220,20 @@ export interface components {
2390
2220
  };
2391
2221
  /** DomainNameParts */
2392
2222
  DomainNameParts: {
2393
- /** Domain */
2223
+ /**
2224
+ * Domain
2225
+ * @example example
2226
+ */
2394
2227
  domain?: string | null;
2395
- /** Subdomain */
2228
+ /**
2229
+ * Subdomain
2230
+ * @example foo
2231
+ */
2396
2232
  subdomain?: string | null;
2397
- /** Suffix */
2233
+ /**
2234
+ * Suffix
2235
+ * @example com
2236
+ */
2398
2237
  suffix?: string | null;
2399
2238
  };
2400
2239
  /** DomainPeriod */
@@ -2470,6 +2309,7 @@ export interface components {
2470
2309
  /**
2471
2310
  * Domain Id
2472
2311
  * Format: typeid
2312
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
2473
2313
  */
2474
2314
  domain_id?: TypeId<"domain">;
2475
2315
  /**
@@ -2480,6 +2320,7 @@ export interface components {
2480
2320
  /**
2481
2321
  * Name
2482
2322
  * @description The domain name
2323
+ * @example example.com
2483
2324
  */
2484
2325
  name: string;
2485
2326
  /**
@@ -2492,6 +2333,7 @@ export interface components {
2492
2333
  * Format: typeid
2493
2334
  * @description The organization that owns the domain
2494
2335
  * @default None
2336
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
2495
2337
  */
2496
2338
  owner_id: TypeId<"organization">;
2497
2339
  /**
@@ -2503,6 +2345,7 @@ export interface components {
2503
2345
  * Registry Account Id
2504
2346
  * Format: typeid
2505
2347
  * @default None
2348
+ * @example registry_account_01h45ytscbebyvny4gc8cr8ma2
2506
2349
  */
2507
2350
  registry_account_id: TypeId<"registry_account">;
2508
2351
  /**
@@ -2515,16 +2358,19 @@ export interface components {
2515
2358
  /**
2516
2359
  * Roid
2517
2360
  * @description The registry object id of the domain
2361
+ * @example D123456789-EXAMPLE-TEST
2518
2362
  */
2519
2363
  roid: string;
2520
2364
  /**
2521
2365
  * Sld
2522
2366
  * @description The second level domain
2367
+ * @example example
2523
2368
  */
2524
2369
  sld: string;
2525
2370
  /**
2526
2371
  * Tld
2527
2372
  * @description The top level domain of the domain
2373
+ * @example com
2528
2374
  */
2529
2375
  tld: string;
2530
2376
  /**
@@ -2565,6 +2411,7 @@ export interface components {
2565
2411
  * Domain Id
2566
2412
  * Format: typeid
2567
2413
  * @description The ID of the restored domain
2414
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
2568
2415
  */
2569
2416
  domain_id: TypeId<"domain">;
2570
2417
  /**
@@ -2678,6 +2525,7 @@ export interface components {
2678
2525
  * Organization Id
2679
2526
  * Format: typeid
2680
2527
  * @description The organization ID
2528
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
2681
2529
  */
2682
2530
  organization_id: TypeId<"organization">;
2683
2531
  };
@@ -2729,6 +2577,12 @@ export interface components {
2729
2577
  /**
2730
2578
  * Contacts
2731
2579
  * @description The new contacts of the domain
2580
+ * @example {
2581
+ * "admin": "contact_01h45ytscbebyvny4gc8cr8ma2",
2582
+ * "billing": "contact_01h45ytscbebyvny4gc8cr8ma2",
2583
+ * "registrant": "contact_01h45ytscbebyvny4gc8cr8ma2",
2584
+ * "tech": "contact_01h45ytscbebyvny4gc8cr8ma2"
2585
+ * }
2732
2586
  */
2733
2587
  contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
2734
2588
  /**
@@ -2798,6 +2652,7 @@ export interface components {
2798
2652
  /**
2799
2653
  * Event Id
2800
2654
  * Format: typeid
2655
+ * @example epp_event_01h45ytscbebyvny4gc8cr8ma2
2801
2656
  */
2802
2657
  event_id?: TypeId<"epp_event">;
2803
2658
  /**
@@ -2833,6 +2688,7 @@ export interface components {
2833
2688
  /**
2834
2689
  * Event Id
2835
2690
  * Format: typeid
2691
+ * @example epp_event_01h45ytscbebyvny4gc8cr8ma2
2836
2692
  */
2837
2693
  event_id?: TypeId<"epp_event">;
2838
2694
  /**
@@ -2889,16 +2745,6 @@ export interface components {
2889
2745
  */
2890
2746
  start_date: Date;
2891
2747
  };
2892
- /** GetCurrentAvailablePlansResponse */
2893
- GetCurrentAvailablePlansResponse: {
2894
- /** @description Current active plan for the customer */
2895
- current_plan?: components["schemas"]["PlanInfo"] | null;
2896
- /**
2897
- * Plans
2898
- * @description List of available plans
2899
- */
2900
- plans: components["schemas"]["PlanInfo"][];
2901
- };
2902
2748
  /** GetPricesResponse */
2903
2749
  GetPricesResponse: {
2904
2750
  /**
@@ -2947,11 +2793,16 @@ export interface components {
2947
2793
  * Ip Network
2948
2794
  * Format: ipvanynetwork
2949
2795
  * @description IP address or CIDR network range. Individual IPs can be specified without CIDR notation.
2796
+ * @example 192.0.2.1
2797
+ * @example 192.0.2.0/24
2798
+ * @example 2001:db8::1
2799
+ * @example 2001:db8::/32
2950
2800
  */
2951
2801
  ip_network: string;
2952
2802
  /**
2953
2803
  * Organization Id
2954
2804
  * Format: typeid
2805
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
2955
2806
  */
2956
2807
  organization_id?: TypeId<"organization">;
2957
2808
  };
@@ -2966,6 +2817,10 @@ export interface components {
2966
2817
  * Ip Network
2967
2818
  * Format: ipvanynetwork
2968
2819
  * @description IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation.
2820
+ * @example 192.0.2.1/32
2821
+ * @example 192.0.2.0/24
2822
+ * @example 2001:db8::1/128
2823
+ * @example 2001:db8::/32
2969
2824
  */
2970
2825
  ip_network: string;
2971
2826
  /** Ip Restriction Id */
@@ -2975,6 +2830,7 @@ export interface components {
2975
2830
  /**
2976
2831
  * Organization Id
2977
2832
  * Format: typeid
2833
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
2978
2834
  */
2979
2835
  organization_id: TypeId<"organization">;
2980
2836
  };
@@ -2988,6 +2844,10 @@ export interface components {
2988
2844
  /**
2989
2845
  * Ip Network
2990
2846
  * @description IP address or CIDR network range to replace the existing restriction.
2847
+ * @example 192.0.2.1
2848
+ * @example 192.0.2.0/24
2849
+ * @example 2001:db8::1
2850
+ * @example 2001:db8::/32
2991
2851
  */
2992
2852
  ip_network?: string | null;
2993
2853
  /**
@@ -3072,11 +2932,20 @@ export interface components {
3072
2932
  /**
3073
2933
  * Hostname
3074
2934
  * @description The name server of the domain
2935
+ * @example ns1.example.com
3075
2936
  */
3076
2937
  hostname: string;
3077
2938
  /**
3078
2939
  * Ip Addresses
3079
2940
  * @description The ip addresses of the name server
2941
+ * @example [
2942
+ * "0.0.0.0",
2943
+ * "127.0.0.1"
2944
+ * ]
2945
+ * @example [
2946
+ * "2001:db8::1",
2947
+ * "2001:db8::2"
2948
+ * ]
3080
2949
  */
3081
2950
  ip_addresses?: string[];
3082
2951
  };
@@ -3136,6 +3005,7 @@ export interface components {
3136
3005
  * Organization Id
3137
3006
  * Format: typeid
3138
3007
  * @description Unique identifier for the organization.
3008
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3139
3009
  */
3140
3010
  organization_id?: TypeId<"organization">;
3141
3011
  /**
@@ -3503,6 +3373,7 @@ export interface components {
3503
3373
  * Organization Id
3504
3374
  * Format: typeid
3505
3375
  * @description Unique identifier for the organization.
3376
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3506
3377
  */
3507
3378
  organization_id?: TypeId<"organization">;
3508
3379
  /**
@@ -3608,7 +3479,10 @@ export interface components {
3608
3479
  };
3609
3480
  /** PasswordUpdate */
3610
3481
  PasswordUpdate: {
3611
- /** New Password */
3482
+ /**
3483
+ * New Password
3484
+ * @example correcthorsebatterystaple
3485
+ */
3612
3486
  new_password: string;
3613
3487
  };
3614
3488
  /**
@@ -3642,47 +3516,6 @@ export interface components {
3642
3516
  /** Permissions */
3643
3517
  permissions?: components["schemas"]["Permission"][];
3644
3518
  };
3645
- /** PlanIdRequest */
3646
- PlanIdRequest: {
3647
- /**
3648
- * Plan Id
3649
- * @description Plan ID from available plans
3650
- */
3651
- plan_id: string;
3652
- };
3653
- /** PlanInfo */
3654
- PlanInfo: {
3655
- /**
3656
- * Amount
3657
- * @description Base price
3658
- */
3659
- amount: string;
3660
- /**
3661
- * Currency
3662
- * @description Currency code
3663
- */
3664
- currency: string;
3665
- /**
3666
- * Name
3667
- * @description Plan display name
3668
- */
3669
- name?: string | null;
3670
- /**
3671
- * Plan Id
3672
- * @description Unique plan identifier
3673
- */
3674
- plan_id: string;
3675
- /**
3676
- * Plan Level
3677
- * @description Plan level such as 'premium' or 'starter'
3678
- */
3679
- plan_level?: string | null;
3680
- /**
3681
- * Plan Type
3682
- * @description Plan type or billing interval
3683
- */
3684
- plan_type?: string | null;
3685
- };
3686
3519
  /**
3687
3520
  * PostTransferRequirements
3688
3521
  * @enum {string}
@@ -3760,6 +3593,7 @@ export interface components {
3760
3593
  * Client Id
3761
3594
  * Format: typeid
3762
3595
  * @description The organization ID associated with the credentials.
3596
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
3763
3597
  */
3764
3598
  client_id: TypeId<"organization">;
3765
3599
  /**
@@ -3918,8 +3752,17 @@ export interface components {
3918
3752
  };
3919
3753
  /** TldResponseShort */
3920
3754
  TldResponseShort: {
3921
- /** Tld */
3755
+ /**
3756
+ * Tld
3757
+ * @example com
3758
+ * @example org
3759
+ * @example net
3760
+ */
3922
3761
  tld: string;
3762
+ /**
3763
+ * @example gTLD
3764
+ * @example ccTLD
3765
+ */
3923
3766
  type: components["schemas"]["TLDType"];
3924
3767
  };
3925
3768
  /** TldSpecificationResponse */
@@ -4087,18 +3930,23 @@ export interface components {
4087
3930
  * @description The user's last name
4088
3931
  */
4089
3932
  last_name: string;
4090
- /** Locale */
3933
+ /**
3934
+ * Locale
3935
+ * @example en_US
3936
+ */
4091
3937
  locale: string;
4092
3938
  /**
4093
3939
  * Organization Id
4094
3940
  * Format: typeid
4095
3941
  * @description The user's organization id
4096
3942
  * @default None
3943
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
4097
3944
  */
4098
3945
  organization_id: TypeId<"organization">;
4099
3946
  /**
4100
3947
  * Phone
4101
3948
  * @description The user's phone number
3949
+ * @example +1.2125552368
4102
3950
  */
4103
3951
  phone?: string | null;
4104
3952
  readonly status: components["schemas"]["UserStatus"];
@@ -4111,6 +3959,7 @@ export interface components {
4111
3959
  /**
4112
3960
  * User Id
4113
3961
  * Format: typeid
3962
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
4114
3963
  */
4115
3964
  user_id?: TypeId<"user">;
4116
3965
  /**
@@ -4147,16 +3996,21 @@ export interface components {
4147
3996
  * @description The user's last name
4148
3997
  */
4149
3998
  last_name: string;
4150
- /** Locale */
3999
+ /**
4000
+ * Locale
4001
+ * @example en_US
4002
+ */
4151
4003
  locale: string;
4152
4004
  /**
4153
4005
  * Password
4154
4006
  * @description Plaintext password for hashing during creation
4007
+ * @example correcthorsebatterystaple
4155
4008
  */
4156
4009
  password: string;
4157
4010
  /**
4158
4011
  * Phone
4159
4012
  * @description The user's phone number
4013
+ * @example +1.2125552368
4160
4014
  */
4161
4015
  phone?: string | null;
4162
4016
  /**
@@ -4258,18 +4112,23 @@ export interface components {
4258
4112
  * @description The user's last name
4259
4113
  */
4260
4114
  last_name: string;
4261
- /** Locale */
4115
+ /**
4116
+ * Locale
4117
+ * @example en_US
4118
+ */
4262
4119
  locale: string;
4263
4120
  /**
4264
4121
  * Organization Id
4265
4122
  * Format: typeid
4266
4123
  * @description The user's organization id
4267
4124
  * @default None
4125
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
4268
4126
  */
4269
4127
  organization_id: TypeId<"organization">;
4270
4128
  /**
4271
4129
  * Phone
4272
4130
  * @description The user's phone number
4131
+ * @example +1.2125552368
4273
4132
  */
4274
4133
  phone?: string | null;
4275
4134
  readonly status: components["schemas"]["UserStatus"];
@@ -4282,6 +4141,16 @@ export interface components {
4282
4141
  /**
4283
4142
  * User Attributes
4284
4143
  * @description All of the user attributes
4144
+ * @example {
4145
+ * "array": [
4146
+ * 1,
4147
+ * 2,
4148
+ * 3
4149
+ * ],
4150
+ * "bool": true,
4151
+ * "number": 1,
4152
+ * "string": "value2"
4153
+ * }
4285
4154
  */
4286
4155
  user_attributes?: {
4287
4156
  [key: string]: components["schemas"]["JsonValue"];
@@ -4289,6 +4158,7 @@ export interface components {
4289
4158
  /**
4290
4159
  * User Id
4291
4160
  * Format: typeid
4161
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
4292
4162
  */
4293
4163
  user_id?: TypeId<"user">;
4294
4164
  /**
@@ -4326,13 +4196,17 @@ export interface components {
4326
4196
  * @description The user's last name
4327
4197
  */
4328
4198
  last_name: string;
4329
- /** Locale */
4199
+ /**
4200
+ * Locale
4201
+ * @example en_US
4202
+ */
4330
4203
  locale: string;
4331
4204
  /**
4332
4205
  * Organization Id
4333
4206
  * Format: typeid
4334
4207
  * @description The user's organization id
4335
4208
  * @default None
4209
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
4336
4210
  */
4337
4211
  organization_id: TypeId<"organization">;
4338
4212
  /** Permissions */
@@ -4340,6 +4214,7 @@ export interface components {
4340
4214
  /**
4341
4215
  * Phone
4342
4216
  * @description The user's phone number
4217
+ * @example +1.2125552368
4343
4218
  */
4344
4219
  phone?: string | null;
4345
4220
  /** Relations */
@@ -4354,6 +4229,16 @@ export interface components {
4354
4229
  /**
4355
4230
  * User Attributes
4356
4231
  * @description All of the user attributes
4232
+ * @example {
4233
+ * "array": [
4234
+ * 1,
4235
+ * 2,
4236
+ * 3
4237
+ * ],
4238
+ * "bool": true,
4239
+ * "number": 1,
4240
+ * "string": "value2"
4241
+ * }
4357
4242
  */
4358
4243
  user_attributes?: {
4359
4244
  [key: string]: components["schemas"]["JsonValue"];
@@ -4361,6 +4246,7 @@ export interface components {
4361
4246
  /**
4362
4247
  * User Id
4363
4248
  * Format: typeid
4249
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
4364
4250
  */
4365
4251
  user_id?: TypeId<"user">;
4366
4252
  /**
@@ -4383,54 +4269,6 @@ export interface components {
4383
4269
  * @enum {string}
4384
4270
  */
4385
4271
  VerificationType: "api" | "email";
4386
- /** WalletCreditRequest */
4387
- WalletCreditRequest: {
4388
- /**
4389
- * Amount
4390
- * @description Amount to credit the customer wallet
4391
- */
4392
- amount: number | string;
4393
- /**
4394
- * Payment Method Id
4395
- * @description Payment method ID that should be used
4396
- */
4397
- payment_method_id: string;
4398
- };
4399
- /**
4400
- * WalletCreditResponseStatus
4401
- * @enum {string}
4402
- */
4403
- WalletCreditResponseStatus: "success" | "failed" | "pending";
4404
- /** WalletCreditResponseWithBalance */
4405
- WalletCreditResponseWithBalance: {
4406
- /**
4407
- * Amount
4408
- * @description Amount credited to the customer wallet
4409
- */
4410
- amount: string;
4411
- /**
4412
- * Balance
4413
- * @description Updated wallet balance after the credit
4414
- */
4415
- balance: string;
4416
- /**
4417
- * Client Secret
4418
- * @description Client secret for 3DS authentication
4419
- */
4420
- client_secret: string | null;
4421
- /**
4422
- * Credit Id
4423
- * @description Unique identifier of the wallet credit transaction
4424
- */
4425
- credit_id: string;
4426
- /**
4427
- * Message
4428
- * @description Optional human-readable message describing the result
4429
- */
4430
- message?: string | null;
4431
- /** @description Status of the credit operation */
4432
- status: components["schemas"]["WalletCreditResponseStatus"];
4433
- };
4434
4272
  /** WhoisBase */
4435
4273
  WhoisBase: {
4436
4274
  /**
@@ -4457,6 +4295,7 @@ export interface components {
4457
4295
  /**
4458
4296
  * Domain
4459
4297
  * @description The domain name
4298
+ * @example example.com
4460
4299
  */
4461
4300
  domain: string;
4462
4301
  /** Reason */
@@ -7456,7 +7295,7 @@ export interface operations {
7456
7295
  };
7457
7296
  };
7458
7297
  };
7459
- delete_user_v1_organizations__organization_id__delete: {
7298
+ delete_organization_v1_organizations__organization_id__delete: {
7460
7299
  parameters: {
7461
7300
  query?: never;
7462
7301
  header?: never;
@@ -7520,235 +7359,6 @@ export interface operations {
7520
7359
  };
7521
7360
  };
7522
7361
  };
7523
- get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post: {
7524
- parameters: {
7525
- query?: never;
7526
- header?: never;
7527
- path: {
7528
- organization_id: TypeId<"organization">;
7529
- };
7530
- cookie?: never;
7531
- };
7532
- requestBody: {
7533
- content: {
7534
- "application/json": components["schemas"]["CheckoutSessionRequest"];
7535
- };
7536
- };
7537
- responses: {
7538
- /** @description Successful Response */
7539
- 200: {
7540
- headers: {
7541
- [name: string]: unknown;
7542
- };
7543
- content: {
7544
- "application/json": components["schemas"]["CheckoutSessionResponse"];
7545
- };
7546
- };
7547
- /** @description Validation Error */
7548
- 422: {
7549
- headers: {
7550
- [name: string]: unknown;
7551
- };
7552
- content: {
7553
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7554
- };
7555
- };
7556
- };
7557
- };
7558
- list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get: {
7559
- parameters: {
7560
- query?: never;
7561
- header?: never;
7562
- path: {
7563
- organization_id: TypeId<"organization">;
7564
- };
7565
- cookie?: never;
7566
- };
7567
- requestBody?: never;
7568
- responses: {
7569
- /** @description Successful Response */
7570
- 200: {
7571
- headers: {
7572
- [name: string]: unknown;
7573
- };
7574
- content: {
7575
- "application/json": components["schemas"]["CustomerCreditCardPaymentMethod"][];
7576
- };
7577
- };
7578
- /** @description Validation Error */
7579
- 422: {
7580
- headers: {
7581
- [name: string]: unknown;
7582
- };
7583
- content: {
7584
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7585
- };
7586
- };
7587
- };
7588
- };
7589
- delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete: {
7590
- parameters: {
7591
- query?: never;
7592
- header?: never;
7593
- path: {
7594
- payment_method_id: string;
7595
- organization_id: TypeId<"organization">;
7596
- };
7597
- cookie?: never;
7598
- };
7599
- requestBody?: never;
7600
- responses: {
7601
- /** @description Successful Response */
7602
- 204: {
7603
- headers: {
7604
- [name: string]: unknown;
7605
- };
7606
- content?: never;
7607
- };
7608
- /** @description Validation Error */
7609
- 422: {
7610
- headers: {
7611
- [name: string]: unknown;
7612
- };
7613
- content: {
7614
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7615
- };
7616
- };
7617
- };
7618
- };
7619
- update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch: {
7620
- parameters: {
7621
- query?: never;
7622
- header?: never;
7623
- path: {
7624
- payment_method_id: string;
7625
- organization_id: TypeId<"organization">;
7626
- };
7627
- cookie?: never;
7628
- };
7629
- requestBody?: never;
7630
- responses: {
7631
- /** @description Successful Response */
7632
- 200: {
7633
- headers: {
7634
- [name: string]: unknown;
7635
- };
7636
- content: {
7637
- "application/json": components["schemas"]["CustomerCreditCardPaymentMethod"][];
7638
- };
7639
- };
7640
- /** @description Validation Error */
7641
- 422: {
7642
- headers: {
7643
- [name: string]: unknown;
7644
- };
7645
- content: {
7646
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7647
- };
7648
- };
7649
- };
7650
- };
7651
- credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post: {
7652
- parameters: {
7653
- query?: never;
7654
- header?: never;
7655
- path: {
7656
- organization_id: TypeId<"organization">;
7657
- };
7658
- cookie?: never;
7659
- };
7660
- requestBody: {
7661
- content: {
7662
- "application/json": components["schemas"]["WalletCreditRequest"];
7663
- };
7664
- };
7665
- responses: {
7666
- /** @description Successful Response */
7667
- 200: {
7668
- headers: {
7669
- [name: string]: unknown;
7670
- };
7671
- content: {
7672
- "application/json": components["schemas"]["WalletCreditResponseWithBalance"];
7673
- };
7674
- };
7675
- /** @description Validation Error */
7676
- 422: {
7677
- headers: {
7678
- [name: string]: unknown;
7679
- };
7680
- content: {
7681
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7682
- };
7683
- };
7684
- };
7685
- };
7686
- change_plan_v1_organizations__organization_id__plan_patch: {
7687
- parameters: {
7688
- query?: never;
7689
- header?: never;
7690
- path: {
7691
- organization_id: TypeId<"organization">;
7692
- };
7693
- cookie?: never;
7694
- };
7695
- requestBody: {
7696
- content: {
7697
- "application/json": components["schemas"]["PlanIdRequest"];
7698
- };
7699
- };
7700
- responses: {
7701
- /** @description Successful Response */
7702
- 200: {
7703
- headers: {
7704
- [name: string]: unknown;
7705
- };
7706
- content: {
7707
- "application/json": components["schemas"]["OrganizationWithBillingData"];
7708
- };
7709
- };
7710
- /** @description Validation Error */
7711
- 422: {
7712
- headers: {
7713
- [name: string]: unknown;
7714
- };
7715
- content: {
7716
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7717
- };
7718
- };
7719
- };
7720
- };
7721
- get_current_available_plans_v1_organizations__organization_id__plans_get: {
7722
- parameters: {
7723
- query?: never;
7724
- header?: never;
7725
- path: {
7726
- organization_id: TypeId<"organization">;
7727
- };
7728
- cookie?: never;
7729
- };
7730
- requestBody?: never;
7731
- responses: {
7732
- /** @description Successful Response */
7733
- 200: {
7734
- headers: {
7735
- [name: string]: unknown;
7736
- };
7737
- content: {
7738
- "application/json": components["schemas"]["GetCurrentAvailablePlansResponse"];
7739
- };
7740
- };
7741
- /** @description Validation Error */
7742
- 422: {
7743
- headers: {
7744
- [name: string]: unknown;
7745
- };
7746
- content: {
7747
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7748
- };
7749
- };
7750
- };
7751
- };
7752
7362
  get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get: {
7753
7363
  parameters: {
7754
7364
  query?: {