@opusdns/api 0.67.0 → 0.69.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/openapi.yaml CHANGED
@@ -30,6 +30,14 @@ components:
30
30
  - max
31
31
  title: AllowedNumberOfNameserverBase
32
32
  type: object
33
+ AttributeType:
34
+ enum:
35
+ - enum
36
+ - string
37
+ - boolean
38
+ - datetime
39
+ title: AttributeType
40
+ type: string
33
41
  BillingMetadata:
34
42
  properties:
35
43
  billing_model:
@@ -225,6 +233,28 @@ components:
225
233
  - session_client_secret
226
234
  title: CheckoutSessionResponse
227
235
  type: object
236
+ ContactAttributeDefinition:
237
+ description: Definition of a possible attribute for a TLD.
238
+ properties:
239
+ key:
240
+ $ref: '#/components/schemas/RegistryHandleAttributeType'
241
+ description: Unique identifier for the attribute
242
+ type:
243
+ $ref: '#/components/schemas/AttributeType'
244
+ description: Type of the attribute (e.g., 'enum', 'string', 'boolean')
245
+ values:
246
+ anyOf:
247
+ - items:
248
+ type: string
249
+ type: array
250
+ - type: 'null'
251
+ description: Allowed values for enum types
252
+ title: Values
253
+ required:
254
+ - key
255
+ - type
256
+ title: ContactAttributeDefinition
257
+ type: object
228
258
  ContactConfigBase:
229
259
  properties:
230
260
  max:
@@ -458,6 +488,23 @@ components:
458
488
  - disclose
459
489
  title: ContactResponse
460
490
  type: object
491
+ ContactRoleAttributeRequirement:
492
+ description: Attribute requirements for a specific contact role.
493
+ properties:
494
+ attributes:
495
+ description: List of required attribute keys for this role
496
+ items:
497
+ $ref: '#/components/schemas/RegistryHandleAttributeType'
498
+ title: Attributes
499
+ type: array
500
+ role:
501
+ $ref: '#/components/schemas/ContactRoleType'
502
+ description: The role this requirement applies to
503
+ required:
504
+ - role
505
+ - attributes
506
+ title: ContactRoleAttributeRequirement
507
+ type: object
461
508
  ContactRoleType:
462
509
  enum:
463
510
  - registrant
@@ -781,6 +828,12 @@ components:
781
828
  - type: 'null'
782
829
  description: Whether the registry supports thick contacts
783
830
  title: Is Thick
831
+ possible_attributes:
832
+ description: List of possible attributes that can be set for this TLD
833
+ items:
834
+ $ref: '#/components/schemas/ContactAttributeDefinition'
835
+ title: Possible Attributes
836
+ type: array
784
837
  privacy_proxy:
785
838
  anyOf:
786
839
  - type: boolean
@@ -792,6 +845,12 @@ components:
792
845
  - $ref: '#/components/schemas/RegistrantChangeType'
793
846
  - type: 'null'
794
847
  description: Whether the registrant can change through update or trade
848
+ required_attributes:
849
+ description: List of attribute requirements by role
850
+ items:
851
+ $ref: '#/components/schemas/ContactRoleAttributeRequirement'
852
+ title: Required Attributes
853
+ type: array
795
854
  support_check:
796
855
  anyOf:
797
856
  - type: boolean
@@ -4133,6 +4192,17 @@ components:
4133
4192
  - organization
4134
4193
  title: SignupCreate
4135
4194
  type: object
4195
+ SignupResponse:
4196
+ properties:
4197
+ organization:
4198
+ $ref: '#/components/schemas/Organization'
4199
+ user:
4200
+ $ref: '#/components/schemas/User'
4201
+ required:
4202
+ - user
4203
+ - organization
4204
+ title: SignupResponse
4205
+ type: object
4136
4206
  SldLength:
4137
4207
  properties:
4138
4208
  max:
@@ -5126,7 +5196,7 @@ info:
5126
5196
  '
5127
5197
  summary: OpusDNS - your gateway to a seamless domain management experience.
5128
5198
  title: OpusDNS API
5129
- version: 2025-09-29-070341
5199
+ version: 2025-09-29-071158
5130
5200
  x-logo:
5131
5201
  altText: OpusDNS API Reference
5132
5202
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5190,7 +5260,7 @@ paths:
5190
5260
  description: Validation Error
5191
5261
  security:
5192
5262
  - OAuth2PasswordBearer: []
