@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.
@@ -34,7 +34,7 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, CheckoutSessionRequest, WalletCreditRequest, PlanUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET AuthClientCredentials endpoint
@@ -2991,6 +2991,224 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
2991
2991
  */
2992
2992
  export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
2993
2993
 
2994
+ /**
2995
+ * Request type for POST OrganizationsOrganizationIdBillingCheckoutSessions endpoint
2996
+ *
2997
+ * Get Checkout Session
2998
+ *
2999
+ * @remarks
3000
+ * This type defines the complete request structure for the POST OrganizationsOrganizationIdBillingCheckoutSessions endpoint.
3001
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3002
+ * Use this type to ensure type safety when making API requests to this endpoint.
3003
+ *
3004
+ * @example
3005
+ * Use this type to ensure type safety when making API requests to this endpoint.
3006
+ *
3007
+ * @path /v1/organizations/{organization_id}/billing/checkout-sessions
3008
+ *
3009
+ * @see {@link POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Query} - Query parameters type
3010
+ * @see {@link POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Path} - Path parameters type
3011
+ * @see {@link POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Body} - Request body type
3012
+ */
3013
+ export type POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request = {
3014
+ parameters: {
3015
+ path: operations['get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post']['parameters']['path'];
3016
+ };
3017
+ requestBody: CheckoutSessionRequest;
3018
+ }
3019
+ /**
3020
+ * Path parameters for POST /v1/organizations/{organization_id}/billing/checkout-sessions
3021
+ *
3022
+ * @remarks
3023
+ * This type defines the path parameters for the POST /v1/organizations/{organization_id}/billing/checkout-sessions endpoint.
3024
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3025
+ *
3026
+ * @example
3027
+ * Use this type to ensure type safety for path parameters.
3028
+ *
3029
+ * @path /v1/organizations/{organization_id}/billing/checkout-sessions
3030
+ */
3031
+ export type POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Path = POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request['parameters']['path'];
3032
+ /**
3033
+ * Request body for POST /v1/organizations/{organization_id}/billing/checkout-sessions
3034
+ *
3035
+ * @remarks
3036
+ * This type defines the request body structure for the POST /v1/organizations/{organization_id}/billing/checkout-sessions endpoint.
3037
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3038
+ *
3039
+ * @example
3040
+ * Use this type to ensure type safety for request body structure.
3041
+ *
3042
+ * @path /v1/organizations/{organization_id}/billing/checkout-sessions
3043
+ */
3044
+ export type POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request_Body = POST_OrganizationsOrganizationIdBillingCheckoutSessions_Request['requestBody'];
3045
+
3046
+ /**
3047
+ * Request type for GET OrganizationsOrganizationIdBillingPaymentMethods endpoint
3048
+ *
3049
+ * List Payment Methods
3050
+ *
3051
+ * @remarks
3052
+ * This type defines the complete request structure for the GET OrganizationsOrganizationIdBillingPaymentMethods endpoint.
3053
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3054
+ * Use this type to ensure type safety when making API requests to this endpoint.
3055
+ *
3056
+ * @example
3057
+ * Use this type to ensure type safety when making API requests to this endpoint.
3058
+ *
3059
+ * @path /v1/organizations/{organization_id}/billing/payment-methods
3060
+ *
3061
+ * @see {@link GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Query} - Query parameters type
3062
+ * @see {@link GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Path} - Path parameters type
3063
+ * @see {@link GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Body} - Request body type
3064
+ */
3065
+ export type GET_OrganizationsOrganizationIdBillingPaymentMethods_Request = {
3066
+ parameters: {
3067
+ path: operations['list_payment_methods_v1_organizations__organization_id__billing_payment_methods_get']['parameters']['path'];
3068
+ };
3069
+ }
3070
+ /**
3071
+ * Path parameters for GET /v1/organizations/{organization_id}/billing/payment-methods
3072
+ *
3073
+ * @remarks
3074
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id}/billing/payment-methods endpoint.
3075
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3076
+ *
3077
+ * @example
3078
+ * Use this type to ensure type safety for path parameters.
3079
+ *
3080
+ * @path /v1/organizations/{organization_id}/billing/payment-methods
3081
+ */
3082
+ export type GET_OrganizationsOrganizationIdBillingPaymentMethods_Request_Path = GET_OrganizationsOrganizationIdBillingPaymentMethods_Request['parameters']['path'];
3083
+
3084
+ /**
3085
+ * Request type for DELETE OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId endpoint
3086
+ *
3087
+ * Delete Payment Method
3088
+ *
3089
+ * @remarks
3090
+ * This type defines the complete request structure for the DELETE OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId endpoint.
3091
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3092
+ * Use this type to ensure type safety when making API requests to this endpoint.
3093
+ *
3094
+ * @example
3095
+ * Use this type to ensure type safety when making API requests to this endpoint.
3096
+ *
3097
+ * @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
3098
+ *
3099
+ * @see {@link DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Query} - Query parameters type
3100
+ * @see {@link DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Path} - Path parameters type
3101
+ * @see {@link DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Body} - Request body type
3102
+ */
3103
+ export type DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request = {
3104
+ parameters: {
3105
+ path: operations['delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete']['parameters']['path'];
3106
+ };
3107
+ }
3108
+ /**
3109
+ * Path parameters for DELETE /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
3110
+ *
3111
+ * @remarks
3112
+ * This type defines the path parameters for the DELETE /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id} endpoint.
3113
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3114
+ *
3115
+ * @example
3116
+ * Use this type to ensure type safety for path parameters.
3117
+ *
3118
+ * @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}
3119
+ */
3120
+ export type DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request_Path = DELETE_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodId_Request['parameters']['path'];
3121
+
3122
+ /**
3123
+ * Request type for PATCH OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault endpoint
3124
+ *
3125
+ * Update Default Payment Method
3126
+ *
3127
+ * @remarks
3128
+ * This type defines the complete request structure for the PATCH OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault endpoint.
3129
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3130
+ * Use this type to ensure type safety when making API requests to this endpoint.
3131
+ *
3132
+ * @example
3133
+ * Use this type to ensure type safety when making API requests to this endpoint.
3134
+ *
3135
+ * @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
3136
+ *
3137
+ * @see {@link PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Query} - Query parameters type
3138
+ * @see {@link PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Path} - Path parameters type
3139
+ * @see {@link PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Body} - Request body type
3140
+ */
3141
+ export type PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request = {
3142
+ parameters: {
3143
+ path: operations['update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch']['parameters']['path'];
3144
+ };
3145
+ }
3146
+ /**
3147
+ * Path parameters for PATCH /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
3148
+ *
3149
+ * @remarks
3150
+ * This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default endpoint.
3151
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3152
+ *
3153
+ * @example
3154
+ * Use this type to ensure type safety for path parameters.
3155
+ *
3156
+ * @path /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default
3157
+ */
3158
+ export type PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request_Path = PATCH_OrganizationsOrganizationIdBillingPaymentMethodsPaymentMethodIdDefault_Request['parameters']['path'];
3159
+
3160
+ /**
3161
+ * Request type for POST OrganizationsOrganizationIdBillingWalletCredits endpoint
3162
+ *
3163
+ * Credit Wallet
3164
+ *
3165
+ * @remarks
3166
+ * This type defines the complete request structure for the POST OrganizationsOrganizationIdBillingWalletCredits endpoint.
3167
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3168
+ * Use this type to ensure type safety when making API requests to this endpoint.
3169
+ *
3170
+ * @example
3171
+ * Use this type to ensure type safety when making API requests to this endpoint.
3172
+ *
3173
+ * @path /v1/organizations/{organization_id}/billing/wallet/credits
3174
+ *
3175
+ * @see {@link POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Query} - Query parameters type
3176
+ * @see {@link POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Path} - Path parameters type
3177
+ * @see {@link POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Body} - Request body type
3178
+ */
3179
+ export type POST_OrganizationsOrganizationIdBillingWalletCredits_Request = {
3180
+ parameters: {
3181
+ path: operations['credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post']['parameters']['path'];
3182
+ };
3183
+ requestBody: WalletCreditRequest;
3184
+ }
3185
+ /**
3186
+ * Path parameters for POST /v1/organizations/{organization_id}/billing/wallet/credits
3187
+ *
3188
+ * @remarks
3189
+ * This type defines the path parameters for the POST /v1/organizations/{organization_id}/billing/wallet/credits endpoint.
3190
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3191
+ *
3192
+ * @example
3193
+ * Use this type to ensure type safety for path parameters.
3194
+ *
3195
+ * @path /v1/organizations/{organization_id}/billing/wallet/credits
3196
+ */
3197
+ export type POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Path = POST_OrganizationsOrganizationIdBillingWalletCredits_Request['parameters']['path'];
3198
+ /**
3199
+ * Request body for POST /v1/organizations/{organization_id}/billing/wallet/credits
3200
+ *
3201
+ * @remarks
3202
+ * This type defines the request body structure for the POST /v1/organizations/{organization_id}/billing/wallet/credits endpoint.
3203
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3204
+ *
3205
+ * @example
3206
+ * Use this type to ensure type safety for request body structure.
3207
+ *
3208
+ * @path /v1/organizations/{organization_id}/billing/wallet/credits
3209
+ */
3210
+ export type POST_OrganizationsOrganizationIdBillingWalletCredits_Request_Body = POST_OrganizationsOrganizationIdBillingWalletCredits_Request['requestBody'];
3211
+
2994
3212
  /**
2995
3213
  * Request type for PATCH OrganizationsOrganizationIdPlan endpoint
2996
3214
  *
@@ -3133,6 +3351,96 @@ export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request
3133
3351
  */
