@opusdns/api 0.62.0 → 0.64.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 +51 -57
- package/src/helpers/keys.ts +605 -50
- package/src/helpers/requests.d.ts +220 -2
- package/src/helpers/responses.d.ts +259 -2
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +108 -28
- package/src/openapi.yaml +325 -18
- package/src/schema.d.ts +354 -11
package/src/helpers/keys.ts
CHANGED
|
@@ -34,6 +34,8 @@ import { BillingMetadata } from './schemas';
|
|
|
34
34
|
import { BillingPlan } from './schemas';
|
|
35
35
|
import { BillingTransaction } from './schemas';
|
|
36
36
|
import { Body_issue_organization_token_v1_auth_token_post } from './schemas';
|
|
37
|
+
import { CheckoutSessionRequest } from './schemas';
|
|
38
|
+
import { CheckoutSession } from './schemas';
|
|
37
39
|
import { ContactConfigBase } from './schemas';
|
|
38
40
|
import { ContactCreate } from './schemas';
|
|
39
41
|
import { ContactHandle } from './schemas';
|
|
@@ -43,6 +45,7 @@ import { ContactVerificationApi } from './schemas';
|
|
|
43
45
|
import { ContactVerificationEmail } from './schemas';
|
|
44
46
|
import { ContactVerification } from './schemas';
|
|
45
47
|
import { ContactsBase } from './schemas';
|
|
48
|
+
import { CustomerCreditCardPaymentMethod } from './schemas';
|
|
46
49
|
import { DnsChange } from './schemas';
|
|
47
50
|
import { DnsChanges } from './schemas';
|
|
48
51
|
import { DnsConfigurationBase } from './schemas';
|
|
@@ -117,8 +120,8 @@ import { PaginationMetadata } from './schemas';
|
|
|
117
120
|
import { PasswordUpdate } from './schemas';
|
|
118
121
|
import { Period } from './schemas';
|
|
119
122
|
import { PermissionSet } from './schemas';
|
|
123
|
+
import { PlanIdRequest } from './schemas';
|
|
120
124
|
import { PlanInfo } from './schemas';
|
|
121
|
-
import { PlanUpdate } from './schemas';
|
|
122
125
|
import { PremiumDomainsBase } from './schemas';
|
|
123
126
|
import { PriceInfo } from './schemas';
|
|
124
127
|
import { PricingPeriod } from './schemas';
|
|
@@ -146,6 +149,8 @@ import { UserUpdate } from './schemas';
|
|
|
146
149
|
import { UserWithAttributes } from './schemas';
|
|
147
150
|
import { UserWithRelationPermissions } from './schemas';
|
|
148
151
|
import { ValidationError } from './schemas';
|
|
152
|
+
import { WalletCreditRequest } from './schemas';
|
|
153
|
+
import { WalletCreditResponseWithBalance } from './schemas';
|
|
149
154
|
import { WhoisBase } from './schemas';
|
|
150
155
|
import { DomainAvailabilityList } from './schemas';
|
|
151
156
|
import { DomainAvailabilityCheck } from './schemas';
|
|
@@ -873,6 +878,108 @@ export const KEYS_BODY_ISSUE_ORGANIZATION_TOKEN_V1_AUTH_TOKEN_POST = [
|
|
|
873
878
|
KEY_BODY_ISSUE_ORGANIZATION_TOKEN_V1_AUTH_TOKEN_POST_USERNAME,
|
|
874
879
|
] as const satisfies (keyof Body_issue_organization_token_v1_auth_token_post)[];
|
|
875
880
|
|
|
881
|
+
/**
|
|
882
|
+
* Return Url
|
|
883
|
+
*
|
|
884
|
+
* Return URL that will be used
|
|
885
|
+
*
|
|
886
|
+
* @type {string}
|
|
887
|
+
*
|
|
888
|
+
*
|
|
889
|
+
* @remarks
|
|
890
|
+
* This key constant provides type-safe access to the `return_url` property of CheckoutSessionRequest objects.
|
|
891
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
892
|
+
*
|
|
893
|
+
* @example
|
|
894
|
+
* ```typescript
|
|
895
|
+
* // Direct property access
|
|
896
|
+
* const value = checkoutsessionrequest[KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL];
|
|
897
|
+
*
|
|
898
|
+
* // Dynamic property access
|
|
899
|
+
* const propertyName = KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL;
|
|
900
|
+
* const value = checkoutsessionrequest[propertyName];
|
|
901
|
+
* ```
|
|
902
|
+
*
|
|
903
|
+
* @see {@link CheckoutSessionRequest} - The TypeScript type definition
|
|
904
|
+
* @see {@link KEYS_CHECKOUT_SESSION_REQUEST} - Array of all keys for this type
|
|
905
|
+
*/
|
|
906
|
+
export const KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL = 'return_url' as keyof CheckoutSessionRequest;
|
|
907
|
+
|
|
908
|
+
/**
|
|
909
|
+
* Array of all CheckoutSessionRequest property keys
|
|
910
|
+
*
|
|
911
|
+
* @remarks
|
|
912
|
+
* This constant provides a readonly array containing all valid property keys for CheckoutSessionRequest objects.
|
|
913
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
914
|
+
*
|
|
915
|
+
* @example
|
|
916
|
+
* ```typescript
|
|
917
|
+
* // Iterating through all keys
|
|
918
|
+
* for (const key of KEYS_CHECKOUT_SESSION_REQUEST) {
|
|
919
|
+
* console.log(`Property: ${key}, Value: ${checkoutsessionrequest[key]}`);
|
|
920
|
+
* }
|
|
921
|
+
*
|
|
922
|
+
* // Validation
|
|
923
|
+
* const isValidKey = KEYS_CHECKOUT_SESSION_REQUEST.includes(someKey);
|
|
924
|
+
* ```
|
|
925
|
+
*
|
|
926
|
+
* @see {@link CheckoutSessionRequest} - The TypeScript type definition
|
|
927
|
+
*/
|
|
928
|
+
export const KEYS_CHECKOUT_SESSION_REQUEST = [
|
|
929
|
+
KEY_CHECKOUT_SESSION_REQUEST_RETURN_URL,
|
|
930
|
+
] as const satisfies (keyof CheckoutSessionRequest)[];
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* Session Client Secret
|
|
934
|
+
*
|
|
935
|
+
* Checkout session client secret - meant to be used in the embedded checkout
|
|
936
|
+
*
|
|
937
|
+
* @type {string}
|
|
938
|
+
*
|
|
939
|
+
*
|
|
940
|
+
* @remarks
|
|
941
|
+
* This key constant provides type-safe access to the `session_client_secret` property of CheckoutSession objects.
|
|
942
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
943
|
+
*
|
|
944
|
+
* @example
|
|
945
|
+
* ```typescript
|
|
946
|
+
* // Direct property access
|
|
947
|
+
* const value = checkoutsession[KEY_CHECKOUT_SESSION_SESSION_CLIENT_SECRET];
|
|
948
|
+
*
|
|
949
|
+
* // Dynamic property access
|
|
950
|
+
* const propertyName = KEY_CHECKOUT_SESSION_SESSION_CLIENT_SECRET;
|
|
951
|
+
* const value = checkoutsession[propertyName];
|
|
952
|
+
* ```
|
|
953
|
+
*
|
|
954
|
+
* @see {@link CheckoutSession} - The TypeScript type definition
|
|
955
|
+
* @see {@link KEYS_CHECKOUT_SESSION} - Array of all keys for this type
|
|
956
|
+
*/
|
|
957
|
+
export const KEY_CHECKOUT_SESSION_SESSION_CLIENT_SECRET = 'session_client_secret' as keyof CheckoutSession;
|
|
958
|
+
|
|
959
|
+
/**
|
|
960
|
+
* Array of all CheckoutSession property keys
|
|
961
|
+
*
|
|
962
|
+
* @remarks
|
|
963
|
+
* This constant provides a readonly array containing all valid property keys for CheckoutSession objects.
|
|
964
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
965
|
+
*
|
|
966
|
+
* @example
|
|
967
|
+
* ```typescript
|
|
968
|
+
* // Iterating through all keys
|
|
969
|
+
* for (const key of KEYS_CHECKOUT_SESSION) {
|
|
970
|
+
* console.log(`Property: ${key}, Value: ${checkoutsession[key]}`);
|
|
971
|
+
* }
|
|
972
|
+
*
|
|
973
|
+
* // Validation
|
|
974
|
+
* const isValidKey = KEYS_CHECKOUT_SESSION.includes(someKey);
|
|
975
|
+
* ```
|
|
976
|
+
*
|
|
977
|
+
* @see {@link CheckoutSession} - The TypeScript type definition
|
|
978
|
+
*/
|
|
979
|
+
export const KEYS_CHECKOUT_SESSION = [
|
|
980
|
+
KEY_CHECKOUT_SESSION_SESSION_CLIENT_SECRET,
|
|
981
|
+
] as const satisfies (keyof CheckoutSession)[];
|
|
982
|
+
|
|
876
983
|
/**
|
|
877
984
|
* Max
|
|
878
985
|
*
|
|
@@ -3263,6 +3370,218 @@ export const KEYS_CONTACTS_BASE = [
|
|
|
3263
3370
|
KEY_CONTACTS_BASE_SUPPORTED_ROLES,
|
|
3264
3371
|
] as const satisfies (keyof ContactsBase)[];
|
|
3265
3372
|
|
|
3373
|
+
/**
|
|
3374
|
+
* Brand
|
|
3375
|
+
*
|
|
3376
|
+
* Card brand
|
|
3377
|
+
*
|
|
3378
|
+
* @type {string}
|
|
3379
|
+
*
|
|
3380
|
+
*
|
|
3381
|
+
* @remarks
|
|
3382
|
+
* This key constant provides type-safe access to the `brand` property of CustomerCreditCardPaymentMethod objects.
|
|
3383
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3384
|
+
*
|
|
3385
|
+
* @example
|
|
3386
|
+
* ```typescript
|
|
3387
|
+
* // Direct property access
|
|
3388
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_BRAND];
|
|
3389
|
+
*
|
|
3390
|
+
* // Dynamic property access
|
|
3391
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_BRAND;
|
|
3392
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3393
|
+
* ```
|
|
3394
|
+
*
|
|
3395
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3396
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3397
|
+
*/
|
|
3398
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_BRAND = 'brand' as keyof CustomerCreditCardPaymentMethod;
|
|
3399
|
+
/**
|
|
3400
|
+
* Country
|
|
3401
|
+
*
|
|
3402
|
+
* Country code
|
|
3403
|
+
*
|
|
3404
|
+
*
|
|
3405
|
+
*
|
|
3406
|
+
* @remarks
|
|
3407
|
+
* This key constant provides type-safe access to the `country` property of CustomerCreditCardPaymentMethod objects.
|
|
3408
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3409
|
+
*
|
|
3410
|
+
* @example
|
|
3411
|
+
* ```typescript
|
|
3412
|
+
* // Direct property access
|
|
3413
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_COUNTRY];
|
|
3414
|
+
*
|
|
3415
|
+
* // Dynamic property access
|
|
3416
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_COUNTRY;
|
|
3417
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3418
|
+
* ```
|
|
3419
|
+
*
|
|
3420
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3421
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3422
|
+
*/
|
|
3423
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_COUNTRY = 'country' as keyof CustomerCreditCardPaymentMethod;
|
|
3424
|
+
/**
|
|
3425
|
+
* Exp Month
|
|
3426
|
+
*
|
|
3427
|
+
* Expiration month
|
|
3428
|
+
*
|
|
3429
|
+
* @type {integer}
|
|
3430
|
+
*
|
|
3431
|
+
*
|
|
3432
|
+
* @remarks
|
|
3433
|
+
* This key constant provides type-safe access to the `exp_month` property of CustomerCreditCardPaymentMethod objects.
|
|
3434
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3435
|
+
*
|
|
3436
|
+
* @example
|
|
3437
|
+
* ```typescript
|
|
3438
|
+
* // Direct property access
|
|
3439
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_MONTH];
|
|
3440
|
+
*
|
|
3441
|
+
* // Dynamic property access
|
|
3442
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_MONTH;
|
|
3443
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3444
|
+
* ```
|
|
3445
|
+
*
|
|
3446
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3447
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3448
|
+
*/
|
|
3449
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_MONTH = 'exp_month' as keyof CustomerCreditCardPaymentMethod;
|
|
3450
|
+
/**
|
|
3451
|
+
* Exp Year
|
|
3452
|
+
*
|
|
3453
|
+
* Expiration year
|
|
3454
|
+
*
|
|
3455
|
+
* @type {integer}
|
|
3456
|
+
*
|
|
3457
|
+
*
|
|
3458
|
+
* @remarks
|
|
3459
|
+
* This key constant provides type-safe access to the `exp_year` property of CustomerCreditCardPaymentMethod objects.
|
|
3460
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3461
|
+
*
|
|
3462
|
+
* @example
|
|
3463
|
+
* ```typescript
|
|
3464
|
+
* // Direct property access
|
|
3465
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_YEAR];
|
|
3466
|
+
*
|
|
3467
|
+
* // Dynamic property access
|
|
3468
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_YEAR;
|
|
3469
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3470
|
+
* ```
|
|
3471
|
+
*
|
|
3472
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3473
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3474
|
+
*/
|
|
3475
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_YEAR = 'exp_year' as keyof CustomerCreditCardPaymentMethod;
|
|
3476
|
+
/**
|
|
3477
|
+
* Id
|
|
3478
|
+
*
|
|
3479
|
+
* Payment method ID
|
|
3480
|
+
*
|
|
3481
|
+
* @type {string}
|
|
3482
|
+
*
|
|
3483
|
+
*
|
|
3484
|
+
* @remarks
|
|
3485
|
+
* This key constant provides type-safe access to the `id` property of CustomerCreditCardPaymentMethod objects.
|
|
3486
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3487
|
+
*
|
|
3488
|
+
* @example
|
|
3489
|
+
* ```typescript
|
|
3490
|
+
* // Direct property access
|
|
3491
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_ID];
|
|
3492
|
+
*
|
|
3493
|
+
* // Dynamic property access
|
|
3494
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_ID;
|
|
3495
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3496
|
+
* ```
|
|
3497
|
+
*
|
|
3498
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3499
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3500
|
+
*/
|
|
3501
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_ID = 'id' as keyof CustomerCreditCardPaymentMethod;
|
|
3502
|
+
/**
|
|
3503
|
+
* Is Default
|
|
3504
|
+
*
|
|
3505
|
+
* Whether this is the default payment method
|
|
3506
|
+
*
|
|
3507
|
+
* @type {boolean}
|
|
3508
|
+
*
|
|
3509
|
+
*
|
|
3510
|
+
* @remarks
|
|
3511
|
+
* This key constant provides type-safe access to the `is_default` property of CustomerCreditCardPaymentMethod objects.
|
|
3512
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3513
|
+
*
|
|
3514
|
+
* @example
|
|
3515
|
+
* ```typescript
|
|
3516
|
+
* // Direct property access
|
|
3517
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_IS_DEFAULT];
|
|
3518
|
+
*
|
|
3519
|
+
* // Dynamic property access
|
|
3520
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_IS_DEFAULT;
|
|
3521
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3522
|
+
* ```
|
|
3523
|
+
*
|
|
3524
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3525
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3526
|
+
*/
|
|
3527
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_IS_DEFAULT = 'is_default' as keyof CustomerCreditCardPaymentMethod;
|
|
3528
|
+
/**
|
|
3529
|
+
* Last4
|
|
3530
|
+
*
|
|
3531
|
+
* Last four digits of the card
|
|
3532
|
+
*
|
|
3533
|
+
* @type {string}
|
|
3534
|
+
*
|
|
3535
|
+
*
|
|
3536
|
+
* @remarks
|
|
3537
|
+
* This key constant provides type-safe access to the `last4` property of CustomerCreditCardPaymentMethod objects.
|
|
3538
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3539
|
+
*
|
|
3540
|
+
* @example
|
|
3541
|
+
* ```typescript
|
|
3542
|
+
* // Direct property access
|
|
3543
|
+
* const value = customercreditcardpaymentmethod[KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_LAST4];
|
|
3544
|
+
*
|
|
3545
|
+
* // Dynamic property access
|
|
3546
|
+
* const propertyName = KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_LAST4;
|
|
3547
|
+
* const value = customercreditcardpaymentmethod[propertyName];
|
|
3548
|
+
* ```
|
|
3549
|
+
*
|
|
3550
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3551
|
+
* @see {@link KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD} - Array of all keys for this type
|
|
3552
|
+
*/
|
|
3553
|
+
export const KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_LAST4 = 'last4' as keyof CustomerCreditCardPaymentMethod;
|
|
3554
|
+
|
|
3555
|
+
/**
|
|
3556
|
+
* Array of all CustomerCreditCardPaymentMethod property keys
|
|
3557
|
+
*
|
|
3558
|
+
* @remarks
|
|
3559
|
+
* This constant provides a readonly array containing all valid property keys for CustomerCreditCardPaymentMethod objects.
|
|
3560
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
3561
|
+
*
|
|
3562
|
+
* @example
|
|
3563
|
+
* ```typescript
|
|
3564
|
+
* // Iterating through all keys
|
|
3565
|
+
* for (const key of KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD) {
|
|
3566
|
+
* console.log(`Property: ${key}, Value: ${customercreditcardpaymentmethod[key]}`);
|
|
3567
|
+
* }
|
|
3568
|
+
*
|
|
3569
|
+
* // Validation
|
|
3570
|
+
* const isValidKey = KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD.includes(someKey);
|
|
3571
|
+
* ```
|
|
3572
|
+
*
|
|
3573
|
+
* @see {@link CustomerCreditCardPaymentMethod} - The TypeScript type definition
|
|
3574
|
+
*/
|
|
3575
|
+
export const KEYS_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD = [
|
|
3576
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_BRAND,
|
|
3577
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_COUNTRY,
|
|
3578
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_MONTH,
|
|
3579
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_EXP_YEAR,
|
|
3580
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_ID,
|
|
3581
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_IS_DEFAULT,
|
|
3582
|
+
KEY_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD_LAST4,
|
|
3583
|
+
] as const satisfies (keyof CustomerCreditCardPaymentMethod)[];
|
|
3584
|
+
|
|
3266
3585
|
/**
|
|
3267
3586
|
* action property
|
|
3268
3587
|
*
|
|
@@ -14192,6 +14511,57 @@ export const KEYS_PERMISSION_SET = [
|
|
|
14192
14511
|
KEY_PERMISSION_SET_PERMISSIONS,
|
|
14193
14512
|
] as const satisfies (keyof PermissionSet)[];
|
|
14194
14513
|
|
|
14514
|
+
/**
|
|
14515
|
+
* Plan Id
|
|
14516
|
+
*
|
|
14517
|
+
* Plan ID from available plans
|
|
14518
|
+
*
|
|
14519
|
+
* @type {string}
|
|
14520
|
+
*
|
|
14521
|
+
*
|
|
14522
|
+
* @remarks
|
|
14523
|
+
* This key constant provides type-safe access to the `plan_id` property of PlanIdRequest objects.
|
|
14524
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14525
|
+
*
|
|
14526
|
+
* @example
|
|
14527
|
+
* ```typescript
|
|
14528
|
+
* // Direct property access
|
|
14529
|
+
* const value = planidrequest[KEY_PLAN_ID_REQUEST_PLAN_ID];
|
|
14530
|
+
*
|
|
14531
|
+
* // Dynamic property access
|
|
14532
|
+
* const propertyName = KEY_PLAN_ID_REQUEST_PLAN_ID;
|
|
14533
|
+
* const value = planidrequest[propertyName];
|
|
14534
|
+
* ```
|
|
14535
|
+
*
|
|
14536
|
+
* @see {@link PlanIdRequest} - The TypeScript type definition
|
|
14537
|
+
* @see {@link KEYS_PLAN_ID_REQUEST} - Array of all keys for this type
|
|
14538
|
+
*/
|
|
14539
|
+
export const KEY_PLAN_ID_REQUEST_PLAN_ID = 'plan_id' as keyof PlanIdRequest;
|
|
14540
|
+
|
|
14541
|
+
/**
|
|
14542
|
+
* Array of all PlanIdRequest property keys
|
|
14543
|
+
*
|
|
14544
|
+
* @remarks
|
|
14545
|
+
* This constant provides a readonly array containing all valid property keys for PlanIdRequest objects.
|
|
14546
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
14547
|
+
*
|
|
14548
|
+
* @example
|
|
14549
|
+
* ```typescript
|
|
14550
|
+
* // Iterating through all keys
|
|
14551
|
+
* for (const key of KEYS_PLAN_ID_REQUEST) {
|
|
14552
|
+
* console.log(`Property: ${key}, Value: ${planidrequest[key]}`);
|
|
14553
|
+
* }
|
|
14554
|
+
*
|
|
14555
|
+
* // Validation
|
|
14556
|
+
* const isValidKey = KEYS_PLAN_ID_REQUEST.includes(someKey);
|
|
14557
|
+
* ```
|
|
14558
|
+
*
|
|
14559
|
+
* @see {@link PlanIdRequest} - The TypeScript type definition
|
|
14560
|
+
*/
|
|
14561
|
+
export const KEYS_PLAN_ID_REQUEST = [
|
|
14562
|
+
KEY_PLAN_ID_REQUEST_PLAN_ID,
|
|
14563
|
+
] as const satisfies (keyof PlanIdRequest)[];
|
|
14564
|
+
|
|
14195
14565
|
/**
|
|
14196
14566
|
* Amount
|
|
14197
14567
|
*
|
|
@@ -14375,55 +14745,6 @@ export const KEYS_PLAN_INFO = [
|
|
|
14375
14745
|
KEY_PLAN_INFO_PLAN_TYPE,
|
|
14376
14746
|
] as const satisfies (keyof PlanInfo)[];
|
|
14377
14747
|
|
|
14378
|
-
/**
|
|
14379
|
-
* plan property
|
|
14380
|
-
*
|
|
14381
|
-
*
|
|
14382
|
-
*
|
|
14383
|
-
*
|
|
14384
|
-
* @remarks
|
|
14385
|
-
* This key constant provides type-safe access to the `plan` property of PlanUpdate objects.
|
|
14386
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14387
|
-
*
|
|
14388
|
-
* @example
|
|
14389
|
-
* ```typescript
|
|
14390
|
-
* // Direct property access
|
|
14391
|
-
* const value = planupdate[KEY_PLAN_UPDATE_PLAN];
|
|
14392
|
-
*
|
|
14393
|
-
* // Dynamic property access
|
|
14394
|
-
* const propertyName = KEY_PLAN_UPDATE_PLAN;
|
|
14395
|
-
* const value = planupdate[propertyName];
|
|
14396
|
-
* ```
|
|
14397
|
-
*
|
|
14398
|
-
* @see {@link PlanUpdate} - The TypeScript type definition
|
|
14399
|
-
* @see {@link KEYS_PLAN_UPDATE} - Array of all keys for this type
|
|
14400
|
-
*/
|
|
14401
|
-
export const KEY_PLAN_UPDATE_PLAN = 'plan' as keyof PlanUpdate;
|
|
14402
|
-
|
|
14403
|
-
/**
|
|
14404
|
-
* Array of all PlanUpdate property keys
|
|
14405
|
-
*
|
|
14406
|
-
* @remarks
|
|
14407
|
-
* This constant provides a readonly array containing all valid property keys for PlanUpdate objects.
|
|
14408
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
14409
|
-
*
|
|
14410
|
-
* @example
|
|
14411
|
-
* ```typescript
|
|
14412
|
-
* // Iterating through all keys
|
|
14413
|
-
* for (const key of KEYS_PLAN_UPDATE) {
|
|
14414
|
-
* console.log(`Property: ${key}, Value: ${planupdate[key]}`);
|
|
14415
|
-
* }
|
|
14416
|
-
*
|
|
14417
|
-
* // Validation
|
|
14418
|
-
* const isValidKey = KEYS_PLAN_UPDATE.includes(someKey);
|
|
14419
|
-
* ```
|
|
14420
|
-
*
|
|
14421
|
-
* @see {@link PlanUpdate} - The TypeScript type definition
|
|
14422
|
-
*/
|
|
14423
|
-
export const KEYS_PLAN_UPDATE = [
|
|
14424
|
-
KEY_PLAN_UPDATE_PLAN,
|
|
14425
|
-
] as const satisfies (keyof PlanUpdate)[];
|
|
14426
|
-
|
|
14427
14748
|
/**
|
|
14428
14749
|
* Affects
|
|
14429
14750
|
*
|
|
@@ -18824,6 +19145,240 @@ export const KEYS_VALIDATION_ERROR = [
|
|
|
18824
19145
|
KEY_VALIDATION_ERROR_TYPE,
|
|
18825
19146
|
] as const satisfies (keyof ValidationError)[];
|
|
18826
19147
|
|
|
19148
|
+
/**
|
|
19149
|
+
* Amount
|
|
19150
|
+
*
|
|
19151
|
+
* Amount to credit the customer wallet
|
|
19152
|
+
*
|
|
19153
|
+
*
|
|
19154
|
+
*
|
|
19155
|
+
* @remarks
|
|
19156
|
+
* This key constant provides type-safe access to the `amount` property of WalletCreditRequest objects.
|
|
19157
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19158
|
+
*
|
|
19159
|
+
* @example
|
|
19160
|
+
* ```typescript
|
|
19161
|
+
* // Direct property access
|
|
19162
|
+
* const value = walletcreditrequest[KEY_WALLET_CREDIT_REQUEST_AMOUNT];
|
|
19163
|
+
*
|
|
19164
|
+
* // Dynamic property access
|
|
19165
|
+
* const propertyName = KEY_WALLET_CREDIT_REQUEST_AMOUNT;
|
|
19166
|
+
* const value = walletcreditrequest[propertyName];
|
|
19167
|
+
* ```
|
|
19168
|
+
*
|
|
19169
|
+
* @see {@link WalletCreditRequest} - The TypeScript type definition
|
|
19170
|
+
* @see {@link KEYS_WALLET_CREDIT_REQUEST} - Array of all keys for this type
|
|
19171
|
+
*/
|
|
19172
|
+
export const KEY_WALLET_CREDIT_REQUEST_AMOUNT = 'amount' as keyof WalletCreditRequest;
|
|
19173
|
+
/**
|
|
19174
|
+
* Payment Method Id
|
|
19175
|
+
*
|
|
19176
|
+
* Payment method ID that should be used
|
|
19177
|
+
*
|
|
19178
|
+
* @type {string}
|
|
19179
|
+
*
|
|
19180
|
+
*
|
|
19181
|
+
* @remarks
|
|
19182
|
+
* This key constant provides type-safe access to the `payment_method_id` property of WalletCreditRequest objects.
|
|
19183
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19184
|
+
*
|
|
19185
|
+
* @example
|
|
19186
|
+
* ```typescript
|
|
19187
|
+
* // Direct property access
|
|
19188
|
+
* const value = walletcreditrequest[KEY_WALLET_CREDIT_REQUEST_PAYMENT_METHOD_ID];
|
|
19189
|
+
*
|
|
19190
|
+
* // Dynamic property access
|
|
19191
|
+
* const propertyName = KEY_WALLET_CREDIT_REQUEST_PAYMENT_METHOD_ID;
|
|
19192
|
+
* const value = walletcreditrequest[propertyName];
|
|
19193
|
+
* ```
|
|
19194
|
+
*
|
|
19195
|
+
* @see {@link WalletCreditRequest} - The TypeScript type definition
|
|
19196
|
+
* @see {@link KEYS_WALLET_CREDIT_REQUEST} - Array of all keys for this type
|
|
19197
|
+
*/
|
|
19198
|
+
export const KEY_WALLET_CREDIT_REQUEST_PAYMENT_METHOD_ID = 'payment_method_id' as keyof WalletCreditRequest;
|
|
19199
|
+
|
|
19200
|
+
/**
|
|
19201
|
+
* Array of all WalletCreditRequest property keys
|
|
19202
|
+
*
|
|
19203
|
+
* @remarks
|
|
19204
|
+
* This constant provides a readonly array containing all valid property keys for WalletCreditRequest objects.
|
|
19205
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
19206
|
+
*
|
|
19207
|
+
* @example
|
|
19208
|
+
* ```typescript
|
|
19209
|
+
* // Iterating through all keys
|
|
19210
|
+
* for (const key of KEYS_WALLET_CREDIT_REQUEST) {
|
|
19211
|
+
* console.log(`Property: ${key}, Value: ${walletcreditrequest[key]}`);
|
|
19212
|
+
* }
|
|
19213
|
+
*
|
|
19214
|
+
* // Validation
|
|
19215
|
+
* const isValidKey = KEYS_WALLET_CREDIT_REQUEST.includes(someKey);
|
|
19216
|
+
* ```
|
|
19217
|
+
*
|
|
19218
|
+
* @see {@link WalletCreditRequest} - The TypeScript type definition
|
|
19219
|
+
*/
|
|
19220
|
+
export const KEYS_WALLET_CREDIT_REQUEST = [
|
|
19221
|
+
KEY_WALLET_CREDIT_REQUEST_AMOUNT,
|
|
19222
|
+
KEY_WALLET_CREDIT_REQUEST_PAYMENT_METHOD_ID,
|
|
19223
|
+
] as const satisfies (keyof WalletCreditRequest)[];
|
|
19224
|
+
|
|
19225
|
+
/**
|
|
19226
|
+
* Amount
|
|
19227
|
+
*
|
|
19228
|
+
* Amount credited to the customer wallet
|
|
19229
|
+
*
|
|
19230
|
+
* @type {string}
|
|
19231
|
+
*
|
|
19232
|
+
*
|
|
19233
|
+
* @remarks
|
|
19234
|
+
* This key constant provides type-safe access to the `amount` property of WalletCreditResponseWithBalance objects.
|
|
19235
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19236
|
+
*
|
|
19237
|
+
* @example
|
|
19238
|
+
* ```typescript
|
|
19239
|
+
* // Direct property access
|
|
19240
|
+
* const value = walletcreditresponsewithbalance[KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_AMOUNT];
|
|
19241
|
+
*
|
|
19242
|
+
* // Dynamic property access
|
|
19243
|
+
* const propertyName = KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_AMOUNT;
|
|
19244
|
+
* const value = walletcreditresponsewithbalance[propertyName];
|
|
19245
|
+
* ```
|
|
19246
|
+
*
|
|
19247
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19248
|
+
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19249
|
+
*/
|
|
19250
|
+
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_AMOUNT = 'amount' as keyof WalletCreditResponseWithBalance;
|
|
19251
|
+
/**
|
|
19252
|
+
* Balance
|
|
19253
|
+
*
|
|
19254
|
+
* Updated wallet balance after the credit
|
|
19255
|
+
*
|
|
19256
|
+
* @type {string}
|
|
19257
|
+
*
|
|
19258
|
+
*
|
|
19259
|
+
* @remarks
|
|
19260
|
+
* This key constant provides type-safe access to the `balance` property of WalletCreditResponseWithBalance objects.
|
|
19261
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19262
|
+
*
|
|
19263
|
+
* @example
|
|
19264
|
+
* ```typescript
|
|
19265
|
+
* // Direct property access
|
|
19266
|
+
* const value = walletcreditresponsewithbalance[KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_BALANCE];
|
|
19267
|
+
*
|
|
19268
|
+
* // Dynamic property access
|
|
19269
|
+
* const propertyName = KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_BALANCE;
|
|
19270
|
+
* const value = walletcreditresponsewithbalance[propertyName];
|
|
19271
|
+
* ```
|
|
19272
|
+
*
|
|
19273
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19274
|
+
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19275
|
+
*/
|
|
19276
|
+
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_BALANCE = 'balance' as keyof WalletCreditResponseWithBalance;
|
|
19277
|
+
/**
|
|
19278
|
+
* Credit Id
|
|
19279
|
+
*
|
|
19280
|
+
* Unique identifier of the wallet credit transaction
|
|
19281
|
+
*
|
|
19282
|
+
* @type {string}
|
|
19283
|
+
*
|
|
19284
|
+
*
|
|
19285
|
+
* @remarks
|
|
19286
|
+
* This key constant provides type-safe access to the `credit_id` property of WalletCreditResponseWithBalance objects.
|
|
19287
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19288
|
+
*
|
|
19289
|
+
* @example
|
|
19290
|
+
* ```typescript
|
|
19291
|
+
* // Direct property access
|
|
19292
|
+
* const value = walletcreditresponsewithbalance[KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CREDIT_ID];
|
|
19293
|
+
*
|
|
19294
|
+
* // Dynamic property access
|
|
19295
|
+
* const propertyName = KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CREDIT_ID;
|
|
19296
|
+
* const value = walletcreditresponsewithbalance[propertyName];
|
|
19297
|
+
* ```
|
|
19298
|
+
*
|
|
19299
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19300
|
+
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19301
|
+
*/
|
|
19302
|
+
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CREDIT_ID = 'credit_id' as keyof WalletCreditResponseWithBalance;
|
|
19303
|
+
/**
|
|
19304
|
+
* Message
|
|
19305
|
+
*
|
|
19306
|
+
* Optional human-readable message describing the result
|
|
19307
|
+
*
|
|
19308
|
+
*
|
|
19309
|
+
*
|
|
19310
|
+
* @remarks
|
|
19311
|
+
* This key constant provides type-safe access to the `message` property of WalletCreditResponseWithBalance objects.
|
|
19312
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19313
|
+
*
|
|
19314
|
+
* @example
|
|
19315
|
+
* ```typescript
|
|
19316
|
+
* // Direct property access
|
|
19317
|
+
* const value = walletcreditresponsewithbalance[KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_MESSAGE];
|
|
19318
|
+
*
|
|
19319
|
+
* // Dynamic property access
|
|
19320
|
+
* const propertyName = KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_MESSAGE;
|
|
19321
|
+
* const value = walletcreditresponsewithbalance[propertyName];
|
|
19322
|
+
* ```
|
|
19323
|
+
*
|
|
19324
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19325
|
+
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19326
|
+
*/
|
|
19327
|
+
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_MESSAGE = 'message' as keyof WalletCreditResponseWithBalance;
|
|
19328
|
+
/**
|
|
19329
|
+
* status property
|
|
19330
|
+
*
|
|
19331
|
+
* Status of the credit operation
|
|
19332
|
+
*
|
|
19333
|
+
*
|
|
19334
|
+
*
|
|
19335
|
+
* @remarks
|
|
19336
|
+
* This key constant provides type-safe access to the `status` property of WalletCreditResponseWithBalance objects.
|
|
19337
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19338
|
+
*
|
|
19339
|
+
* @example
|
|
19340
|
+
* ```typescript
|
|
19341
|
+
* // Direct property access
|
|
19342
|
+
* const value = walletcreditresponsewithbalance[KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_STATUS];
|
|
19343
|
+
*
|
|
19344
|
+
* // Dynamic property access
|
|
19345
|
+
* const propertyName = KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_STATUS;
|
|
19346
|
+
* const value = walletcreditresponsewithbalance[propertyName];
|
|
19347
|
+
* ```
|
|
19348
|
+
*
|
|
19349
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19350
|
+
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19351
|
+
*/
|
|
19352
|
+
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_STATUS = 'status' as keyof WalletCreditResponseWithBalance;
|
|
19353
|
+
|
|
19354
|
+
/**
|
|
19355
|
+
* Array of all WalletCreditResponseWithBalance property keys
|
|
19356
|
+
*
|
|
19357
|
+
* @remarks
|
|
19358
|
+
* This constant provides a readonly array containing all valid property keys for WalletCreditResponseWithBalance objects.
|
|
19359
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
19360
|
+
*
|
|
19361
|
+
* @example
|
|
19362
|
+
* ```typescript
|
|
19363
|
+
* // Iterating through all keys
|
|
19364
|
+
* for (const key of KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE) {
|
|
19365
|
+
* console.log(`Property: ${key}, Value: ${walletcreditresponsewithbalance[key]}`);
|
|
19366
|
+
* }
|
|
19367
|
+
*
|
|
19368
|
+
* // Validation
|
|
19369
|
+
* const isValidKey = KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE.includes(someKey);
|
|
19370
|
+
* ```
|
|
19371
|
+
*
|
|
19372
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19373
|
+
*/
|
|
19374
|
+
export const KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE = [
|
|
19375
|
+
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_AMOUNT,
|
|
19376
|
+
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_BALANCE,
|
|
19377
|
+
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CREDIT_ID,
|
|
19378
|
+
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_MESSAGE,
|
|
19379
|
+
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_STATUS,
|
|
19380
|
+
] as const satisfies (keyof WalletCreditResponseWithBalance)[];
|
|
19381
|
+
|
|
18827
19382
|
/**
|
|
18828
19383
|
* Whois Server
|
|
18829
19384
|
*
|