5193
- summary: List Api Keys
5263
+ summary: List all API keys
5194
5264
  tags:
5195
5265
  - authentication
5196
5266
  post:
@@ -5228,7 +5298,7 @@ paths:
5228
5298
  description: Validation Error
5229
5299
  security:
5230
5300
  - OAuth2PasswordBearer: []
5231
- summary: Issue Api Key
5301
+ summary: Issue an API key
5232
5302
  tags:
5233
5303
  - authentication
5234
5304
  /v1/auth/client_credentials/{api_key_id}:
@@ -5283,7 +5353,7 @@ paths:
5283
5353
  description: Validation Error
5284
5354
  security:
5285
5355
  - OAuth2PasswordBearer: []
5286
- summary: Delete Api Key
5356
+ summary: Delete an API key
5287
5357
  tags:
5288
5358
  - authentication
5289
5359
  /v1/auth/logout:
@@ -5323,10 +5393,7 @@ paths:
5323
5393
  content:
5324
5394
  application/json:
5325
5395
  schema:
5326
- anyOf:
5327
- - $ref: '#/components/schemas/OrganizationTokenResponse'
5328
- - $ref: '#/components/schemas/UserTokenResponse'
5329
- title: Response Signup V1 Auth Signup Post
5396
+ $ref: '#/components/schemas/SignupResponse'
5330
5397
  description: Successful Response
5331
5398
  '409':
5332
5399
  content:
@@ -5460,7 +5527,7 @@ paths:
5460
5527
  description: Bad Gateway
5461
5528
  security:
5462
5529
  - OAuth2PasswordBearer: []
5463
- summary: Bulk Availability
5530
+ summary: Check domain availability
5464
5531
  tags:
5465
5532
  - availability
5466
5533
  /v1/availability/stream:
@@ -5541,12 +5608,12 @@ paths:
5541
5608
  description: Bad Gateway
5542
5609
  security:
5543
5610
  - OAuth2PasswordBearer: []
5544
- summary: Stream Availability
5611
+ summary: Stream domain availability results
5545
5612
  tags:
5546
5613
  - availability
5547
5614
  /v1/contacts:
5548
5615
  get:
5549
- description: List all contacts
5616
+ description: Retrieves a paginated list of all contacts
5550
5617
  operationId: get_contacts_v1_contacts_get
5551
5618
  parameters:
5552
5619
  - in: query
@@ -5651,11 +5718,11 @@ paths:
5651
5718
  description: Validation Error
5652
5719
  security:
5653
5720
  - OAuth2PasswordBearer: []
5654
- summary: Get Contacts
5721
+ summary: List all contacts
5655
5722
  tags:
5656
5723
  - contact
5657
5724
  post:
5658
- description: Create a contact
5725
+ description: Create a new contact object to use for domain registration
5659
5726
  operationId: create_contact_v1_contacts_post
5660
5727
  requestBody:
5661
5728
  content:
@@ -5678,12 +5745,11 @@ paths:
5678
5745
  description: Validation Error
5679
5746
  security:
5680
5747
  - OAuth2PasswordBearer: []
5681
- summary: Create Contact
5748
+ summary: Create a contact
5682
5749
  tags:
5683
5750
  - contact
5684
5751
  /v1/contacts/verification:
5685
5752
  get:
5686
- description: Retrieve contact verification
5687
5753
  operationId: get_verification_by_token_v1_contacts_verification_get
5688
5754
  parameters:
5689
5755
  - in: query
@@ -5730,11 +5796,10 @@ paths:
5730
5796
  schema:
5731
5797
  $ref: '#/components/schemas/HTTPValidationError'
5732
5798
  description: Validation Error
5733
- summary: Get Verification By Token
5799
+ summary: Retrieve contact verification by token
5734
5800
  tags:
5735
5801
  - contact
5736
5802
  put:
5737
- description: Complete contact verification
5738
5803
  operationId: update_verification_by_token_v1_contacts_verification_put
5739
5804
  parameters:
5740
5805
  - in: query
@@ -5792,7 +5857,7 @@ paths:
5792
5857
  schema:
5793
5858
  $ref: '#/components/schemas/HTTPValidationError'
5794
5859
  description: Validation Error
5795
- summary: Update Verification By Token
5860
+ summary: Complete contact verification with token
5796
5861
  tags:
5797
5862
  - contact
5798
5863
  /v1/contacts/verify:
