@clerk/types 4.93.0-canary.v20251013115124 → 4.93.0-canary.v20251013141938
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/dist/index.d.mts +30 -30
- package/dist/index.d.ts +30 -30
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
@@ -434,7 +434,7 @@ interface FeatureResource extends ClerkResource {
|
|
434
434
|
avatarUrl: string;
|
435
435
|
}
|
436
436
|
/**
|
437
|
-
* The status of a payment
|
437
|
+
* The status of a payment method.
|
438
438
|
* @inline
|
439
439
|
*/
|
440
440
|
type BillingPaymentMethodStatus = 'active' | 'expired' | 'disconnected';
|
@@ -517,9 +517,9 @@ interface BillingPaymentMethodResource extends ClerkResource {
|
|
517
517
|
*/
|
518
518
|
walletType: string | undefined;
|
519
519
|
/**
|
520
|
-
* A function that removes this payment
|
520
|
+
* A function that removes this payment method from the account. Accepts the following parameters:
|
521
521
|
* <ul>
|
522
|
-
* <li>`orgId?` (`string`): The ID of the organization to remove the payment
|
522
|
+
* <li>`orgId?` (`string`): The ID of the organization to remove the payment method from.</li>
|
523
523
|
* </ul>
|
524
524
|
*
|
525
525
|
* @param params - The parameters for the remove operation.
|
@@ -527,7 +527,7 @@ interface BillingPaymentMethodResource extends ClerkResource {
|
|
527
527
|
*/
|
528
528
|
remove: (params?: RemovePaymentMethodParams) => Promise<DeletedObjectResource>;
|
529
529
|
/**
|
530
|
-
* A function that sets this payment
|
530
|
+
* A function that sets this payment method as the default for the account. Accepts the following parameters:
|
531
531
|
* <ul>
|
532
532
|
* <li>`orgId?` (`string`): The ID of the organization to set as the default.</li>
|
533
533
|
* </ul>
|
@@ -593,7 +593,7 @@ interface BillingPaymentResource extends ClerkResource {
|
|
593
593
|
*/
|
594
594
|
updatedAt: Date;
|
595
595
|
/**
|
596
|
-
* The payment
|
596
|
+
* The payment method being used for the payment, such as credit card or bank account.
|
597
597
|
*/
|
598
598
|
paymentMethod: BillingPaymentMethodResource;
|
599
599
|
/**
|
@@ -686,7 +686,7 @@ interface BillingSubscriptionItemResource extends ClerkResource {
|
|
686
686
|
*/
|
687
687
|
id: string;
|
688
688
|
/**
|
689
|
-
* The unique identifier for the payment
|
689
|
+
* The unique identifier for the payment method being used for the subscription item.
|
690
690
|
*/
|
691
691
|
paymentMethodId: string;
|
692
692
|
/**
|
@@ -887,7 +887,7 @@ type CreateCheckoutParams = WithOptionalOrgType<{
|
|
887
887
|
*/
|
888
888
|
type ConfirmCheckoutParams = {
|
889
889
|
/**
|
890
|
-
* The ID of a saved payment
|
890
|
+
* The ID of a saved payment method to use for this checkout.
|
891
891
|
*/
|
892
892
|
paymentSourceId?: string;
|
893
893
|
} | {
|
@@ -5776,7 +5776,7 @@ type __internal_LocalizationResource = {
|
|
5776
5776
|
membershipRole__admin: LocalizationValue;
|
5777
5777
|
membershipRole__basicMember: LocalizationValue;
|
5778
5778
|
membershipRole__guestMember: LocalizationValue;
|
5779
|
-
|
5779
|
+
billing: {
|
5780
5780
|
month: LocalizationValue;
|
5781
5781
|
year: LocalizationValue;
|
5782
5782
|
free: LocalizationValue;
|
@@ -5813,14 +5813,28 @@ type __internal_LocalizationResource = {
|
|
5813
5813
|
totalDue: LocalizationValue;
|
5814
5814
|
totalDueToday: LocalizationValue;
|
5815
5815
|
pastDue: LocalizationValue;
|
5816
|
-
paymentMethods: LocalizationValue;
|
5817
|
-
addPaymentMethod: LocalizationValue;
|
5818
5816
|
pay: LocalizationValue<'amount'>;
|
5819
5817
|
cancelSubscriptionTitle: LocalizationValue<'plan'>;
|
5820
5818
|
cancelSubscriptionNoCharge: LocalizationValue;
|
5821
5819
|
cancelSubscriptionAccessUntil: LocalizationValue<'plan' | 'date'>;
|
5822
5820
|
cancelSubscriptionPastDue: LocalizationValue;
|
5823
5821
|
popular: LocalizationValue;
|
5822
|
+
paymentMethods__label: LocalizationValue;
|
5823
|
+
addPaymentMethod__label: LocalizationValue;
|
5824
|
+
paymentMethod: {
|
5825
|
+
dev: {
|
5826
|
+
testCardInfo: LocalizationValue;
|
5827
|
+
developmentMode: LocalizationValue;
|
5828
|
+
cardNumber: LocalizationValue;
|
5829
|
+
expirationDate: LocalizationValue;
|
5830
|
+
cvcZip: LocalizationValue;
|
5831
|
+
anyNumbers: LocalizationValue;
|
5832
|
+
};
|
5833
|
+
applePayDescription: {
|
5834
|
+
monthly: LocalizationValue;
|
5835
|
+
annual: LocalizationValue;
|
5836
|
+
};
|
5837
|
+
};
|
5824
5838
|
subscriptionDetails: {
|
5825
5839
|
title: LocalizationValue;
|
5826
5840
|
currentBillingCycle: LocalizationValue;
|
@@ -5844,20 +5858,6 @@ type __internal_LocalizationResource = {
|
|
5844
5858
|
billingCycle: LocalizationValue;
|
5845
5859
|
included: LocalizationValue;
|
5846
5860
|
};
|
5847
|
-
paymentSource: {
|
5848
|
-
dev: {
|
5849
|
-
testCardInfo: LocalizationValue;
|
5850
|
-
developmentMode: LocalizationValue;
|
5851
|
-
cardNumber: LocalizationValue;
|
5852
|
-
expirationDate: LocalizationValue;
|
5853
|
-
cvcZip: LocalizationValue;
|
5854
|
-
anyNumbers: LocalizationValue;
|
5855
|
-
};
|
5856
|
-
applePayDescription: {
|
5857
|
-
monthly: LocalizationValue;
|
5858
|
-
annual: LocalizationValue;
|
5859
|
-
};
|
5860
|
-
};
|
5861
5861
|
checkout: {
|
5862
5862
|
title: LocalizationValue;
|
5863
5863
|
title__paymentSuccessful: LocalizationValue;
|
@@ -6505,7 +6505,7 @@ type __internal_LocalizationResource = {
|
|
6505
6505
|
tableHeader__amount: LocalizationValue;
|
6506
6506
|
tableHeader__status: LocalizationValue;
|
6507
6507
|
};
|
6508
|
-
|
6508
|
+
paymentMethodsSection: {
|
6509
6509
|
title: LocalizationValue;
|
6510
6510
|
add: LocalizationValue;
|
6511
6511
|
addSubtitle: LocalizationValue;
|
@@ -6514,11 +6514,11 @@ type __internal_LocalizationResource = {
|
|
6514
6514
|
actionLabel__remove: LocalizationValue;
|
6515
6515
|
formButtonPrimary__add: LocalizationValue;
|
6516
6516
|
formButtonPrimary__pay: LocalizationValue;
|
6517
|
-
|
6517
|
+
removeMethod: {
|
6518
6518
|
title: LocalizationValue;
|
6519
6519
|
messageLine1: LocalizationValue<'identifier'>;
|
6520
6520
|
messageLine2: LocalizationValue;
|
6521
|
-
successMessage: LocalizationValue<'
|
6521
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6522
6522
|
};
|
6523
6523
|
payWithTestCardButton: LocalizationValue;
|
6524
6524
|
};
|
@@ -6733,7 +6733,7 @@ type __internal_LocalizationResource = {
|
|
6733
6733
|
tableHeader__amount: LocalizationValue;
|
6734
6734
|
tableHeader__status: LocalizationValue;
|
6735
6735
|
};
|
6736
|
-
|
6736
|
+
paymentMethodsSection: {
|
6737
6737
|
title: LocalizationValue;
|
6738
6738
|
add: LocalizationValue;
|
6739
6739
|
addSubtitle: LocalizationValue;
|
@@ -6742,11 +6742,11 @@ type __internal_LocalizationResource = {
|
|
6742
6742
|
actionLabel__remove: LocalizationValue;
|
6743
6743
|
formButtonPrimary__add: LocalizationValue;
|
6744
6744
|
formButtonPrimary__pay: LocalizationValue;
|
6745
|
-
|
6745
|
+
removeMethod: {
|
6746
6746
|
title: LocalizationValue;
|
6747
6747
|
messageLine1: LocalizationValue<'identifier'>;
|
6748
6748
|
messageLine2: LocalizationValue;
|
6749
|
-
successMessage: LocalizationValue<'
|
6749
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6750
6750
|
};
|
6751
6751
|
payWithTestCardButton: LocalizationValue;
|
6752
6752
|
};
|
package/dist/index.d.ts
CHANGED
@@ -434,7 +434,7 @@ interface FeatureResource extends ClerkResource {
|
|
434
434
|
avatarUrl: string;
|
435
435
|
}
|
436
436
|
/**
|
437
|
-
* The status of a payment
|
437
|
+
* The status of a payment method.
|
438
438
|
* @inline
|
439
439
|
*/
|
440
440
|
type BillingPaymentMethodStatus = 'active' | 'expired' | 'disconnected';
|
@@ -517,9 +517,9 @@ interface BillingPaymentMethodResource extends ClerkResource {
|
|
517
517
|
*/
|
518
518
|
walletType: string | undefined;
|
519
519
|
/**
|
520
|
-
* A function that removes this payment
|
520
|
+
* A function that removes this payment method from the account. Accepts the following parameters:
|
521
521
|
* <ul>
|
522
|
-
* <li>`orgId?` (`string`): The ID of the organization to remove the payment
|
522
|
+
* <li>`orgId?` (`string`): The ID of the organization to remove the payment method from.</li>
|
523
523
|
* </ul>
|
524
524
|
*
|
525
525
|
* @param params - The parameters for the remove operation.
|
@@ -527,7 +527,7 @@ interface BillingPaymentMethodResource extends ClerkResource {
|
|
527
527
|
*/
|
528
528
|
remove: (params?: RemovePaymentMethodParams) => Promise<DeletedObjectResource>;
|
529
529
|
/**
|
530
|
-
* A function that sets this payment
|
530
|
+
* A function that sets this payment method as the default for the account. Accepts the following parameters:
|
531
531
|
* <ul>
|
532
532
|
* <li>`orgId?` (`string`): The ID of the organization to set as the default.</li>
|
533
533
|
* </ul>
|
@@ -593,7 +593,7 @@ interface BillingPaymentResource extends ClerkResource {
|
|
593
593
|
*/
|
594
594
|
updatedAt: Date;
|
595
595
|
/**
|
596
|
-
* The payment
|
596
|
+
* The payment method being used for the payment, such as credit card or bank account.
|
597
597
|
*/
|
598
598
|
paymentMethod: BillingPaymentMethodResource;
|
599
599
|
/**
|
@@ -686,7 +686,7 @@ interface BillingSubscriptionItemResource extends ClerkResource {
|
|
686
686
|
*/
|
687
687
|
id: string;
|
688
688
|
/**
|
689
|
-
* The unique identifier for the payment
|
689
|
+
* The unique identifier for the payment method being used for the subscription item.
|
690
690
|
*/
|
691
691
|
paymentMethodId: string;
|
692
692
|
/**
|
@@ -887,7 +887,7 @@ type CreateCheckoutParams = WithOptionalOrgType<{
|
|
887
887
|
*/
|
888
888
|
type ConfirmCheckoutParams = {
|
889
889
|
/**
|
890
|
-
* The ID of a saved payment
|
890
|
+
* The ID of a saved payment method to use for this checkout.
|
891
891
|
*/
|
892
892
|
paymentSourceId?: string;
|
893
893
|
} | {
|
@@ -5776,7 +5776,7 @@ type __internal_LocalizationResource = {
|
|
5776
5776
|
membershipRole__admin: LocalizationValue;
|
5777
5777
|
membershipRole__basicMember: LocalizationValue;
|
5778
5778
|
membershipRole__guestMember: LocalizationValue;
|
5779
|
-
|
5779
|
+
billing: {
|
5780
5780
|
month: LocalizationValue;
|
5781
5781
|
year: LocalizationValue;
|
5782
5782
|
free: LocalizationValue;
|
@@ -5813,14 +5813,28 @@ type __internal_LocalizationResource = {
|
|
5813
5813
|
totalDue: LocalizationValue;
|
5814
5814
|
totalDueToday: LocalizationValue;
|
5815
5815
|
pastDue: LocalizationValue;
|
5816
|
-
paymentMethods: LocalizationValue;
|
5817
|
-
addPaymentMethod: LocalizationValue;
|
5818
5816
|
pay: LocalizationValue<'amount'>;
|
5819
5817
|
cancelSubscriptionTitle: LocalizationValue<'plan'>;
|
5820
5818
|
cancelSubscriptionNoCharge: LocalizationValue;
|
5821
5819
|
cancelSubscriptionAccessUntil: LocalizationValue<'plan' | 'date'>;
|
5822
5820
|
cancelSubscriptionPastDue: LocalizationValue;
|
5823
5821
|
popular: LocalizationValue;
|
5822
|
+
paymentMethods__label: LocalizationValue;
|
5823
|
+
addPaymentMethod__label: LocalizationValue;
|
5824
|
+
paymentMethod: {
|
5825
|
+
dev: {
|
5826
|
+
testCardInfo: LocalizationValue;
|
5827
|
+
developmentMode: LocalizationValue;
|
5828
|
+
cardNumber: LocalizationValue;
|
5829
|
+
expirationDate: LocalizationValue;
|
5830
|
+
cvcZip: LocalizationValue;
|
5831
|
+
anyNumbers: LocalizationValue;
|
5832
|
+
};
|
5833
|
+
applePayDescription: {
|
5834
|
+
monthly: LocalizationValue;
|
5835
|
+
annual: LocalizationValue;
|
5836
|
+
};
|
5837
|
+
};
|
5824
5838
|
subscriptionDetails: {
|
5825
5839
|
title: LocalizationValue;
|
5826
5840
|
currentBillingCycle: LocalizationValue;
|
@@ -5844,20 +5858,6 @@ type __internal_LocalizationResource = {
|
|
5844
5858
|
billingCycle: LocalizationValue;
|
5845
5859
|
included: LocalizationValue;
|
5846
5860
|
};
|
5847
|
-
paymentSource: {
|
5848
|
-
dev: {
|
5849
|
-
testCardInfo: LocalizationValue;
|
5850
|
-
developmentMode: LocalizationValue;
|
5851
|
-
cardNumber: LocalizationValue;
|
5852
|
-
expirationDate: LocalizationValue;
|
5853
|
-
cvcZip: LocalizationValue;
|
5854
|
-
anyNumbers: LocalizationValue;
|
5855
|
-
};
|
5856
|
-
applePayDescription: {
|
5857
|
-
monthly: LocalizationValue;
|
5858
|
-
annual: LocalizationValue;
|
5859
|
-
};
|
5860
|
-
};
|
5861
5861
|
checkout: {
|
5862
5862
|
title: LocalizationValue;
|
5863
5863
|
title__paymentSuccessful: LocalizationValue;
|
@@ -6505,7 +6505,7 @@ type __internal_LocalizationResource = {
|
|
6505
6505
|
tableHeader__amount: LocalizationValue;
|
6506
6506
|
tableHeader__status: LocalizationValue;
|
6507
6507
|
};
|
6508
|
-
|
6508
|
+
paymentMethodsSection: {
|
6509
6509
|
title: LocalizationValue;
|
6510
6510
|
add: LocalizationValue;
|
6511
6511
|
addSubtitle: LocalizationValue;
|
@@ -6514,11 +6514,11 @@ type __internal_LocalizationResource = {
|
|
6514
6514
|
actionLabel__remove: LocalizationValue;
|
6515
6515
|
formButtonPrimary__add: LocalizationValue;
|
6516
6516
|
formButtonPrimary__pay: LocalizationValue;
|
6517
|
-
|
6517
|
+
removeMethod: {
|
6518
6518
|
title: LocalizationValue;
|
6519
6519
|
messageLine1: LocalizationValue<'identifier'>;
|
6520
6520
|
messageLine2: LocalizationValue;
|
6521
|
-
successMessage: LocalizationValue<'
|
6521
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6522
6522
|
};
|
6523
6523
|
payWithTestCardButton: LocalizationValue;
|
6524
6524
|
};
|
@@ -6733,7 +6733,7 @@ type __internal_LocalizationResource = {
|
|
6733
6733
|
tableHeader__amount: LocalizationValue;
|
6734
6734
|
tableHeader__status: LocalizationValue;
|
6735
6735
|
};
|
6736
|
-
|
6736
|
+
paymentMethodsSection: {
|
6737
6737
|
title: LocalizationValue;
|
6738
6738
|
add: LocalizationValue;
|
6739
6739
|
addSubtitle: LocalizationValue;
|
@@ -6742,11 +6742,11 @@ type __internal_LocalizationResource = {
|
|
6742
6742
|
actionLabel__remove: LocalizationValue;
|
6743
6743
|
formButtonPrimary__add: LocalizationValue;
|
6744
6744
|
formButtonPrimary__pay: LocalizationValue;
|
6745
|
-
|
6745
|
+
removeMethod: {
|
6746
6746
|
title: LocalizationValue;
|
6747
6747
|
messageLine1: LocalizationValue<'identifier'>;
|
6748
6748
|
messageLine2: LocalizationValue;
|
6749
|
-
successMessage: LocalizationValue<'
|
6749
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6750
6750
|
};
|
6751
6751
|
payWithTestCardButton: LocalizationValue;
|
6752
6752
|
};
|