3134
3352
  export type GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request_Path = GET_OrganizationsOrganizationIdPricingProductTypeProductType_Request['parameters']['path'];
3135
3353
 
3354
+ /**
3355
+ * Request type for GET OrganizationsOrganizationIdTransactions endpoint
3356
+ *
3357
+ * Get transactions for an organization
3358
+ *
3359
+ * @remarks
3360
+ * This type defines the complete request structure for the GET OrganizationsOrganizationIdTransactions endpoint.
3361
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3362
+ * Use this type to ensure type safety when making API requests to this endpoint.
3363
+ *
3364
+ * @example
3365
+ * Use this type to ensure type safety when making API requests to this endpoint.
3366
+ *
3367
+ * @path /v1/organizations/{organization_id}/transactions
3368
+ *
3369
+ * @see {@link GET_OrganizationsOrganizationIdTransactions_Request_Query} - Query parameters type
3370
+ * @see {@link GET_OrganizationsOrganizationIdTransactions_Request_Path} - Path parameters type
3371
+ * @see {@link GET_OrganizationsOrganizationIdTransactions_Request_Body} - Request body type
3372
+ */
3373
+ export type GET_OrganizationsOrganizationIdTransactions_Request = {
3374
+ parameters: {
3375
+ query: operations['get_transactions_v1_organizations__organization_id__transactions_get']['parameters']['query'];
3376
+ path: operations['get_transactions_v1_organizations__organization_id__transactions_get']['parameters']['path'];
3377
+ };
3378
+ }
3379
+ /**
3380
+ * Query parameters for GET /v1/organizations/{organization_id}/transactions
3381
+ *
3382
+ * @remarks
3383
+ * This type defines the query parameters for the GET /v1/organizations/{organization_id}/transactions endpoint.
3384
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
3385
+ *
3386
+ * @example
3387
+ * Use this type to ensure type safety for query parameters.
3388
+ *
3389
+ * @path /v1/organizations/{organization_id}/transactions
3390
+ */
3391
+ export type GET_OrganizationsOrganizationIdTransactions_Request_Query = GET_OrganizationsOrganizationIdTransactions_Request['parameters']['query'];
3392
+ /**
3393
+ * Path parameters for GET /v1/organizations/{organization_id}/transactions
3394
+ *
3395
+ * @remarks
3396
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id}/transactions endpoint.
3397
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3398
+ *
3399
+ * @example
3400
+ * Use this type to ensure type safety for path parameters.
3401
+ *
3402
+ * @path /v1/organizations/{organization_id}/transactions
3403
+ */
3404
+ export type GET_OrganizationsOrganizationIdTransactions_Request_Path = GET_OrganizationsOrganizationIdTransactions_Request['parameters']['path'];
3405
+
3406
+ /**
3407
+ * Request type for GET OrganizationsOrganizationIdTransactionsTransactionId endpoint
3408
+ *
3409
+ * Get a specific transaction for an organization
3410
+ *
3411
+ * @remarks
3412
+ * This type defines the complete request structure for the GET OrganizationsOrganizationIdTransactionsTransactionId endpoint.
3413
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3414
+ * Use this type to ensure type safety when making API requests to this endpoint.
3415
+ *
3416
+ * @example
3417
+ * Use this type to ensure type safety when making API requests to this endpoint.
3418
+ *
3419
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
3420
+ *
3421
+ * @see {@link GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Query} - Query parameters type
3422
+ * @see {@link GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Path} - Path parameters type
3423
+ * @see {@link GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Body} - Request body type
3424
+ */
3425
+ export type GET_OrganizationsOrganizationIdTransactionsTransactionId_Request = {
3426
+ parameters: {
3427
+ path: operations['get_transaction_v1_organizations__organization_id__transactions__transaction_id__get']['parameters']['path'];
3428
+ };
3429
+ }
3430
+ /**
3431
+ * Path parameters for GET /v1/organizations/{organization_id}/transactions/{transaction_id}
3432
+ *
3433
+ * @remarks
3434
+ * This type defines the path parameters for the GET /v1/organizations/{organization_id}/transactions/{transaction_id} endpoint.
3435
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3436
+ *
3437
+ * @example
3438
+ * Use this type to ensure type safety for path parameters.
3439
+ *
3440
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
3441
+ */
3442
+ export type GET_OrganizationsOrganizationIdTransactionsTransactionId_Request_Path = GET_OrganizationsOrganizationIdTransactionsTransactionId_Request['parameters']['path'];
3443
+
3136
3444
  /**
3137
3445
  * Request type for GET OrganizationsRoles endpoint
3138
3446
  *