@@ -5822,7 +5887,8 @@ paths:
5822
5887
  - contact
5823
5888
  /v1/contacts/{contact_id}:
5824
5889
  delete:
5825
- description: Delete a contact
5890
+ description: Deletes a contact object; only possible if the contact is not in
5891
+ use
5826
5892
  operationId: delete_contact_v1_contacts__contact_id__delete
5827
5893
  parameters:
5828
5894
  - in: path
@@ -5898,11 +5964,11 @@ paths:
5898
5964
  description: Validation Error
5899
5965
  security:
5900
5966
  - OAuth2PasswordBearer: []
5901
- summary: Delete Contact
5967
+ summary: Delete a contact
5902
5968
  tags:
5903
5969
  - contact
5904
5970
  get:
5905
- description: Retrieve a contact
5971
+ description: Retrieves a contact object
5906
5972
  operationId: get_contact_v1_contacts__contact_id__get
5907
5973
  parameters:
5908
5974
  - in: path
@@ -5944,12 +6010,11 @@ paths:
5944
6010
  description: Validation Error
5945
6011
  security:
5946
6012
  - OAuth2PasswordBearer: []
5947
- summary: Get Contact
6013
+ summary: Retrieve a contact
5948
6014
  tags:
5949
6015
  - contact
5950
6016
  /v1/contacts/{contact_id}/verification:
5951
6017
  delete:
5952
- description: Delete contact verification
5953
6018
  operationId: cancel_verification_v1_contacts__contact_id__verification_delete
5954
6019
  parameters:
5955
6020
  - in: path
@@ -5999,11 +6064,10 @@ paths:
5999
6064
  description: Validation Error
6000
6065
  security:
6001
6066
  - OAuth2PasswordBearer: []
6002
- summary: Cancel Verification
6067
+ summary: Delete contact verification
6003
6068
  tags:
6004
6069
  - contact
6005
6070
  get:
6006
- description: Retrieve contact verification
6007
6071
  operationId: get_verification_status_v1_contacts__contact_id__verification_get
6008
6072
  parameters:
6009
6073
  - in: path
@@ -6057,11 +6121,10 @@ paths:
6057
6121
  description: Validation Error
6058
6122
  security:
6059
6123
  - OAuth2PasswordBearer: []
6060
- summary: Get Verification Status
6124
+ summary: Retrieve contact verification by contact ID
6061
6125
  tags:
6062
6126
  - contact
6063
6127
  post:
6064
- description: Start contact verification
6065
6128
  operationId: start_contact_verification_v1_contacts__contact_id__verification_post
6066
6129
  parameters:
6067
6130
  - in: path
@@ -6136,11 +6199,10 @@ paths:
6136
6199
  description: Validation Error
6137
6200
  security:
6138
6201
  - OAuth2PasswordBearer: []
6139
- summary: Start Contact Verification
6202
+ summary: Start contact verification
6140
6203
  tags:
6141
6204
  - contact
6142
6205
  put:
6143
- description: Complete contact verification
6144
6206
  operationId: update_verification_v1_contacts__contact_id__verification_put
6145
6207
  parameters:
6146
6208
  - in: path
@@ -6224,7 +6286,7 @@ paths:
6224
6286
  description: Validation Error
6225
6287
  security:
6226
6288
  - OAuth2PasswordBearer: []
6227
- summary: Update Verification
6289
+ summary: Complete contact verification by contact ID
6228
6290
  tags:
6229
6291
  - contact
6230
6292
  /v1/dns:
@@ -6650,6 +6712,7 @@ paths:
6650
6712
  - dns
6651
6713
  /v1/domain-search/suggest:
6652
6714
  get:
6715
+ description: Get a list of domain suggestions based on a search query
6653
6716
  operationId: suggest_v1_domain_search_suggest_get
6654
6717
  parameters:
6655
6718
  - description: The primary keyword or phrase for the domain search
@@ -6660,11 +6723,7 @@ paths:
6660
6723
  description: The primary keyword or phrase for the domain search
6661
6724
  title: Query
6662
6725
  type: string
6663
- - description: '
6664
-
6665
- Specify one or more TLDs to include in the search.
6666
-
6667
- '
6726
+ - description: The TLDs to include in the search
6668
6727
  examples:
6669
6728
  list:
6670
6729
  summary: A list of TLDs
@@ -6681,11 +6740,7 @@ paths:
6681
6740
  type: string
6682
6741
  type: array
