@opusdns/api 0.61.0 → 0.63.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 +1 -1
- package/src/helpers/constants.ts +161 -1
- package/src/helpers/keys.ts +788 -0
- package/src/helpers/requests.d.ts +309 -1
- package/src/helpers/responses.d.ts +369 -2
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +160 -0
- package/src/openapi.yaml +570 -1
- package/src/schema.d.ts +510 -0
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
35
|
+
import { DomainDnssecDataArray, OrganizationAttribute2Array, CustomerCreditCardPaymentMethodArray, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, CheckoutSession, WalletCreditResponseWithBalance, GetCurrentAvailablePlans, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AuthClientCredentials endpoint
|
|
@@ -4296,6 +4296,263 @@ export type PATCH_OrganizationsByOrganizationId_Response_200 = Organization
|
|
|
4296
4296
|
*/
|
|
4297
4297
|
export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
|
|
4298
4298
|
|
|
4299
|
+
/**
|
|
4300
|
+
* Response types for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4301
|
+
*
|
|
4302
|
+
* Get Checkout Session
|
|
4303
|
+
*
|
|
4304
|
+
* @remarks
|
|
4305
|
+
* This type defines all possible response structures for the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4306
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4307
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4308
|
+
*
|
|
4309
|
+
|
|
4310
|
+
*
|
|
4311
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4312
|
+
*
|
|
4313
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200} - 200 response type
|
|
4314
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422} - 422 response type
|
|
4315
|
+
*
|
|
4316
|
+
|
|
4317
|
+
*/
|
|
4318
|
+
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response = POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200 | POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422;
|
|
4319
|
+
|
|
4320
|
+
/**
|
|
4321
|
+
* 200 response for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4322
|
+
*
|
|
4323
|
+
* @remarks
|
|
4324
|
+
* This type defines the response structure for the 200 status code
|
|
4325
|
+
* of the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4326
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4327
|
+
*
|
|
4328
|
+
|
|
4329
|
+
*
|
|
4330
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4331
|
+
*
|
|
4332
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response} - The main response type definition
|
|
4333
|
+
* @see {@link CheckoutSession} - The actual schema type definition
|
|
4334
|
+
*/
|
|
4335
|
+
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_200 = CheckoutSession
|
|
4336
|
+
|
|
4337
|
+
/**
|
|
4338
|
+
* 422 response for POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint
|
|
4339
|
+
*
|
|
4340
|
+
* @remarks
|
|
4341
|
+
* This type defines the response structure for the 422 status code
|
|
4342
|
+
* of the POST OrganizationsByOrganizationIdBillingCheckoutSessions endpoint.
|
|
4343
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4344
|
+
*
|
|
4345
|
+
|
|
4346
|
+
*
|
|
4347
|
+
* @path /v1/organizations/{organization_id}/billing/checkout-sessions
|
|
4348
|
+
*
|
|
4349
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response} - The main response type definition
|
|
4350
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4351
|
+
*/
|
|
4352
|
+
export type POST_OrganizationsByOrganizationIdBillingCheckoutSessions_Response_422 = HTTPValidationError
|
|
4353
|
+
|
|
4354
|
+
/**
|
|
4355
|
+
* Response types for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4356
|
+
*
|
|
4357
|
+
* List Payment Methods
|
|
4358
|
+
*
|
|
4359
|
+
* @remarks
|
|
4360
|
+
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4361
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4362
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4363
|
+
*
|
|
4364
|
+
|
|
4365
|
+
*
|
|
4366
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4367
|
+
*
|
|
4368
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200} - 200 response type
|
|
4369
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422} - 422 response type
|
|
4370
|
+
*
|
|
4371
|
+
|
|
4372
|
+
*/
|
|
4373
|
+
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response = GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200 | GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422;
|
|
4374
|
+
|
|
4375
|
+
/**
|
|
4376
|
+
* 200 response for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4377
|
+
*
|
|
4378
|
+
* @remarks
|
|
4379
|
+
* This type defines the response structure for the 200 status code
|
|
4380
|
+
* of the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4381
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4382
|
+
*
|
|
4383
|
+
|
|
4384
|
+
*
|
|
4385
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4386
|
+
*
|
|
4387
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response} - The main response type definition
|
|
4388
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The actual schema type definition
|
|
4389
|
+
*/
|
|
4390
|
+
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_200 = CustomerCreditCardPaymentMethodArray
|
|
4391
|
+
|
|
4392
|
+
/**
|
|
4393
|
+
* 422 response for GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint
|
|
4394
|
+
*
|
|
4395
|
+
* @remarks
|
|
4396
|
+
* This type defines the response structure for the 422 status code
|
|
4397
|
+
* of the GET OrganizationsByOrganizationIdBillingPaymentMethods endpoint.
|
|
4398
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4399
|
+
*
|
|
4400
|
+
|
|
4401
|
+
*
|
|
4402
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods
|
|
4403
|
+
*
|
|
4404
|
+
* @see {@link GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response} - The main response type definition
|
|
4405
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4406
|
+
*/
|
|
4407
|
+
export type GET_OrganizationsByOrganizationIdBillingPaymentMethods_Response_422 = HTTPValidationError
|
|
4408
|
+
|
|
4409
|
+
/**
|
|
4410
|
+
* Response types for DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint
|
|
4411
|
+
*
|
|
4412
|
+
* Delete Payment Method
|
|
4413
|
+
*
|
|
4414
|
+
* @remarks
|
|
4415
|
+
* This type defines all possible response structures for the DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint.
|
|
4416
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4417
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4418
|
+
*
|
|
4419
|
+
|
|
4420
|
+
*
|
|
4421
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
4422
|
+
*
|
|
4423
|
+
* @see {@link DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422} - 422 response type
|
|
4424
|
+
*
|
|
4425
|
+
|
|
4426
|
+
*/
|
|
4427
|
+
export type DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response = DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422;
|
|
4428
|
+
|
|
4429
|
+
/**
|
|
4430
|
+
* 422 response for DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint
|
|
4431
|
+
*
|
|
4432
|
+
* @remarks
|
|
4433
|
+
* This type defines the response structure for the 422 status code
|
|
4434
|
+
* of the DELETE OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId endpoint.
|
|
4435
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4436
|
+
*
|
|
4437
|
+
|
|
4438
|
+
*
|
|
4439
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
|
|
4440
|
+
*
|
|
4441
|
+
* @see {@link DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response} - The main response type definition
|
|
4442
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4443
|
+
*/
|
|
4444
|
+
export type DELETE_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodId_Response_422 = HTTPValidationError
|
|
4445
|
+
|
|
4446
|
+
/**
|
|
4447
|
+
* Response types for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4448
|
+
*
|
|
4449
|
+
* Update Default Payment Method
|
|
4450
|
+
*
|
|
4451
|
+
* @remarks
|
|
4452
|
+
* This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4453
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4454
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4455
|
+
*
|
|
4456
|
+
|
|
4457
|
+
*
|
|
4458
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4459
|
+
*
|
|
4460
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200} - 200 response type
|
|
4461
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422} - 422 response type
|
|
4462
|
+
*
|
|
4463
|
+
|
|
4464
|
+
*/
|
|
4465
|
+
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response = PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200 | PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422;
|
|
4466
|
+
|
|
4467
|
+
/**
|
|
4468
|
+
* 200 response for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4469
|
+
*
|
|
4470
|
+
* @remarks
|
|
4471
|
+
* This type defines the response structure for the 200 status code
|
|
4472
|
+
* of the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4473
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4474
|
+
*
|
|
4475
|
+
|
|
4476
|
+
*
|
|
4477
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4478
|
+
*
|
|
4479
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response} - The main response type definition
|
|
4480
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The actual schema type definition
|
|
4481
|
+
*/
|
|
4482
|
+
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_200 = CustomerCreditCardPaymentMethodArray
|
|
4483
|
+
|
|
4484
|
+
/**
|
|
4485
|
+
* 422 response for PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint
|
|
4486
|
+
*
|
|
4487
|
+
* @remarks
|
|
4488
|
+
* This type defines the response structure for the 422 status code
|
|
4489
|
+
* of the PATCH OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault endpoint.
|
|
4490
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4491
|
+
*
|
|
4492
|
+
|
|
4493
|
+
*
|
|
4494
|
+
* @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
|
|
4495
|
+
*
|
|
4496
|
+
* @see {@link PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response} - The main response type definition
|
|
4497
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4498
|
+
*/
|
|
4499
|
+
export type PATCH_OrganizationsByOrganizationIdBillingPaymentMethodsByPaymentMethodIdDefault_Response_422 = HTTPValidationError
|
|
4500
|
+
|
|
4501
|
+
/**
|
|
4502
|
+
* Response types for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4503
|
+
*
|
|
4504
|
+
* Credit Wallet
|
|
4505
|
+
*
|
|
4506
|
+
* @remarks
|
|
4507
|
+
* This type defines all possible response structures for the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4508
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4509
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4510
|
+
*
|
|
4511
|
+
|
|
4512
|
+
*
|
|
4513
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4514
|
+
*
|
|
4515
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200} - 200 response type
|
|
4516
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422} - 422 response type
|
|
4517
|
+
*
|
|
4518
|
+
|
|
4519
|
+
*/
|
|
4520
|
+
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response = POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200 | POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422;
|
|
4521
|
+
|
|
4522
|
+
/**
|
|
4523
|
+
* 200 response for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4524
|
+
*
|
|
4525
|
+
* @remarks
|
|
4526
|
+
* This type defines the response structure for the 200 status code
|
|
4527
|
+
* of the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4528
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4529
|
+
*
|
|
4530
|
+
|
|
4531
|
+
*
|
|
4532
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4533
|
+
*
|
|
4534
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response} - The main response type definition
|
|
4535
|
+
* @see {@link WalletCreditResponseWithBalance} - The actual schema type definition
|
|
4536
|
+
*/
|
|
4537
|
+
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_200 = WalletCreditResponseWithBalance
|
|
4538
|
+
|
|
4539
|
+
/**
|
|
4540
|
+
* 422 response for POST OrganizationsByOrganizationIdBillingWalletCredits endpoint
|
|
4541
|
+
*
|
|
4542
|
+
* @remarks
|
|
4543
|
+
* This type defines the response structure for the 422 status code
|
|
4544
|
+
* of the POST OrganizationsByOrganizationIdBillingWalletCredits endpoint.
|
|
4545
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4546
|
+
*
|
|
4547
|
+
|
|
4548
|
+
*
|
|
4549
|
+
* @path /v1/organizations/{organization_id}/billing/wallet/credits
|
|
4550
|
+
*
|
|
4551
|
+
* @see {@link POST_OrganizationsByOrganizationIdBillingWalletCredits_Response} - The main response type definition
|
|
4552
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4553
|
+
*/
|
|
4554
|
+
export type POST_OrganizationsByOrganizationIdBillingWalletCredits_Response_422 = HTTPValidationError
|
|
4555
|
+
|
|
4299
4556
|
/**
|
|
4300
4557
|
* Response types for PATCH OrganizationsByOrganizationIdPlan endpoint
|
|
4301
4558
|
*
|
|
@@ -4461,6 +4718,116 @@ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Res
|
|
|
4461
4718
|
*/
|
|
4462
4719
|
export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422 = HTTPValidationError
|
|
4463
4720
|
|
|
4721
|
+
/**
|
|
4722
|
+
* Response types for GET OrganizationsByOrganizationIdTransactions endpoint
|
|
4723
|
+
*
|
|
4724
|
+
* Get transactions for an organization
|
|
4725
|
+
*
|
|
4726
|
+
* @remarks
|
|
4727
|
+
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdTransactions endpoint.
|
|
4728
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4729
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4730
|
+
*
|
|
4731
|
+
|
|
4732
|
+
*
|
|
4733
|
+
* @path /v1/organizations/{organization_id}/transactions
|
|
4734
|
+
*
|
|
4735
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactions_Response_200} - 200 response type
|
|
4736
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactions_Response_422} - 422 response type
|
|
4737
|
+
*
|
|
4738
|
+
|
|
4739
|
+
*/
|
|
4740
|
+
export type GET_OrganizationsByOrganizationIdTransactions_Response = GET_OrganizationsByOrganizationIdTransactions_Response_200 | GET_OrganizationsByOrganizationIdTransactions_Response_422;
|
|
4741
|
+
|
|
4742
|
+
/**
|
|
4743
|
+
* 200 response for GET OrganizationsByOrganizationIdTransactions endpoint
|
|
4744
|
+
*
|
|
4745
|
+
* @remarks
|
|
4746
|
+
* This type defines the response structure for the 200 status code
|
|
4747
|
+
* of the GET OrganizationsByOrganizationIdTransactions endpoint.
|
|
4748
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4749
|
+
*
|
|
4750
|
+
|
|
4751
|
+
*
|
|
4752
|
+
* @path /v1/organizations/{organization_id}/transactions
|
|
4753
|
+
*
|
|
4754
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactions_Response} - The main response type definition
|
|
4755
|
+
* @see {@link Pagination_BillingTransaction} - The actual schema type definition
|
|
4756
|
+
*/
|
|
4757
|
+
export type GET_OrganizationsByOrganizationIdTransactions_Response_200 = Pagination_BillingTransaction
|
|
4758
|
+
|
|
4759
|
+
/**
|
|
4760
|
+
* 422 response for GET OrganizationsByOrganizationIdTransactions endpoint
|
|
4761
|
+
*
|
|
4762
|
+
* @remarks
|
|
4763
|
+
* This type defines the response structure for the 422 status code
|
|
4764
|
+
* of the GET OrganizationsByOrganizationIdTransactions endpoint.
|
|
4765
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4766
|
+
*
|
|
4767
|
+
|
|
4768
|
+
*
|
|
4769
|
+
* @path /v1/organizations/{organization_id}/transactions
|
|
4770
|
+
*
|
|
4771
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactions_Response} - The main response type definition
|
|
4772
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4773
|
+
*/
|
|
4774
|
+
export type GET_OrganizationsByOrganizationIdTransactions_Response_422 = HTTPValidationError
|
|
4775
|
+
|
|
4776
|
+
/**
|
|
4777
|
+
* Response types for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
|
|
4778
|
+
*
|
|
4779
|
+
* Get a specific transaction for an organization
|
|
4780
|
+
*
|
|
4781
|
+
* @remarks
|
|
4782
|
+
* This type defines all possible response structures for the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
|
|
4783
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4784
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4785
|
+
*
|
|
4786
|
+
|
|
4787
|
+
*
|
|
4788
|
+
* @path /v1/organizations/{organization_id}/transactions/{transaction_id}
|
|
4789
|
+
*
|
|
4790
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200} - 200 response type
|
|
4791
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422} - 422 response type
|
|
4792
|
+
*
|
|
4793
|
+
|
|
4794
|
+
*/
|
|
4795
|
+
export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response = GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200 | GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422;
|
|
4796
|
+
|
|
4797
|
+
/**
|
|
4798
|
+
* 200 response for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
|
|
4799
|
+
*
|
|
4800
|
+
* @remarks
|
|
4801
|
+
* This type defines the response structure for the 200 status code
|
|
4802
|
+
* of the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
|
|
4803
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4804
|
+
*
|
|
4805
|
+
|
|
4806
|
+
*
|
|
4807
|
+
* @path /v1/organizations/{organization_id}/transactions/{transaction_id}
|
|
4808
|
+
*
|
|
4809
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response} - The main response type definition
|
|
4810
|
+
* @see {@link BillingTransaction} - The actual schema type definition
|
|
4811
|
+
*/
|
|
4812
|
+
export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200 = BillingTransaction
|
|
4813
|
+
|
|
4814
|
+
/**
|
|
4815
|
+
* 422 response for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
|
|
4816
|
+
*
|
|
4817
|
+
* @remarks
|
|
4818
|
+
* This type defines the response structure for the 422 status code
|
|
4819
|
+
* of the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
|
|
4820
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4821
|
+
*
|
|
4822
|
+
|
|
4823
|
+
*
|
|
4824
|
+
* @path /v1/organizations/{organization_id}/transactions/{transaction_id}
|
|
4825
|
+
*
|
|
4826
|
+
* @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response} - The main response type definition
|
|
4827
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4828
|
+
*/
|
|
4829
|
+
export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422 = HTTPValidationError
|
|
4830
|
+
|
|
4464
4831
|
/**
|
|
4465
4832
|
* Response types for GET OrganizationsIpRestrictions endpoint
|
|
4466
4833
|
*
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, CustomerCreditCardPaymentMethod, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -93,6 +93,20 @@ export type OrganizationAttributeUpdateArray = OrganizationAttributeUpdate[];
|
|
|
93
93
|
* @see {@link IpRestriction} - The individual IpRestrictionResponse type definition
|
|
94
94
|
*/
|
|
95
95
|
export type IpRestrictionArray = IpRestriction[];
|
|
96
|
+
/**
|
|
97
|
+
* CustomerCreditCardPaymentMethod
|
|
98
|
+
*
|
|
99
|
+
* @remarks
|
|
100
|
+
* Array type for CustomerCreditCardPaymentMethod objects. Used when the API returns a collection of CustomerCreditCardPaymentMethod instances.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```typescript
|
|
104
|
+
* const items: CustomerCreditCardPaymentMethodArray = await api.getCustomerCreditCardPaymentMethods();
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The individual CustomerCreditCardPaymentMethod type definition
|
|
108
|
+
*/
|
|
109
|
+
export type CustomerCreditCardPaymentMethodArray = CustomerCreditCardPaymentMethod[];
|
|
96
110
|
/**
|
|
97
111
|
* TldResponseShort
|
|
98
112
|
*
|
|
@@ -499,6 +513,20 @@ export type OrganizationAttributeCreateArray = OrganizationAttributeCreate[];
|
|
|
499
513
|
* @see {@link UserCreate} - The individual UserCreate type definition
|
|
500
514
|
*/
|
|
501
515
|
export type UserCreateArray = UserCreate[];
|
|
516
|
+
/**
|
|
517
|
+
* BillingTransactionResponse
|
|
518
|
+
*
|
|
519
|
+
* @remarks
|
|
520
|
+
* Array type for BillingTransactionResponse objects. Used when the API returns a collection of BillingTransactionResponse instances.
|
|
521
|
+
*
|
|
522
|
+
* @example
|
|
523
|
+
* ```typescript
|
|
524
|
+
* const items: BillingTransactionArray = await api.getBillingTransactions();
|
|
525
|
+
* ```
|
|
526
|
+
*
|
|
527
|
+
* @see {@link BillingTransaction} - The individual BillingTransactionResponse type definition
|
|
528
|
+
*/
|
|
529
|
+
export type BillingTransactionArray = BillingTransaction[];
|
|
502
530
|
/**
|
|
503
531
|
* ContactSchema
|
|
504
532
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -138,6 +138,54 @@ export type BillingTransactionAction = components['schemas']['BillingTransaction
|
|
|
138
138
|
* @see {@link components} - The OpenAPI components schema definition
|
|
139
139
|
*/
|
|
140
140
|
export type BillingTransactionProductType = components['schemas']['BillingTransactionProductType'];
|
|
141
|
+
/**
|
|
142
|
+
* BillingTransactionResponse
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Type alias for the `BillingTransactionResponse` OpenAPI schema.
|
|
146
|
+
* This type represents billingtransactionresponse data structures used in API requests and responses.
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```typescript
|
|
150
|
+
* const response = await api.getBillingTransaction();
|
|
151
|
+
* const item: BillingTransaction = response.results;
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
155
|
+
*/
|
|
156
|
+
export type BillingTransaction = components['schemas']['BillingTransactionResponse'];
|
|
157
|
+
/**
|
|
158
|
+
* BillingTransactionSortField
|
|
159
|
+
*
|
|
160
|
+
* @remarks
|
|
161
|
+
* Type alias for the `BillingTransactionSortField` OpenAPI schema.
|
|
162
|
+
* This type represents billingtransactionsortfield data structures used in API requests and responses.
|
|
163
|
+
*
|
|
164
|
+
* @example
|
|
165
|
+
* ```typescript
|
|
166
|
+
* const response = await api.getBillingTransactionSortField();
|
|
167
|
+
* const item: BillingTransactionSortField = response.results;
|
|
168
|
+
* ```
|
|
169
|
+
*
|
|
170
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
171
|
+
*/
|
|
172
|
+
export type BillingTransactionSortField = components['schemas']['BillingTransactionSortField'];
|
|
173
|
+
/**
|
|
174
|
+
* BillingTransactionStatus
|
|
175
|
+
*
|
|
176
|
+
* @remarks
|
|
177
|
+
* Type alias for the `BillingTransactionStatus` OpenAPI schema.
|
|
178
|
+
* This type represents billingtransactionstatus data structures used in API requests and responses.
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* ```typescript
|
|
182
|
+
* const response = await api.getBillingTransactionStatus();
|
|
183
|
+
* const item: BillingTransactionStatus = response.results;
|
|
184
|
+
* ```
|
|
185
|
+
*
|
|
186
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
187
|
+
*/
|
|
188
|
+
export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
|
|
141
189
|
/**
|
|
142
190
|
* Body_issue_organization_token_v1_auth_token_post
|
|
143
191
|
*
|
|
@@ -154,6 +202,38 @@ export type BillingTransactionProductType = components['schemas']['BillingTransa
|
|
|
154
202
|
* @see {@link components} - The OpenAPI components schema definition
|
|
155
203
|
*/
|
|
156
204
|
export type Body_issue_organization_token_v1_auth_token_post = components['schemas']['Body_issue_organization_token_v1_auth_token_post'];
|
|
205
|
+
/**
|
|
206
|
+
* CheckoutSessionRequest
|
|
207
|
+
*
|
|
208
|
+
* @remarks
|
|
209
|
+
* Type alias for the `CheckoutSessionRequest` OpenAPI schema.
|
|
210
|
+
* This type represents checkoutsessionrequest data structures used in API requests and responses.
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* ```typescript
|
|
214
|
+
* const response = await api.getCheckoutSessionRequest();
|
|
215
|
+
* const item: CheckoutSessionRequest = response.results;
|
|
216
|
+
* ```
|
|
217
|
+
*
|
|
218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
219
|
+
*/
|
|
220
|
+
export type CheckoutSessionRequest = components['schemas']['CheckoutSessionRequest'];
|
|
221
|
+
/**
|
|
222
|
+
* CheckoutSessionResponse
|
|
223
|
+
*
|
|
224
|
+
* @remarks
|
|
225
|
+
* Type alias for the `CheckoutSessionResponse` OpenAPI schema.
|
|
226
|
+
* This type represents checkoutsessionresponse data structures used in API requests and responses.
|
|
227
|
+
*
|
|
228
|
+
* @example
|
|
229
|
+
* ```typescript
|
|
230
|
+
* const response = await api.getCheckoutSession();
|
|
231
|
+
* const item: CheckoutSession = response.results;
|
|
232
|
+
* ```
|
|
233
|
+
*
|
|
234
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
235
|
+
*/
|
|
236
|
+
export type CheckoutSession = components['schemas']['CheckoutSessionResponse'];
|
|
157
237
|
/**
|
|
158
238
|
* ContactConfigBase
|
|
159
239
|
*
|
|
@@ -362,6 +442,22 @@ export type ContactsBase = components['schemas']['ContactsBase'];
|
|
|
362
442
|
* @see {@link components} - The OpenAPI components schema definition
|
|
363
443
|
*/
|
|
364
444
|
export type Currency = components['schemas']['Currency'];
|
|
445
|
+
/**
|
|
446
|
+
* CustomerCreditCardPaymentMethod
|
|
447
|
+
*
|
|
448
|
+
* @remarks
|
|
449
|
+
* Type alias for the `CustomerCreditCardPaymentMethod` OpenAPI schema.
|
|
450
|
+
* This type represents customercreditcardpaymentmethod data structures used in API requests and responses.
|
|
451
|
+
*
|
|
452
|
+
* @example
|
|
453
|
+
* ```typescript
|
|
454
|
+
* const response = await api.getCustomerCreditCardPaymentMethod();
|
|
455
|
+
* const item: CustomerCreditCardPaymentMethod = response.results;
|
|
456
|
+
* ```
|
|
457
|
+
*
|
|
458
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
459
|
+
*/
|
|
460
|
+
export type CustomerCreditCardPaymentMethod = components['schemas']['CustomerCreditCardPaymentMethod'];
|
|
365
461
|
/**
|
|
366
462
|
* DeletePolicyType
|
|
367
463
|
*
|
|
@@ -1903,6 +1999,22 @@ export type OrganizationWithBillingData = components['schemas']['OrganizationWit
|
|
|
1903
1999
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1904
2000
|
*/
|
|
1905
2001
|
export type PaginationMetadata = components['schemas']['PaginationMetadata'];
|
|
2002
|
+
/**
|
|
2003
|
+
* Pagination[BillingTransactionResponse]
|
|
2004
|
+
*
|
|
2005
|
+
* @remarks
|
|
2006
|
+
* Type alias for the `Pagination_BillingTransactionResponse_` OpenAPI schema.
|
|
2007
|
+
* This type represents pagination[billingtransactionresponse] data structures used in API requests and responses.
|
|
2008
|
+
*
|
|
2009
|
+
* @example
|
|
2010
|
+
* ```typescript
|
|
2011
|
+
* const response = await api.getPagination_BillingTransaction();
|
|
2012
|
+
* const item: Pagination_BillingTransaction = response.results;
|
|
2013
|
+
* ```
|
|
2014
|
+
*
|
|
2015
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2016
|
+
*/
|
|
2017
|
+
export type Pagination_BillingTransaction = components['schemas']['Pagination_BillingTransactionResponse_'];
|
|
1906
2018
|
/**
|
|
1907
2019
|
* Pagination[ContactSchema]
|
|
1908
2020
|
*
|
|
@@ -2863,6 +2975,54 @@ export type ValidationError = components['schemas']['ValidationError'];
|
|
|
2863
2975
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2864
2976
|
*/
|
|
2865
2977
|
export type VerificationType = components['schemas']['VerificationType'];
|
|
2978
|
+
/**
|
|
2979
|
+
* WalletCreditRequest
|
|
2980
|
+
*
|
|
2981
|
+
* @remarks
|
|
2982
|
+
* Type alias for the `WalletCreditRequest` OpenAPI schema.
|
|
2983
|
+
* This type represents walletcreditrequest data structures used in API requests and responses.
|
|
2984
|
+
*
|
|
2985
|
+
* @example
|
|
2986
|
+
* ```typescript
|
|
2987
|
+
* const response = await api.getWalletCreditRequest();
|
|
2988
|
+
* const item: WalletCreditRequest = response.results;
|
|
2989
|
+
* ```
|
|
2990
|
+
*
|
|
2991
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2992
|
+
*/
|
|
2993
|
+
export type WalletCreditRequest = components['schemas']['WalletCreditRequest'];
|
|
2994
|
+
/**
|
|
2995
|
+
* WalletCreditResponseStatus
|
|
2996
|
+
*
|
|
2997
|
+
* @remarks
|
|
2998
|
+
* Type alias for the `WalletCreditResponseStatus` OpenAPI schema.
|
|
2999
|
+
* This type represents walletcreditresponsestatus data structures used in API requests and responses.
|
|
3000
|
+
*
|
|
3001
|
+
* @example
|
|
3002
|
+
* ```typescript
|
|
3003
|
+
* const response = await api.getWalletCreditResponseStatus();
|
|
3004
|
+
* const item: WalletCreditResponseStatus = response.results;
|
|
3005
|
+
* ```
|
|
3006
|
+
*
|
|
3007
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3008
|
+
*/
|
|
3009
|
+
export type WalletCreditResponseStatus = components['schemas']['WalletCreditResponseStatus'];
|
|
3010
|
+
/**
|
|
3011
|
+
* WalletCreditResponseWithBalance
|
|
3012
|
+
*
|
|
3013
|
+
* @remarks
|
|
3014
|
+
* Type alias for the `WalletCreditResponseWithBalance` OpenAPI schema.
|
|
3015
|
+
* This type represents walletcreditresponsewithbalance data structures used in API requests and responses.
|
|
3016
|
+
*
|
|
3017
|
+
* @example
|
|
3018
|
+
* ```typescript
|
|
3019
|
+
* const response = await api.getWalletCreditResponseWithBalance();
|
|
3020
|
+
* const item: WalletCreditResponseWithBalance = response.results;
|
|
3021
|
+
* ```
|
|
3022
|
+
*
|
|
3023
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3024
|
+
*/
|
|
3025
|
+
export type WalletCreditResponseWithBalance = components['schemas']['WalletCreditResponseWithBalance'];
|
|
2866
3026
|
/**
|
|
2867
3027
|
* WhoisBase
|
|
2868
3028
|
*
|