@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/package.json +3 -8
- package/src/helpers/constants.ts +1 -53
- package/src/helpers/keys.ts +29 -870
- package/src/helpers/requests.d.ts +2 -317
- package/src/helpers/responses.d.ts +2 -376
- package/src/helpers/schemas-arrays.d.ts +1 -29
- package/src/helpers/schemas.d.ts +0 -144
- package/src/openapi.yaml +14 -461
- package/src/schema.d.ts +137 -527
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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-
|
|
4800
|
+
version: 2025-10-06-172245
|
|
4975
4801
|
x-logo:
|
|
4976
4802
|
altText: OpusDNS API Reference
|
|
4977
4803
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8278,7 +8104,7 @@ paths:
|
|
|
8278
8104
|
/v1/organizations/{organization_id}:
|
|
8279
8105
|
delete:
|
|
8280
8106
|
description: Permanently deletes an organization
|
|
8281
|
-
operationId:
|
|
8107
|
+
operationId: delete_organization_v1_organizations__organization_id__delete
|
|
8282
8108
|
parameters:
|
|
8283
8109
|
- in: path
|
|
8284
8110
|
name: organization_id
|
|
@@ -8377,279 +8203,6 @@ paths:
|
|
|
8377
8203
|
summary: Update an organization
|
|
8378
8204
|
tags:
|
|
8379
8205
|
- 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':
|
|
8404
|
-
content:
|
|
8405
|
-
application/json:
|
|
8406
|
-
schema:
|
|
8407
|
-
$ref: '#/components/schemas/CheckoutSessionResponse'
|
|
8408
|
-
description: Successful Response
|
|
8409
|
-
'422':
|
|
8410
|
-
content:
|
|
8411
|
-
application/problem+json:
|
|
8412
|
-
schema:
|
|
8413
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8414
|
-
description: Validation Error
|
|
8415
|
-
security:
|
|
8416
|
-
- OAuth2PasswordBearer: []
|
|
8417
|
-
summary: Create checkout session
|
|
8418
|
-
tags:
|
|
8419
|
-
- organization
|
|
8420
|
-
/v1/organizations/{organization_id}/billing/payment-methods:
|
|
8421
|
-
get:
|
|
8422
|
-
description: List all available payment methods for the organization
|
|
8423
|
-
operationId: list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get
|
|
8424
|
-
parameters:
|
|
8425
|
-
- in: path
|
|
8426
|
-
name: organization_id
|
|
8427
|
-
required: true
|
|
8428
|
-
schema:
|
|
8429
|
-
examples:
|
|
8430
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
8431
|
-
format: typeid
|
|
8432
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8433
|
-
title: Organization Id
|
|
8434
|
-
type: string
|
|
8435
|
-
x-typeid-prefix: organization
|
|
8436
|
-
responses:
|
|
8437
|
-
'200':
|
|
8438
|
-
content:
|
|
8439
|
-
application/json:
|
|
8440
|
-
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':
|
|
8482
|
-
description: Successful Response
|
|
8483
|
-
'422':
|
|
8484
|
-
content:
|
|
8485
|
-
application/problem+json:
|
|
8486
|
-
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':
|
|
8528
|
-
content:
|
|
8529
|
-
application/problem+json:
|
|
8530
|
-
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
|
|
8568
|
-
'422':
|
|
8569
|
-
content:
|
|
8570
|
-
application/problem+json:
|
|
8571
|
-
schema:
|
|
8572
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8573
|
-
description: Validation Error
|
|
8574
|
-
security:
|
|
8575
|
-
- OAuth2PasswordBearer: []
|
|
8576
|
-
summary: Credit wallet
|
|
8577
|
-
tags:
|
|
8578
|
-
- organization
|
|
8579
|
-
/v1/organizations/{organization_id}/plan:
|
|
8580
|
-
patch:
|
|
8581
|
-
description: Changes the plan for an organization
|
|
8582
|
-
operationId: change_plan_v1_organizations__organization_id__plan_patch
|
|
8583
|
-
parameters:
|
|
8584
|
-
- in: path
|
|
8585
|
-
name: organization_id
|
|
8586
|
-
required: true
|
|
8587
|
-
schema:
|
|
8588
|
-
examples:
|
|
8589
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
8590
|
-
format: typeid
|
|
8591
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8592
|
-
title: Organization Id
|
|
8593
|
-
type: string
|
|
8594
|
-
x-typeid-prefix: organization
|
|
8595
|
-
requestBody:
|
|
8596
|
-
content:
|
|
8597
|
-
application/json:
|
|
8598
|
-
schema:
|
|
8599
|
-
$ref: '#/components/schemas/PlanIdRequest'
|
|
8600
|
-
required: true
|
|
8601
|
-
responses:
|
|
8602
|
-
'200':
|
|
8603
|
-
content:
|
|
8604
|
-
application/json:
|
|
8605
|
-
schema:
|
|
8606
|
-
$ref: '#/components/schemas/OrganizationWithBillingData'
|
|
8607
|
-
description: Successful Response
|
|
8608
|
-
'422':
|
|
8609
|
-
content:
|
|
8610
|
-
application/problem+json:
|
|
8611
|
-
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':
|
|
8637
|
-
content:
|
|
8638
|
-
application/json:
|
|
8639
|
-
schema:
|
|
8640
|
-
$ref: '#/components/schemas/GetCurrentAvailablePlansResponse'
|
|
8641
|
-
description: Successful Response
|
|
8642
|
-
'422':
|
|
8643
|
-
content:
|
|
8644
|
-
application/problem+json:
|
|
8645
|
-
schema:
|
|
8646
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
8647
|
-
description: Validation Error
|
|
8648
|
-
security:
|
|
8649
|
-
- OAuth2PasswordBearer: []
|
|
8650
|
-
summary: Get plans for an organization
|
|
8651
|
-
tags:
|
|
8652
|
-
- organization
|
|
8653
8206
|
/v1/organizations/{organization_id}/pricing/product-type/{product_type}:
|
|
8654
8207
|
get:
|
|
8655
8208
|
description: Retrieves pricing data for a specific product type. If a product
|