6683
6742
  - type: 'null'
6684
- description: '
6685
-
6686
- Specify one or more TLDs to include in the search.
6687
-
6688
- '
6743
+ description: The TLDs to include in the search
6689
6744
  title: Tlds
6690
6745
  - description: The maximum number of domain suggestions to return
6691
6746
  in: query
@@ -6748,7 +6803,7 @@ paths:
6748
6803
  description: Bad Gateway
6749
6804
  security:
6750
6805
  - OAuth2PasswordBearer: []
6751
- summary: Suggest
6806
+ summary: Suggest domains
6752
6807
  tags:
6753
6808
  - domain_search
6754
6809
  /v1/domains:
@@ -7677,7 +7732,7 @@ paths:
7677
7732
  description: Validation Error
7678
7733
  security:
7679
7734
  - OAuth2PasswordBearer: []
7680
- summary: Restore Domain
7735
+ summary: Restore an eligible domain (during redemption period)
7681
7736
  tags:
7682
7737
  - domain
7683
7738
  /v1/domains/{domain_reference}/transfer:
@@ -8001,6 +8056,7 @@ paths:
8001
8056
  - email_forward
8002
8057
  /v1/events:
8003
8058
  get:
8059
+ description: Retrieves a paginated list of pending events for the organization
8004
8060
  operationId: get_events_v1_events_get
8005
8061
  parameters:
8006
8062
  - in: query
@@ -8047,11 +8103,12 @@ paths:
8047
8103
  description: Validation Error
8048
8104
  security:
8049
8105
  - OAuth2PasswordBearer: []
8050
- summary: Get Events
8106
+ summary: Get pending events
8051
8107
  tags:
8052
8108
  - event
8053
8109
  /v1/events/{event_id}:
8054
8110
  get:
8111
+ description: Get an event by its ID
8055
8112
  operationId: get_event_v1_events__event_id__get
8056
8113
  parameters:
8057
8114
  - in: path
@@ -8105,10 +8162,11 @@ paths:
8105
8162
  description: Validation Error
8106
8163
  security:
8107
8164
  - OAuth2PasswordBearer: []
8108
- summary: Get Event
8165
+ summary: Get event
8109
8166
  tags:
8110
8167
  - event
8111
8168
  patch:
8169
+ description: Acknowledge an event
8112
8170
  operationId: acknowledge_event_v1_events__event_id__patch
8113
8171
  parameters:
8114
8172
  - in: path
@@ -8158,11 +8216,12 @@ paths:
8158
8216
  description: Validation Error
8159
8217
  security:
8160
8218
  - OAuth2PasswordBearer: []
8161
- summary: Acknowledge Event
8219
+ summary: Acknowledge event
8162
8220
  tags:
8163
8221
  - event
8164
8222
  /v1/organizations:
8165
8223
  get:
8224
+ description: Retrieves a paginated list of organizations under the current organization
8166
8225
  operationId: list_organizations_v1_organizations_get
8167
8226
  parameters:
8168
8227
  - in: query
@@ -8197,10 +8256,11 @@ paths:
8197
8256
  description: Validation Error
8198
8257
  security:
8199
8258
  - OAuth2PasswordBearer: []
8200
- summary: List Organizations
8259
+ summary: List all organizations
8201
8260
  tags:
8202
8261
  - organization
8203
8262
  post:
8263
+ description: Create a new organization under the current organization
8204
8264
  operationId: create_organization_v1_organizations_post
8205
8265
  requestBody:
8206
8266
  content:
@@ -8223,11 +8283,12 @@ paths:
8223
8283
  description: Validation Error
8224
8284
  security:
8225
8285
  - OAuth2PasswordBearer: []
8226
- summary: Create Organization
8286
+ summary: Create an organization
8227
8287
  tags:
8228
8288
  - organization
8229
8289
  /v1/organizations/attributes:
8230
8290
  get:
8291
+ description: Retrieves a list of organization attributes for the current organization
8231
8292
  operationId: get_attributes_v1_organizations_attributes_get
8232
8293
  parameters:
8233
8294
  - in: query
@@ -8273,10 +8334,11 @@ paths:
8273
8334
  description: Validation Error
8274
8335
  security:
8275
8336
  - OAuth2PasswordBearer: []
8276
- summary: Get Attributes
8337
+ summary: List organization attributes
8277
8338
  tags:
8278
8339
  - organization
8279
8340
  patch:
8341
+ description: Updates one or more organization attributes for the current organization
8280
8342
  operationId: update_attributes_v1_organizations_attributes_patch
8281
8343
  parameters:
8282
8344
  - in: query
@@ -8319,11 +8381,12 @@ paths:
8319
8381
  description: Validation Error
8320
8382
  security:
8321
8383
  - OAuth2PasswordBearer: []
8322
- summary: Update Attributes
8384
+ summary: Update organization attributes
8323
8385
  tags:
8324
8386
  - organization
8325
8387
  /v1/organizations/attributes/{organization_id}:
8326
8388
  get:
8389
+ description: Retrieves a list of organization attributes for the specified organization
8327
8390
  operationId: get_attributes_v1_organizations_attributes__organization_id__get
8328
8391
  parameters:
8329
8392
  - in: path
@@ -8370,10 +8433,11 @@ paths:
8370
8433
  description: Validation Error
8371
8434
  security:
8372
8435
  - OAuth2PasswordBearer: []
8373
- summary: Get Attributes
8436
+ summary: List organization attributes
8374
8437
  tags:
8375
8438
  - organization
8376
8439
  patch:
8440
+ description: Updates one or more organization attributes for the specified organization
8377
8441
  operationId: update_attributes_v1_organizations_attributes__organization_id__patch
8378
8442
  parameters:
8379
8443
  - in: path
@@ -8417,7 +8481,7 @@ paths:
8417
8481
  description: Validation Error
8418
8482
  security:
8419
8483
  - OAuth2PasswordBearer: []
8420
- summary: Update Attributes
8484
+ summary: Update organization attributes
8421
8485
  tags:
8422
8486
  - organization
8423
8487
  /v1/organizations/ip-restrictions:
@@ -8443,7 +8507,7 @@ paths:
8443
8507
  description: Successful Response
8444
8508
  security:
8445
8509
  - OAuth2PasswordBearer: []
8446
- summary: List Ip Restrictions
8510
+ summary: List IP restrictions
8447
8511
  tags:
8448
8512
  - organization
8449
8513
  post:
@@ -8476,7 +8540,7 @@ paths:
8476
8540
  description: Validation Error
8477
8541
  security:
8478
8542
  - OAuth2PasswordBearer: []
8479
- summary: Create Ip Restriction
8543
+ summary: Create an IP restriction
8480
8544
  tags:
8481
8545
  - organization
8482
8546
  /v1/organizations/ip-restrictions/{ip_restriction_id}:
@@ -8504,7 +8568,7 @@ paths:
8504
8568
  description: Validation Error
8505
8569
  security:
8506
8570
  - OAuth2PasswordBearer: []
8507
- summary: Delete Ip Restriction
8571
+ summary: Delete an IP restriction
8508
8572
  tags:
8509
8573
  - organization
8510
8574
  get:
@@ -8539,7 +8603,7 @@ paths:
8539
8603
  description: Validation Error
8540
8604
  security:
8541
8605
  - OAuth2PasswordBearer: []
8542
- summary: Get Ip Restriction
8606
+ summary: Get an IP restriction
8543
8607
  tags:
8544
8608
  - organization
8545
8609
  patch:
@@ -8579,11 +8643,12 @@ paths:
8579
8643
  description: Validation Error
8580
8644
  security:
8581
8645
  - OAuth2PasswordBearer: []
8582
- summary: Update Ip Restriction
8646
+ summary: Update an IP restriction
8583
8647
  tags:
8584
8648
  - organization
8585
8649
  /v1/organizations/roles:
8586
8650
  get:
8651
+ description: Retrieves a list of roles for the current organization
8587
8652
  operationId: list_roles_v1_organizations_roles_get
8588
8653
  responses:
8589
8654
  '200':
@@ -8593,11 +8658,12 @@ paths:
8593
8658
  description: Successful Response
8594
8659
  security:
8595
8660
  - OAuth2PasswordBearer: []
8596
- summary: List Roles
8661
+ summary: List all roles
8597
8662
  tags:
8598
8663
  - organization
8599
8664
  /v1/organizations/users:
8600
8665
  get:
8666
+ description: Retrieves a paginated list of users under the current organization
8601
8667
  operationId: list_users_v1_organizations_users_get
8602
8668
  parameters:
8603
8669
  - in: query
@@ -8632,11 +8698,12 @@ paths:
8632
8698
  description: Validation Error
8633
8699
  security:
8634
8700
  - OAuth2PasswordBearer: []
8635
- summary: List Users
8701
+ summary: List all users
8636
8702
  tags:
8637
8703
  - organization
8638
8704
  /v1/organizations/{organization_id}:
8639
8705
  delete:
8706
+ description: Permanently deletes an organization
8640
8707
  operationId: delete_user_v1_organizations__organization_id__delete
8641
8708
  parameters:
8642
8709
  - in: path
@@ -8661,10 +8728,11 @@ paths:
8661
8728
  description: Validation Error
8662
8729
  security:
8663
8730
  - OAuth2PasswordBearer: []
8664
- summary: Delete User
8731
+ summary: Delete an organization
8665
8732
  tags:
8666
8733
  - organization
8667
8734
  get:
8735
+ description: Retrieves details for a specific organization
8668
8736
  operationId: get_organization_v1_organizations__organization_id__get
8669
8737
  parameters:
8670
8738
  - in: path
@@ -8693,10 +8761,11 @@ paths:
8693
8761
  description: Validation Error
8694
8762
  security:
8695
8763
  - OAuth2PasswordBearer: []
8696
- summary: Get Organization
8764
+ summary: Get organization details
8697
8765
  tags:
8698
8766
  - organization
8699
8767
  patch:
8768
+ description: Updates details for a specific organization
8700
8769
  operationId: update_organization_v1_organizations__organization_id__patch
8701
8770
  parameters:
8702
8771
  - in: path
@@ -8731,11 +8800,12 @@ paths:
8731
8800
  description: Validation Error
8732
8801
  security:
8733
8802
  - OAuth2PasswordBearer: []
8734
- summary: Update Organization
8803
+ summary: Update an organization
8735
8804
  tags:
8736
8805
  - organization
8737
8806
  /v1/organizations/{organization_id}/billing/checkout-sessions:
8738
8807
  post:
8808
+ description: Create a checkout session for the organization
8739
8809
  operationId: get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post
8740
8810
  parameters:
8741
8811
  - in: path
@@ -8770,12 +8840,13 @@ paths:
8770
8840
  description: Validation Error
8771
8841
  security:
8772
8842
  - OAuth2PasswordBearer: []
8773
- summary: Get Checkout Session
8843
+ summary: Create checkout session
8774
8844
  tags:
8775
8845
  - organization
8776
8846
  - organization
8777
8847
  /v1/organizations/{organization_id}/billing/payment-methods:
8778
8848
  get:
8849
+ description: List all available payment methods for the organization
8779
8850
  operationId: list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get
8780
8851
  parameters:
8781
8852
  - in: path
@@ -8808,12 +8879,13 @@ paths:
8808
8879
  description: Validation Error
8809
8880
  security:
8810
8881
  - OAuth2PasswordBearer: []
8811
- summary: List Payment Methods
8882
+ summary: List all payment methods
8812
8883
  tags:
8813
8884
  - organization
8814
8885
  - organization
8815
8886
  /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}:
8816
8887
  delete:
8888
+ description: Delete a payment method for the organization
8817
8889
  operationId: delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete
8818
8890
  parameters:
8819
8891
  - in: path
@@ -8844,12 +8916,13 @@ paths:
8844
8916
  description: Validation Error
8845
8917
  security:
8846
8918
  - OAuth2PasswordBearer: []
8847
- summary: Delete Payment Method
8919
+ summary: Delete a payment method
8848
8920
  tags:
8849
8921
  - organization
8850
8922
  - organization
8851
8923
  /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default:
8852
8924
  patch:
8925
+ description: Set the provided payment method as default for the specified organization
8853
8926
  operationId: update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch
8854
8927
  parameters:
8855
8928
  - in: path
@@ -8888,12 +8961,14 @@ paths:
8888
8961
  description: Validation Error
8889
8962
  security:
8890
8963
  - OAuth2PasswordBearer: []
8891
- summary: Update Default Payment Method
8964
+ summary: Set payment method as default
8892
8965
  tags:
8893
8966
  - organization
8894
8967
  - organization
8895
8968
  /v1/organizations/{organization_id}/billing/wallet/credits:
8896
8969
  post:
8970
+ description: Credit the organization's wallet using the provided amount and
8971
+ payment method
8897
8972
  operationId: credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post
8898
8973
  parameters:
8899
8974
  - in: path
@@ -8928,12 +9003,13 @@ paths:
8928
9003
  description: Validation Error
8929
9004
  security:
8930
9005
  - OAuth2PasswordBearer: []
8931
- summary: Credit Wallet
9006
+ summary: Credit wallet
8932
9007
  tags:
8933
9008
  - organization
8934
9009
  - organization
8935
9010
  /v1/organizations/{organization_id}/plan:
8936
9011
  patch:
9012
+ description: Changes the plan for an organization
8937
9013
  operationId: change_plan_v1_organizations__organization_id__plan_patch
8938
9014
  parameters:
8939
9015
  - in: path
@@ -8968,11 +9044,12 @@ paths:
8968
9044
  description: Validation Error
8969
9045
  security:
8970
9046
  - OAuth2PasswordBearer: []
8971
- summary: Change Plan
9047
+ summary: Update organization plan
8972
9048
  tags:
8973
9049
  - organization
8974
9050
  /v1/organizations/{organization_id}/plans:
8975
9051
  get:
9052
+ description: Retrieves a list of plans for an organization
8976
9053
  operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
8977
9054
  parameters:
8978
9055
  - in: path
@@ -9001,11 +9078,13 @@ paths:
9001
9078
  description: Validation Error
9002
9079
  security:
9003
9080
  - OAuth2PasswordBearer: []
9004
- summary: Get Current Available Plans
9081
+ summary: Get plans for an organization
9005
9082
  tags:
9006
9083
  - organization
9007
9084
  /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
9008
9085
  get:
9086
+ description: Retrieves pricing data for a specific product type. If a product
9087
+ action/class are specified, only prices for those are returned, if any.
9009
9088
  operationId: get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get
9010
9089
  parameters:
9011
9090
  - in: path
@@ -9055,11 +9134,12 @@ paths:
9055
9134
  description: Validation Error
9056
9135
  security:
9057
9136
  - OAuth2PasswordBearer: []
9058
- summary: Get Pricing Plans
9137
+ summary: List product prices
9059
9138
  tags:
9060
9139
  - organization
9061
9140
  /v1/organizations/{organization_id}/transactions:
9062
9141
  get:
9142
+ description: Retrieves a paginated list of transactions for an organization
9063
9143
  operationId: get_transactions_v1_organizations__organization_id__transactions_get
9064
9144
  parameters:
9065
9145
  - in: path
@@ -9186,11 +9266,12 @@ paths:
9186
9266
  description: Validation Error
9187
9267
  security:
9188
9268
  - OAuth2PasswordBearer: []
9189
- summary: Get transactions for an organization
9269
+ summary: List all transactions
9190
9270
  tags:
9191
9271
  - organization
9192
9272
  /v1/organizations/{organization_id}/transactions/{transaction_id}:
9193
9273
  get:
9274
+ description: Retrieves details for a specific transaction for an organization
9194
9275
  operationId: get_transaction_v1_organizations__organization_id__transactions__transaction_id__get
9195
9276
  parameters:
9196
9277
  - in: path
@@ -9230,11 +9311,12 @@ paths:
9230
9311
  description: Validation Error
9231
9312
  security:
9232
9313
  - OAuth2PasswordBearer: []
9233
- summary: Get a specific transaction for an organization
9314
+ summary: Get a specific transaction
9234
9315
  tags:
9235
9316
  - organization
9236
9317
  /v1/tlds/portfolio:
9237
9318
  get:
9319
+ description: Retrieves a list of TLDs we have support for
9238
9320
  operationId: get_tld_portfolio_v1_tlds_portfolio_get
9239
9321
  responses:
9240
9322
  '200':
@@ -9248,11 +9330,12 @@ paths:
9248
9330
  description: Successful Response
9249
9331
  security:
9250
9332
  - OAuth2PasswordBearer: []
9251
- summary: Get Tld Portfolio
9333
+ summary: Get the list of TLDs we support
9252
9334
  tags:
9253
9335
  - tld
9254
9336
  /v1/tlds/{tld}:
9255
9337
  get:
9338
+ description: Retrieves the TLD specification for a given TLD
9256
9339
  operationId: get_tld_spec_v1_tlds__tld__get
9257
9340
  parameters:
9258
9341
  - in: path
@@ -9288,11 +9371,12 @@ paths:
9288
9371
  description: Validation Error
9289
9372
  security:
9290
9373
  - OAuth2PasswordBearer: []
9291
- summary: Get Tld Spec
9374
+ summary: Get the TLD specification
9292
9375
  tags:
9293
9376
  - tld
9294
9377
  /v1/users:
9295
9378
  post:
9379
+ description: Create a new user
9296
9380
  operationId: create_user_v1_users_post
9297
9381
  requestBody:
9298
9382
  content:
@@ -9315,11 +9399,12 @@ paths:
9315
9399
  description: Validation Error
9316
9400
  security:
9317
9401
  - OAuth2PasswordBearer: []
9318
- summary: Create User
9402
+ summary: Create a user
9319
9403
  tags:
9320
9404
  - user
9321
9405
  /v1/users/me:
9322
9406
  get:
9407
+ description: Get the current user
9323
9408
  operationId: get_current_user_v1_users_me_get
9324
9409
  parameters:
9325
9410
  - in: query
@@ -9347,7 +9432,7 @@ paths:
9347
9432
  description: Validation Error
9348
9433
  security:
9349
9434
  - OAuth2PasswordBearer: []
9350
- summary: Get Current User
9435
+ summary: Get current user
9351
9436
  tags:
9352
9437
  - user
9353
9438
  /v1/users/me/password-reset:
@@ -9387,6 +9472,7 @@ paths:
9387
9472
  - user
9388
9473
  /v1/users/{user_id}:
9389
9474
  delete:
9475
+ description: Delete a user by ID
9390
9476
  operationId: delete_user_v1_users__user_id__delete
9391
9477
  parameters:
9392
9478
  - in: path
@@ -9423,10 +9509,11 @@ paths:
9423
9509
  description: Validation Error
9424
9510
  security:
9425
9511
  - OAuth2PasswordBearer: []
9426
- summary: Delete User
9512
+ summary: Delete a user
9427
9513
  tags:
9428
9514
  - user
9429
9515
  get:
9516
+ description: Get a user by ID
9430
9517
  operationId: get_user_v1_users__user_id__get
9431
9518
  parameters:
9432
9519
  - in: path
@@ -9465,10 +9552,11 @@ paths:
9465
9552
  description: Validation Error
9466
9553
  security:
9467
9554
  - OAuth2PasswordBearer: []
9468
- summary: Get User
9555
+ summary: Get a user
9469
9556
  tags:
9470
9557
  - user
9471
9558
  patch:
9559
+ description: Update a user by ID
9472
9560
  operationId: update_user_v1_users__user_id__patch
9473
9561
  parameters:
9474
9562
  - in: path
@@ -9503,11 +9591,12 @@ paths:
9503
9591
  description: Validation Error
9504
9592
  security:
9505
9593
  - OAuth2PasswordBearer: []
9506
- summary: Update User
9594
+ summary: Update a user
9507
9595
  tags:
9508
9596
  - user
9509
9597
  /v1/users/{user_id}/permissions:
9510
9598
  get:
9599
+ description: Get the permissions for a user
9511
9600
  operationId: get_user_permissions_v1_users__user_id__permissions_get
9512
9601
  parameters:
9513
9602
  - in: path
@@ -9536,11 +9625,12 @@ paths:
9536
9625
  description: Validation Error
9537
9626
  security:
9538
9627
  - OAuth2PasswordBearer: []
9539
- summary: Get User Permissions
9628
+ summary: Get user permissions
9540
9629
  tags:
9541
9630
  - user
9542
9631
  /v1/users/{user_id}/roles:
9543
9632
  get:
9633
+ description: Get the roles for a user
9544
9634
  operationId: list_roles_v1_users__user_id__roles_get
9545
9635
  parameters:
9546
9636
  - in: path
@@ -9569,10 +9659,11 @@ paths:
9569
9659
  description: Validation Error
9570
9660
  security:
9571
9661
  - OAuth2PasswordBearer: []
9572
- summary: List Roles
9662
+ summary: Get user roles
9573
9663
  tags:
9574
9664
  - user
9575
9665
  patch:
9666
+ description: Update the roles for a user
9576
9667
  operationId: update_user_relations_v1_users__user_id__roles_patch
9577
9668
  parameters:
9578
9669
  - in: path
@@ -9607,7 +9698,7 @@ paths:
9607
9698
  description: Validation Error
9608
9699
  security:
9609
9700
  - OAuth2PasswordBearer: []
9610
- summary: Update User Relations
9701
+ summary: Update user roles
9611
9702
  tags:
9612
9703
  - user
9613
9704
  servers: