@opusdns/api 0.80.0 → 0.82.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
@@ -192,21 +192,6 @@ components:
192
192
  - canceled
193
193
  title: BillingTransactionStatus
194
194
  type: string
195
- CheckoutSessionRequest:
196
- properties: {}
197
- title: CheckoutSessionRequest
198
- type: object
199
- CheckoutSessionResponse:
200
- properties:
201
- session_client_secret:
202
- description: Checkout session client secret - meant to be used in the embedded
203
- checkout
204
- title: Session Client Secret
205
- type: string
206
- required:
207
- - session_client_secret
208
- title: CheckoutSessionResponse
209
- type: object
210
195
  ContactAttributeDefinition:
211
196
  description: Definition of a possible attribute for a TLD.
212
197
  properties:
@@ -867,47 +852,6 @@ components:
867
852
  - EUR
868
853
  title: Currency
869
854
  type: string
870
- CustomerCreditCardPaymentMethod:
871
- properties:
872
- brand:
873
- description: Card brand
874
- title: Brand
875
- type: string
876
- country:
877
- anyOf:
878
- - type: string
879
- - type: 'null'
880
- description: Country code
881
- title: Country
882
- exp_month:
883
- description: Expiration month
884
- title: Exp Month
885
- type: integer
886
- exp_year:
887
- description: Expiration year
888
- title: Exp Year
889
- type: integer
890
- id:
891
- description: Payment method ID
892
- title: Id
893
- type: string
894
- is_default:
895
- description: Whether this is the default payment method
896
- title: Is Default
897
- type: boolean
898
- last4:
899
- description: Last four digits of the card
900
- title: Last4
901
- type: string
902
- required:
903
- - id
904
- - brand
905
- - last4
906
- - exp_month
907
- - exp_year
908
- - is_default
909
- title: CustomerCreditCardPaymentMethod
910
- type: object
911
855
  DeletePolicyType:
912
856
  enum:
913
857
  - immediate
@@ -2468,23 +2412,6 @@ components:
2468
2412
  - start_date
2469
2413
  title: GeneralAvailabilityBase
2470
2414
  type: object
2471
- GetCurrentAvailablePlansResponse:
2472
- properties:
2473
- current_plan:
2474
- anyOf:
2475
- - $ref: '#/components/schemas/PlanInfo'
2476
- - type: 'null'
2477
- description: Current active plan for the customer
2478
- plans:
2479
- description: List of available plans
2480
- items:
2481
- $ref: '#/components/schemas/PlanInfo'
2482
- title: Plans
2483
- type: array
2484
- required:
2485
- - plans
2486
- title: GetCurrentAvailablePlansResponse
2487
- type: object
2488
2415
  GetPricesResponse:
2489
2416
  properties:
2490
2417
  prices:
@@ -3676,54 +3603,6 @@ components:
3676
3603
  type: array
3677
3604
  title: PermissionSet
3678
3605
  type: object
3679
- PlanIdRequest:
3680
- properties:
3681
- plan_id:
3682
- description: Plan ID from available plans
3683
- title: Plan Id
3684
- type: string
3685
- required:
3686
- - plan_id
3687
- title: PlanIdRequest
3688
- type: object
3689
- PlanInfo:
3690
- properties:
3691
- amount:
3692
- description: Base price
3693
- title: Amount
3694
- type: string
3695
- currency:
3696
- description: Currency code
3697
- title: Currency
3698
- type: string
3699
- name:
3700
- anyOf:
3701
- - type: string
3702
- - type: 'null'
3703
- description: Plan display name
3704
- title: Name
3705
- plan_id:
3706
- description: Unique plan identifier
3707
- title: Plan Id
3708
- type: string
3709
- plan_level:
3710
- anyOf:
3711
- - type: string
3712
- - type: 'null'
3713
- description: Plan level such as 'premium' or 'starter'
3714
- title: Plan Level
3715
- plan_type:
3716
- anyOf:
3717
- - type: string
3718
- - type: 'null'
3719
- description: Plan type or billing interval
3720
- title: Plan Type
3721
- required:
3722
- - plan_id
3723
- - currency
3724
- - amount
3725
- title: PlanInfo
3726
- type: object
3727
3606
  PostTransferRequirements:
3728
3607
  enum:
3729
3608
  - update_contacts
@@ -4398,7 +4277,9 @@ components:
4398
4277
  x-typeid-prefix: user
4399
4278
  username:
4400
4279
  description: The user's unique username
4401
- minLength: 1
4280
+ maxLength: 128
4281
+ minLength: 3
4282
+ pattern: ^[a-zA-Z0-9\-+_@.]+$
4402
4283
  title: Username
4403
4284
  type: string
4404
4285
  required:
@@ -4473,7 +4354,9 @@ components:
4473
4354
  title: User Attributes
4474
4355
  username:
4475
4356
  description: The user's unique username
4476
- minLength: 1
4357
+ maxLength: 128
4358
+ minLength: 3
4359
+ pattern: ^[a-zA-Z0-9\-+_@.]+$
4477
4360
  title: Username
4478
4361
  type: string
4479
4362
  required:
@@ -4656,7 +4539,9 @@ components:
4656
4539
  x-typeid-prefix: user
4657
4540
  username:
4658
4541
  description: The user's unique username
4659
- minLength: 1
4542
+ maxLength: 128
4543
+ minLength: 3
4544
+ pattern: ^[a-zA-Z0-9\-+_@.]+$
4660
4545
  title: Username
4661
4546
  type: string
4662
4547
  required:
@@ -4767,7 +4652,9 @@ components:
4767
4652
  x-typeid-prefix: user
4768
4653
  username:
4769
4654
  description: The user's unique username
4770
- minLength: 1
4655
+ maxLength: 128
4656
+ minLength: 3
4657
+ pattern: ^[a-zA-Z0-9\-+_@.]+$
4771
4658
  title: Username
4772
4659
  type: string
4773
4660
  required:
@@ -4806,67 +4693,6 @@ components:
4806
4693
  - email
4807
4694
  title: VerificationType
4808
4695
  type: string
4809
- WalletCreditRequest:
4810
- properties:
4811
- amount:
4812
- anyOf:
4813
- - type: number
4814
- - type: string
4815
- description: Amount to credit the customer wallet
4816
- title: Amount
4817
- payment_method_id:
4818
- description: Payment method ID that should be used
4819
- title: Payment Method Id
4820
- type: string
4821
- required:
4822
- - amount
4823
- - payment_method_id
4824
- title: WalletCreditRequest
4825
- type: object
4826
- WalletCreditResponseStatus:
4827
- enum:
4828
- - success
4829
- - failed
4830
- - pending
4831
- title: WalletCreditResponseStatus
4832
- type: string
4833
- WalletCreditResponseWithBalance:
4834
- properties:
4835
- amount:
4836
- description: Amount credited to the customer wallet
4837
- title: Amount
4838
- type: string
4839
- balance:
4840
- description: Updated wallet balance after the credit
4841
- title: Balance
4842
- type: string
4843
- client_secret:
4844
- anyOf:
4845
- - type: string
4846
- - type: 'null'
4847
- description: Client secret for 3DS authentication
4848
- title: Client Secret
4849
- credit_id:
4850
- description: Unique identifier of the wallet credit transaction
4851
- title: Credit Id
4852
- type: string
4853
- message:
4854
- anyOf:
4855
- - type: string
4856
- - type: 'null'
4857
- description: Optional human-readable message describing the result
4858
- title: Message
4859
- status:
4860
- $ref: '#/components/schemas/WalletCreditResponseStatus'
4861
- description: Status of the credit operation
4862
- required:
4863
- - credit_id
4864
- - amount
4865
- - status
4866
- - client_secret
4867
- - balance
4868
- title: WalletCreditResponseWithBalance
4869
- type: object
4870
4696
  WhoisBase:
4871
4697
  properties:
4872
4698
  whois_server:
@@ -4971,7 +4797,7 @@ info:
4971
4797
  '
4972
4798
  summary: OpusDNS - your gateway to a seamless domain management experience.
4973
4799
  title: OpusDNS API
4974
- version: 2025-10-02-195210
4800
+ version: 2025-10-10-154932
4975
4801
  x-logo:
4976
4802
  altText: OpusDNS API Reference
4977
4803
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7822,6 +7648,30 @@ paths:
7822
7648
  schema:
7823
7649
  $ref: '#/components/schemas/Pagination_Organization_'
7824
7650
  description: Successful Response
7651
+ '401':
7652
+ content:
7653
+ application/problem+json:
7654
+ example:
7655
+ code: ERROR_AUTHENTICATION
7656
+ detail: Additional error context.
7657
+ status: 401
7658
+ title: Authentication Error
7659
+ type: authentication
7660
+ schema:
7661
+ $ref: '#/components/schemas/Problem'
7662
+ description: Unauthorized
7663
+ '403':
7664
+ content:
7665
+ application/problem+json:
7666
+ example:
7667
+ code: ERROR_PERMISSION_DENIED
7668
+ detail: Insufficient permissions to perform this action
7669
+ status: 403
7670
+ title: Permission Denied
7671
+ type: permission-denied
7672
+ schema:
7673
+ $ref: '#/components/schemas/Problem'
7674
+ description: Forbidden
7825
7675
  '422':
7826
7676
  content:
7827
7677
  application/problem+json:
@@ -7849,6 +7699,30 @@ paths:
7849
7699
  schema:
7850
7700
  $ref: '#/components/schemas/Organization'
7851
7701
  description: Successful Response
7702
+ '401':
7703
+ content:
7704
+ application/problem+json:
7705
+ example:
7706
+ code: ERROR_AUTHENTICATION
7707
+ detail: Additional error context.
7708
+ status: 401
7709
+ title: Authentication Error
7710
+ type: authentication
7711
+ schema:
7712
+ $ref: '#/components/schemas/Problem'
7713
+ description: Unauthorized
7714
+ '403':
7715
+ content:
7716
+ application/problem+json:
7717
+ example:
7718
+ code: ERROR_PERMISSION_DENIED
7719
+ detail: Insufficient permissions to perform this action
7720
+ status: 403
7721
+ title: Permission Denied
7722
+ type: permission-denied
7723
+ schema:
7724
+ $ref: '#/components/schemas/Problem'
7725
+ description: Forbidden
7852
7726
  '422':
7853
7727
  content:
7854
7728
  application/problem+json:
@@ -7900,6 +7774,30 @@ paths:
7900
7774
  title: Response Get Attributes V1 Organizations Attributes Get
7901
7775
  type: array
7902
7776
  description: Successful Response
7777
+ '401':
7778
+ content:
7779
+ application/problem+json:
7780
+ example:
7781
+ code: ERROR_AUTHENTICATION
7782
+ detail: Additional error context.
7783
+ status: 401
7784
+ title: Authentication Error
7785
+ type: authentication
7786
+ schema:
7787
+ $ref: '#/components/schemas/Problem'
7788
+ description: Unauthorized
7789
+ '403':
7790
+ content:
7791
+ application/problem+json:
7792
+ example:
7793
+ code: ERROR_PERMISSION_DENIED
7794
+ detail: Insufficient permissions to perform this action
7795
+ status: 403
7796
+ title: Permission Denied
7797
+ type: permission-denied
7798
+ schema:
7799
+ $ref: '#/components/schemas/Problem'
7800
+ description: Forbidden
7903
7801
  '422':
7904
7802
  content:
7905
7803
  application/problem+json:
@@ -7947,6 +7845,30 @@ paths:
7947
7845
  title: Response Update Attributes V1 Organizations Attributes Patch
7948
7846
  type: array
7949
7847
  description: Successful Response
7848
+ '401':
7849
+ content:
7850
+ application/problem+json:
7851
+ example:
7852
+ code: ERROR_AUTHENTICATION
7853
+ detail: Additional error context.
7854
+ status: 401
7855
+ title: Authentication Error
7856
+ type: authentication
7857
+ schema:
7858
+ $ref: '#/components/schemas/Problem'
7859
+ description: Unauthorized
7860
+ '403':
7861
+ content:
7862
+ application/problem+json:
7863
+ example:
7864
+ code: ERROR_PERMISSION_DENIED
7865
+ detail: Insufficient permissions to perform this action
7866
+ status: 403
7867
+ title: Permission Denied
7868
+ type: permission-denied
7869
+ schema:
7870
+ $ref: '#/components/schemas/Problem'
7871
+ description: Forbidden
7950
7872
  '422':
7951
7873
  content:
7952
7874
  application/problem+json:
@@ -7999,6 +7921,30 @@ paths:
7999
7921
  Id Get
8000
7922
  type: array
8001
7923
  description: Successful Response
7924
+ '401':
7925
+ content:
7926
+ application/problem+json:
7927
+ example:
7928
+ code: ERROR_AUTHENTICATION
7929
+ detail: Additional error context.
7930
+ status: 401
7931
+ title: Authentication Error
7932
+ type: authentication
7933
+ schema:
7934
+ $ref: '#/components/schemas/Problem'
7935
+ description: Unauthorized
7936
+ '403':
7937
+ content:
7938
+ application/problem+json:
7939
+ example:
7940
+ code: ERROR_PERMISSION_DENIED
7941
+ detail: Insufficient permissions to perform this action
7942
+ status: 403
7943
+ title: Permission Denied
7944
+ type: permission-denied
7945
+ schema:
7946
+ $ref: '#/components/schemas/Problem'
7947
+ description: Forbidden
8002
7948
  '422':
8003
7949
  content:
8004
7950
  application/problem+json:
@@ -8047,6 +7993,30 @@ paths:
8047
7993
  Id Patch
8048
7994
  type: array
8049
7995
  description: Successful Response
7996
+ '401':
7997
+ content:
7998
+ application/problem+json:
7999
+ example:
8000
+ code: ERROR_AUTHENTICATION
8001
+ detail: Additional error context.
8002
+ status: 401
8003
+ title: Authentication Error
8004
+ type: authentication
8005
+ schema:
8006
+ $ref: '#/components/schemas/Problem'
8007
+ description: Unauthorized
8008
+ '403':
8009
+ content:
8010
+ application/problem+json:
8011
+ example:
8012
+ code: ERROR_PERMISSION_DENIED
8013
+ detail: Insufficient permissions to perform this action
8014
+ status: 403
8015
+ title: Permission Denied
8016
+ type: permission-denied
8017
+ schema:
8018
+ $ref: '#/components/schemas/Problem'
8019
+ description: Forbidden
8050
8020
  '422':
8051
8021
  content:
8052
8022
  application/problem+json:
@@ -8079,6 +8049,30 @@ paths:
8079
8049
  Get
8080
8050
  type: array
8081
8051
  description: Successful Response
8052
+ '401':
8053
+ content:
8054
+ application/problem+json:
8055
+ example:
8056
+ code: ERROR_AUTHENTICATION
8057
+ detail: Additional error context.
8058
+ status: 401
8059
+ title: Authentication Error
8060
+ type: authentication
8061
+ schema:
8062
+ $ref: '#/components/schemas/Problem'
8063
+ description: Unauthorized
8064
+ '403':
8065
+ content:
8066
+ application/problem+json:
8067
+ example:
8068
+ code: ERROR_PERMISSION_DENIED
8069
+ detail: Insufficient permissions to perform this action
8070
+ status: 403
8071
+ title: Permission Denied
8072
+ type: permission-denied
8073
+ schema:
8074
+ $ref: '#/components/schemas/Problem'
8075
+ description: Forbidden
8082
8076
  security:
8083
8077
  - OAuth2PasswordBearer: []
8084
8078
  summary: List IP restrictions
@@ -8106,20 +8100,44 @@ paths:
8106
8100
  schema:
8107
8101
  $ref: '#/components/schemas/IpRestrictionResponse'
8108
8102
  description: Successful Response
8109
- '422':
8103
+ '401':
8110
8104
  content:
8111
8105
  application/problem+json:
8106
+ example:
8107
+ code: ERROR_AUTHENTICATION
8108
+ detail: Additional error context.
8109
+ status: 401
8110
+ title: Authentication Error
8111
+ type: authentication
8112
8112
  schema:
8113
- $ref: '#/components/schemas/HTTPValidationError'
8114
- description: Validation Error
8115
- security:
8116
- - OAuth2PasswordBearer: []
8117
- summary: Create an IP restriction
8118
- tags:
8119
- - organization
8120
- /v1/organizations/ip-restrictions/{ip_restriction_id}:
8121
- delete:
8122
- description: 'Delete an IP restriction.
8113
+ $ref: '#/components/schemas/Problem'
8114
+ description: Unauthorized
8115
+ '403':
8116
+ content:
8117
+ application/problem+json:
8118
+ example:
8119
+ code: ERROR_PERMISSION_DENIED
8120
+ detail: Insufficient permissions to perform this action
8121
+ status: 403
8122
+ title: Permission Denied
8123
+ type: permission-denied
8124
+ schema:
8125
+ $ref: '#/components/schemas/Problem'
8126
+ description: Forbidden
8127
+ '422':
8128
+ content:
8129
+ application/problem+json:
8130
+ schema:
8131
+ $ref: '#/components/schemas/HTTPValidationError'
8132
+ description: Validation Error
8133
+ security:
8134
+ - OAuth2PasswordBearer: []
8135
+ summary: Create an IP restriction
8136
+ tags:
8137
+ - organization
8138
+ /v1/organizations/ip-restrictions/{ip_restriction_id}:
8139
+ delete:
8140
+ description: 'Delete an IP restriction.
8123
8141
 
8124
8142
 
8125
8143
  Permanently removes the specified IP restriction from your organization.'
@@ -8134,6 +8152,30 @@ paths:
8134
8152
  responses:
8135
8153
  '204':
8136
8154
  description: Successful Response
8155
+ '401':
8156
+ content:
8157
+ application/problem+json:
8158
+ example:
8159
+ code: ERROR_AUTHENTICATION
8160
+ detail: Additional error context.
8161
+ status: 401
8162
+ title: Authentication Error
8163
+ type: authentication
8164
+ schema:
8165
+ $ref: '#/components/schemas/Problem'
8166
+ description: Unauthorized
8167
+ '403':
8168
+ content:
8169
+ application/problem+json:
8170
+ example:
8171
+ code: ERROR_PERMISSION_DENIED
8172
+ detail: Insufficient permissions to perform this action
8173
+ status: 403
8174
+ title: Permission Denied
8175
+ type: permission-denied
8176
+ schema:
8177
+ $ref: '#/components/schemas/Problem'
8178
+ description: Forbidden
8137
8179
  '422':
8138
8180
  content:
8139
8181
  application/problem+json:
@@ -8169,6 +8211,30 @@ paths:
8169
8211
  schema:
8170
8212
  $ref: '#/components/schemas/IpRestrictionResponse'
8171
8213
  description: Successful Response
8214
+ '401':
8215
+ content:
8216
+ application/problem+json:
8217
+ example:
8218
+ code: ERROR_AUTHENTICATION
8219
+ detail: Additional error context.
8220
+ status: 401
8221
+ title: Authentication Error
8222
+ type: authentication
8223
+ schema:
8224
+ $ref: '#/components/schemas/Problem'
8225
+ description: Unauthorized
8226
+ '403':
8227
+ content:
8228
+ application/problem+json:
8229
+ example:
8230
+ code: ERROR_PERMISSION_DENIED
8231
+ detail: Insufficient permissions to perform this action
8232
+ status: 403
8233
+ title: Permission Denied
8234
+ type: permission-denied
8235
+ schema:
8236
+ $ref: '#/components/schemas/Problem'
8237
+ description: Forbidden
8172
8238
  '422':
8173
8239
  content:
8174
8240
  application/problem+json:
@@ -8209,6 +8275,30 @@ paths:
8209
8275
  schema:
8210
8276
  $ref: '#/components/schemas/IpRestrictionResponse'
8211
8277
  description: Successful Response
8278
+ '401':
8279
+ content:
8280
+ application/problem+json:
8281
+ example:
8282
+ code: ERROR_AUTHENTICATION
8283
+ detail: Additional error context.
8284
+ status: 401
8285
+ title: Authentication Error
8286
+ type: authentication
8287
+ schema:
8288
+ $ref: '#/components/schemas/Problem'
8289
+ description: Unauthorized
8290
+ '403':
8291
+ content:
8292
+ application/problem+json:
8293
+ example:
8294
+ code: ERROR_PERMISSION_DENIED
8295
+ detail: Insufficient permissions to perform this action
8296
+ status: 403
8297
+ title: Permission Denied
8298
+ type: permission-denied
8299
+ schema:
8300
+ $ref: '#/components/schemas/Problem'
8301
+ description: Forbidden
8212
8302
  '422':
8213
8303
  content:
8214
8304
  application/problem+json:
@@ -8230,6 +8320,30 @@ paths:
8230
8320
  application/json:
8231
8321
  schema: {}
8232
8322
  description: Successful Response
8323
+ '401':
8324
+ content:
8325
+ application/problem+json:
8326
+ example:
8327
+ code: ERROR_AUTHENTICATION
8328
+ detail: Additional error context.
8329
+ status: 401
8330
+ title: Authentication Error
8331
+ type: authentication
8332
+ schema:
8333
+ $ref: '#/components/schemas/Problem'
8334
+ description: Unauthorized
8335
+ '403':
8336
+ content:
8337
+ application/problem+json:
8338
+ example:
8339
+ code: ERROR_PERMISSION_DENIED
8340
+ detail: Insufficient permissions to perform this action
8341
+ status: 403
8342
+ title: Permission Denied
8343
+ type: permission-denied
8344
+ schema:
8345
+ $ref: '#/components/schemas/Problem'
8346
+ description: Forbidden
8233
8347
  security:
8234
8348
  - OAuth2PasswordBearer: []
8235
8349
  summary: List all roles
@@ -8264,69 +8378,30 @@ paths:
8264
8378
  schema:
8265
8379
  $ref: '#/components/schemas/Pagination_User_'
8266
8380
  description: Successful Response
8267
- '422':
8381
+ '401':
8268
8382
  content:
8269
8383
  application/problem+json:
8384
+ example:
8385
+ code: ERROR_AUTHENTICATION
8386
+ detail: Additional error context.
8387
+ status: 401
8388
+ title: Authentication Error
8389
+ type: authentication
8270
8390
  schema:
8271
- $ref: '#/components/schemas/HTTPValidationError'
8272
- description: Validation Error
8273
- security:
8274
- - OAuth2PasswordBearer: []
8275
- summary: List all users
8276
- tags:
8277
- - organization
8278
- /v1/organizations/{organization_id}:
8279
- delete:
8280
- description: Permanently deletes an organization
8281
- operationId: delete_user_v1_organizations__organization_id__delete
8282
- parameters:
8283
- - in: path
8284
- name: organization_id
8285
- required: true
8286
- schema:
8287
- examples:
8288
- - organization_01h45ytscbebyvny4gc8cr8ma2
8289
- format: typeid
8290
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8291
- title: Organization Id
8292
- type: string
8293
- x-typeid-prefix: organization
8294
- responses:
8295
- '204':
8296
- description: Successful Response
8297
- '422':
8391
+ $ref: '#/components/schemas/Problem'
8392
+ description: Unauthorized
8393
+ '403':
8298
8394
  content:
8299
8395
  application/problem+json:
8396
+ example:
8397
+ code: ERROR_PERMISSION_DENIED
8398
+ detail: Insufficient permissions to perform this action
8399
+ status: 403
8400
+ title: Permission Denied
8401
+ type: permission-denied
8300
8402
  schema:
8301
- $ref: '#/components/schemas/HTTPValidationError'
8302
- description: Validation Error
8303
- security:
8304
- - OAuth2PasswordBearer: []
8305
- summary: Delete an organization
8306
- tags:
8307
- - organization
8308
- get:
8309
- description: Retrieves details for a specific organization
8310
- operationId: get_organization_v1_organizations__organization_id__get
8311
- parameters:
8312
- - in: path
8313
- name: organization_id
8314
- required: true
8315
- schema:
8316
- examples:
8317
- - organization_01h45ytscbebyvny4gc8cr8ma2
8318
- format: typeid
8319
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8320
- title: Organization Id
8321
- type: string
8322
- x-typeid-prefix: organization
8323
- responses:
8324
- '200':
8325
- content:
8326
- application/json:
8327
- schema:
8328
- $ref: '#/components/schemas/OrganizationWithBillingData'
8329
- description: Successful Response
8403
+ $ref: '#/components/schemas/Problem'
8404
+ description: Forbidden
8330
8405
  '422':
8331
8406
  content:
8332
8407
  application/problem+json:
@@ -8335,12 +8410,13 @@ paths:
8335
8410
  description: Validation Error
8336
8411
  security:
8337
8412
  - OAuth2PasswordBearer: []
8338
- summary: Get organization details
8413
+ summary: List all users
8339
8414
  tags:
8340
8415
  - organization
8341
- patch:
8342
- description: Updates details for a specific organization
8343
- operationId: update_organization_v1_organizations__organization_id__patch
8416
+ /v1/organizations/{organization_id}:
8417
+ delete:
8418
+ description: Permanently deletes an organization
8419
+ operationId: delete_organization_v1_organizations__organization_id__delete
8344
8420
  parameters:
8345
8421
  - in: path
8346
8422
  name: organization_id
@@ -8353,59 +8429,33 @@ paths:
8353
8429
  title: Organization Id
8354
8430
  type: string
8355
8431
  x-typeid-prefix: organization
8356
- requestBody:
8357
- content:
8358
- application/json:
8359
- schema:
8360
- $ref: '#/components/schemas/OrganizationUpdate'
8361
- required: true
8362
8432
  responses:
8363
- '200':
8364
- content:
8365
- application/json:
8366
- schema:
8367
- $ref: '#/components/schemas/Organization'
8433
+ '204':
8368
8434
  description: Successful Response
8369
- '422':
8435
+ '401':
8370
8436
  content:
8371
8437
  application/problem+json:
8438
+ example:
8439
+ code: ERROR_AUTHENTICATION
8440
+ detail: Additional error context.
8441
+ status: 401
8442
+ title: Authentication Error
8443
+ type: authentication
8372
8444
  schema:
8373
- $ref: '#/components/schemas/HTTPValidationError'
8374
- description: Validation Error
8375
- security:
8376
- - OAuth2PasswordBearer: []
8377
- summary: Update an organization
8378
- tags:
8379
- - organization
8380
- /v1/organizations/{organization_id}/billing/checkout-sessions:
8381
- post:
8382
- description: Create a checkout session for the organization
8383
- operationId: get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post
8384
- parameters:
8385
- - in: path
8386
- name: organization_id
8387
- required: true
8388
- schema:
8389
- examples:
8390
- - organization_01h45ytscbebyvny4gc8cr8ma2
8391
- format: typeid
8392
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8393
- title: Organization Id
8394
- type: string
8395
- x-typeid-prefix: organization
8396
- requestBody:
8397
- content:
8398
- application/json:
8399
- schema:
8400
- $ref: '#/components/schemas/CheckoutSessionRequest'
8401
- required: true
8402
- responses:
8403
- '200':
8445
+ $ref: '#/components/schemas/Problem'
8446
+ description: Unauthorized
8447
+ '403':
8404
8448
  content:
8405
- application/json:
8449
+ application/problem+json:
8450
+ example:
8451
+ code: ERROR_PERMISSION_DENIED
8452
+ detail: Insufficient permissions to perform this action
8453
+ status: 403
8454
+ title: Permission Denied
8455
+ type: permission-denied
8406
8456
  schema:
8407
- $ref: '#/components/schemas/CheckoutSessionResponse'
8408
- description: Successful Response
8457
+ $ref: '#/components/schemas/Problem'
8458
+ description: Forbidden
8409
8459
  '422':
8410
8460
  content:
8411
8461
  application/problem+json:
@@ -8414,13 +8464,12 @@ paths:
8414
8464
  description: Validation Error
8415
8465
  security:
8416
8466
  - OAuth2PasswordBearer: []
8417
- summary: Create checkout session
8467
+ summary: Delete an organization
8418
8468
  tags:
8419
8469
  - organization
8420
- /v1/organizations/{organization_id}/billing/payment-methods:
8421
8470
  get:
8422
- description: List all available payment methods for the organization
8423
- operationId: list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get
8471
+ description: Retrieves details for a specific organization
8472
+ operationId: get_organization_v1_organizations__organization_id__get
8424
8473
  parameters:
8425
8474
  - in: path
8426
8475
  name: organization_id
@@ -8438,133 +8487,32 @@ paths:
8438
8487
  content:
8439
8488
  application/json:
8440
8489
  schema:
8441
- items:
8442
- $ref: '#/components/schemas/CustomerCreditCardPaymentMethod'
8443
- title: Response List Payment Methods V1 Organizations Organization
8444
- Id Billing Payment Methods Get
8445
- type: array
8446
- description: Successful Response
8447
- '422':
8448
- content:
8449
- application/problem+json:
8450
- schema:
8451
- $ref: '#/components/schemas/HTTPValidationError'
8452
- description: Validation Error
8453
- security:
8454
- - OAuth2PasswordBearer: []
8455
- summary: List all payment methods
8456
- tags:
8457
- - organization
8458
- /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}:
8459
- delete:
8460
- description: Delete a payment method for the organization
8461
- operationId: delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete
8462
- parameters:
8463
- - in: path
8464
- name: payment_method_id
8465
- required: true
8466
- schema:
8467
- title: Payment Method Id
8468
- type: string
8469
- - in: path
8470
- name: organization_id
8471
- required: true
8472
- schema:
8473
- examples:
8474
- - organization_01h45ytscbebyvny4gc8cr8ma2
8475
- format: typeid
8476
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8477
- title: Organization Id
8478
- type: string
8479
- x-typeid-prefix: organization
8480
- responses:
8481
- '204':
8490
+ $ref: '#/components/schemas/OrganizationWithBillingData'
8482
8491
  description: Successful Response
8483
- '422':
8492
+ '401':
8484
8493
  content:
8485
8494
  application/problem+json:
8495
+ example:
8496
+ code: ERROR_AUTHENTICATION
8497
+ detail: Additional error context.
8498
+ status: 401
8499
+ title: Authentication Error
8500
+ type: authentication
8486
8501
  schema:
8487
- $ref: '#/components/schemas/HTTPValidationError'
8488
- description: Validation Error
8489
- security:
8490
- - OAuth2PasswordBearer: []
8491
- summary: Delete a payment method
8492
- tags:
8493
- - organization
8494
- /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default:
8495
- patch:
8496
- description: Set the provided payment method as default for the specified organization
8497
- operationId: update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch
8498
- parameters:
8499
- - in: path
8500
- name: payment_method_id
8501
- required: true
8502
- schema:
8503
- title: Payment Method Id
8504
- type: string
8505
- - in: path
8506
- name: organization_id
8507
- required: true
8508
- schema:
8509
- examples:
8510
- - organization_01h45ytscbebyvny4gc8cr8ma2
8511
- format: typeid
8512
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8513
- title: Organization Id
8514
- type: string
8515
- x-typeid-prefix: organization
8516
- responses:
8517
- '200':
8518
- content:
8519
- application/json:
8520
- schema:
8521
- items:
8522
- $ref: '#/components/schemas/CustomerCreditCardPaymentMethod'
8523
- title: Response Update Default Payment Method V1 Organizations Organization
8524
- Id Billing Payment Methods Payment Method Id Default Patch
8525
- type: array
8526
- description: Successful Response
8527
- '422':
8502
+ $ref: '#/components/schemas/Problem'
8503
+ description: Unauthorized
8504
+ '403':
8528
8505
  content:
8529
8506
  application/problem+json:
8507
+ example:
8508
+ code: ERROR_PERMISSION_DENIED
8509
+ detail: Insufficient permissions to perform this action
8510
+ status: 403
8511
+ title: Permission Denied
8512
+ type: permission-denied
8530
8513
  schema:
8531
- $ref: '#/components/schemas/HTTPValidationError'
8532
- description: Validation Error
8533
- security:
8534
- - OAuth2PasswordBearer: []
8535
- summary: Set payment method as default
8536
- tags:
8537
- - organization
8538
- /v1/organizations/{organization_id}/billing/wallet/credits:
8539
- post:
8540
- description: Credit the organization's wallet using the provided amount and
8541
- payment method
8542
- operationId: credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post
8543
- parameters:
8544
- - in: path
8545
- name: organization_id
8546
- required: true
8547
- schema:
8548
- examples:
8549
- - organization_01h45ytscbebyvny4gc8cr8ma2
8550
- format: typeid
8551
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8552
- title: Organization Id
8553
- type: string
8554
- x-typeid-prefix: organization
8555
- requestBody:
8556
- content:
8557
- application/json:
8558
- schema:
8559
- $ref: '#/components/schemas/WalletCreditRequest'
8560
- required: true
8561
- responses:
8562
- '200':
8563
- content:
8564
- application/json:
8565
- schema:
8566
- $ref: '#/components/schemas/WalletCreditResponseWithBalance'
8567
- description: Successful Response
8514
+ $ref: '#/components/schemas/Problem'
8515
+ description: Forbidden
8568
8516
  '422':
8569
8517
  content:
8570
8518
  application/problem+json:
@@ -8573,13 +8521,12 @@ paths:
8573
8521
  description: Validation Error
8574
8522
  security:
8575
8523
  - OAuth2PasswordBearer: []
8576
- summary: Credit wallet
8524
+ summary: Get organization details
8577
8525
  tags:
8578
8526
  - organization
8579
- /v1/organizations/{organization_id}/plan:
8580
8527
  patch:
8581
- description: Changes the plan for an organization
8582
- operationId: change_plan_v1_organizations__organization_id__plan_patch
8528
+ description: Updates details for a specific organization
8529
+ operationId: update_organization_v1_organizations__organization_id__patch
8583
8530
  parameters:
8584
8531
  - in: path
8585
8532
  name: organization_id
@@ -8596,49 +8543,39 @@ paths:
8596
8543
  content:
8597
8544
  application/json:
8598
8545
  schema:
8599
- $ref: '#/components/schemas/PlanIdRequest'
8546
+ $ref: '#/components/schemas/OrganizationUpdate'
8600
8547
  required: true
8601
8548
  responses:
8602
8549
  '200':
8603
8550
  content:
8604
8551
  application/json:
8605
8552
  schema:
8606
- $ref: '#/components/schemas/OrganizationWithBillingData'
8553
+ $ref: '#/components/schemas/Organization'
8607
8554
  description: Successful Response
8608
- '422':
8555
+ '401':
8609
8556
  content:
8610
8557
  application/problem+json:
8558
+ example:
8559
+ code: ERROR_AUTHENTICATION
8560
+ detail: Additional error context.
8561
+ status: 401
8562
+ title: Authentication Error
8563
+ type: authentication
8611
8564
  schema:
8612
- $ref: '#/components/schemas/HTTPValidationError'
8613
- description: Validation Error
8614
- security:
8615
- - OAuth2PasswordBearer: []
8616
- summary: Update organization plan
8617
- tags:
8618
- - organization
8619
- /v1/organizations/{organization_id}/plans:
8620
- get:
8621
- description: Retrieves a list of plans for an organization
8622
- operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
8623
- parameters:
8624
- - in: path
8625
- name: organization_id
8626
- required: true
8627
- schema:
8628
- examples:
8629
- - organization_01h45ytscbebyvny4gc8cr8ma2
8630
- format: typeid
8631
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8632
- title: Organization Id
8633
- type: string
8634
- x-typeid-prefix: organization
8635
- responses:
8636
- '200':
8565
+ $ref: '#/components/schemas/Problem'
8566
+ description: Unauthorized
8567
+ '403':
8637
8568
  content:
8638
- application/json:
8569
+ application/problem+json:
8570
+ example:
8571
+ code: ERROR_PERMISSION_DENIED
8572
+ detail: Insufficient permissions to perform this action
8573
+ status: 403
8574
+ title: Permission Denied
8575
+ type: permission-denied
8639
8576
  schema:
8640
- $ref: '#/components/schemas/GetCurrentAvailablePlansResponse'
8641
- description: Successful Response
8577
+ $ref: '#/components/schemas/Problem'
8578
+ description: Forbidden
8642
8579
  '422':
8643
8580
  content:
8644
8581
  application/problem+json:
@@ -8647,7 +8584,7 @@ paths:
8647
8584
  description: Validation Error
8648
8585
  security:
8649
8586
  - OAuth2PasswordBearer: []
8650
- summary: Get plans for an organization
8587
+ summary: Update an organization
8651
8588
  tags:
8652
8589
  - organization
8653
8590
  /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
@@ -8695,6 +8632,30 @@ paths:
8695
8632
  schema:
8696
8633
  $ref: '#/components/schemas/GetPricesResponse'
8697
8634
  description: Successful Response
8635
+ '401':
8636
+ content:
8637
+ application/problem+json:
8638
+ example:
8639
+ code: ERROR_AUTHENTICATION
8640
+ detail: Additional error context.
8641
+ status: 401
8642
+ title: Authentication Error
8643
+ type: authentication
8644
+ schema:
8645
+ $ref: '#/components/schemas/Problem'
8646
+ description: Unauthorized
8647
+ '403':
8648
+ content:
8649
+ application/problem+json:
8650
+ example:
8651
+ code: ERROR_PERMISSION_DENIED
8652
+ detail: Insufficient permissions to perform this action
8653
+ status: 403
8654
+ title: Permission Denied
8655
+ type: permission-denied
8656
+ schema:
8657
+ $ref: '#/components/schemas/Problem'
8658
+ description: Forbidden
8698
8659
  '422':
8699
8660
  content:
8700
8661
  application/problem+json:
@@ -8827,6 +8788,30 @@ paths:
8827
8788
  schema:
8828
8789
  $ref: '#/components/schemas/Pagination_BillingTransactionResponse_'
8829
8790
  description: Successful Response
8791
+ '401':
8792
+ content:
8793
+ application/problem+json:
8794
+ example:
8795
+ code: ERROR_AUTHENTICATION
8796
+ detail: Additional error context.
8797
+ status: 401
8798
+ title: Authentication Error
8799
+ type: authentication
8800
+ schema:
8801
+ $ref: '#/components/schemas/Problem'
8802
+ description: Unauthorized
8803
+ '403':
8804
+ content:
8805
+ application/problem+json:
8806
+ example:
8807
+ code: ERROR_PERMISSION_DENIED
8808
+ detail: Insufficient permissions to perform this action
8809
+ status: 403
8810
+ title: Permission Denied
8811
+ type: permission-denied
8812
+ schema:
8813
+ $ref: '#/components/schemas/Problem'
8814
+ description: Forbidden
8830
8815
  '422':
8831
8816
  content:
8832
8817
  application/problem+json:
@@ -8872,6 +8857,30 @@ paths:
8872
8857
  schema:
8873
8858
  $ref: '#/components/schemas/BillingTransactionResponse'
8874
8859
  description: Successful Response
8860
+ '401':
8861
+ content:
8862
+ application/problem+json:
8863
+ example:
8864
+ code: ERROR_AUTHENTICATION
8865
+ detail: Additional error context.
8866
+ status: 401
8867
+ title: Authentication Error
8868
+ type: authentication
8869
+ schema:
8870
+ $ref: '#/components/schemas/Problem'
8871
+ description: Unauthorized
8872
+ '403':
8873
+ content:
8874
+ application/problem+json:
8875
+ example:
8876
+ code: ERROR_PERMISSION_DENIED
8877
+ detail: Insufficient permissions to perform this action
8878
+ status: 403
8879
+ title: Permission Denied
8880
+ type: permission-denied
8881
+ schema:
8882
+ $ref: '#/components/schemas/Problem'
8883
+ description: Forbidden
8875
8884
  '422':
8876
8885
  content:
8877
8886
  application/problem+json: