@clerk/types 4.93.0-snapshot.v20251013141708 → 4.93.0-snapshot.v20251013143957
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 +31 -30
- package/dist/index.d.ts +31 -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
|
} | {
|
@@ -4373,6 +4373,7 @@ interface EnterpriseAccountConnectionResource extends ClerkResource {
|
|
4373
4373
|
protocol: EnterpriseProtocol;
|
4374
4374
|
provider: EnterpriseProvider;
|
4375
4375
|
syncUserAttributes: boolean;
|
4376
|
+
enterpriseConnectionId: string | null;
|
4376
4377
|
__internal_toSnapshot: () => EnterpriseAccountConnectionJSONSnapshot;
|
4377
4378
|
}
|
4378
4379
|
|
@@ -5783,7 +5784,7 @@ type __internal_LocalizationResource = {
|
|
5783
5784
|
membershipRole__admin: LocalizationValue;
|
5784
5785
|
membershipRole__basicMember: LocalizationValue;
|
5785
5786
|
membershipRole__guestMember: LocalizationValue;
|
5786
|
-
|
5787
|
+
billing: {
|
5787
5788
|
month: LocalizationValue;
|
5788
5789
|
year: LocalizationValue;
|
5789
5790
|
free: LocalizationValue;
|
@@ -5820,14 +5821,28 @@ type __internal_LocalizationResource = {
|
|
5820
5821
|
totalDue: LocalizationValue;
|
5821
5822
|
totalDueToday: LocalizationValue;
|
5822
5823
|
pastDue: LocalizationValue;
|
5823
|
-
paymentMethods: LocalizationValue;
|
5824
|
-
addPaymentMethod: LocalizationValue;
|
5825
5824
|
pay: LocalizationValue<'amount'>;
|
5826
5825
|
cancelSubscriptionTitle: LocalizationValue<'plan'>;
|
5827
5826
|
cancelSubscriptionNoCharge: LocalizationValue;
|
5828
5827
|
cancelSubscriptionAccessUntil: LocalizationValue<'plan' | 'date'>;
|
5829
5828
|
cancelSubscriptionPastDue: LocalizationValue;
|
5830
5829
|
popular: LocalizationValue;
|
5830
|
+
paymentMethods__label: LocalizationValue;
|
5831
|
+
addPaymentMethod__label: LocalizationValue;
|
5832
|
+
paymentMethod: {
|
5833
|
+
dev: {
|
5834
|
+
testCardInfo: LocalizationValue;
|
5835
|
+
developmentMode: LocalizationValue;
|
5836
|
+
cardNumber: LocalizationValue;
|
5837
|
+
expirationDate: LocalizationValue;
|
5838
|
+
cvcZip: LocalizationValue;
|
5839
|
+
anyNumbers: LocalizationValue;
|
5840
|
+
};
|
5841
|
+
applePayDescription: {
|
5842
|
+
monthly: LocalizationValue;
|
5843
|
+
annual: LocalizationValue;
|
5844
|
+
};
|
5845
|
+
};
|
5831
5846
|
subscriptionDetails: {
|
5832
5847
|
title: LocalizationValue;
|
5833
5848
|
currentBillingCycle: LocalizationValue;
|
@@ -5851,20 +5866,6 @@ type __internal_LocalizationResource = {
|
|
5851
5866
|
billingCycle: LocalizationValue;
|
5852
5867
|
included: LocalizationValue;
|
5853
5868
|
};
|
5854
|
-
paymentSource: {
|
5855
|
-
dev: {
|
5856
|
-
testCardInfo: LocalizationValue;
|
5857
|
-
developmentMode: LocalizationValue;
|
5858
|
-
cardNumber: LocalizationValue;
|
5859
|
-
expirationDate: LocalizationValue;
|
5860
|
-
cvcZip: LocalizationValue;
|
5861
|
-
anyNumbers: LocalizationValue;
|
5862
|
-
};
|
5863
|
-
applePayDescription: {
|
5864
|
-
monthly: LocalizationValue;
|
5865
|
-
annual: LocalizationValue;
|
5866
|
-
};
|
5867
|
-
};
|
5868
5869
|
checkout: {
|
5869
5870
|
title: LocalizationValue;
|
5870
5871
|
title__paymentSuccessful: LocalizationValue;
|
@@ -6512,7 +6513,7 @@ type __internal_LocalizationResource = {
|
|
6512
6513
|
tableHeader__amount: LocalizationValue;
|
6513
6514
|
tableHeader__status: LocalizationValue;
|
6514
6515
|
};
|
6515
|
-
|
6516
|
+
paymentMethodsSection: {
|
6516
6517
|
title: LocalizationValue;
|
6517
6518
|
add: LocalizationValue;
|
6518
6519
|
addSubtitle: LocalizationValue;
|
@@ -6521,11 +6522,11 @@ type __internal_LocalizationResource = {
|
|
6521
6522
|
actionLabel__remove: LocalizationValue;
|
6522
6523
|
formButtonPrimary__add: LocalizationValue;
|
6523
6524
|
formButtonPrimary__pay: LocalizationValue;
|
6524
|
-
|
6525
|
+
removeMethod: {
|
6525
6526
|
title: LocalizationValue;
|
6526
6527
|
messageLine1: LocalizationValue<'identifier'>;
|
6527
6528
|
messageLine2: LocalizationValue;
|
6528
|
-
successMessage: LocalizationValue<'
|
6529
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6529
6530
|
};
|
6530
6531
|
payWithTestCardButton: LocalizationValue;
|
6531
6532
|
};
|
@@ -6740,7 +6741,7 @@ type __internal_LocalizationResource = {
|
|
6740
6741
|
tableHeader__amount: LocalizationValue;
|
6741
6742
|
tableHeader__status: LocalizationValue;
|
6742
6743
|
};
|
6743
|
-
|
6744
|
+
paymentMethodsSection: {
|
6744
6745
|
title: LocalizationValue;
|
6745
6746
|
add: LocalizationValue;
|
6746
6747
|
addSubtitle: LocalizationValue;
|
@@ -6749,11 +6750,11 @@ type __internal_LocalizationResource = {
|
|
6749
6750
|
actionLabel__remove: LocalizationValue;
|
6750
6751
|
formButtonPrimary__add: LocalizationValue;
|
6751
6752
|
formButtonPrimary__pay: LocalizationValue;
|
6752
|
-
|
6753
|
+
removeMethod: {
|
6753
6754
|
title: LocalizationValue;
|
6754
6755
|
messageLine1: LocalizationValue<'identifier'>;
|
6755
6756
|
messageLine2: LocalizationValue;
|
6756
|
-
successMessage: LocalizationValue<'
|
6757
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6757
6758
|
};
|
6758
6759
|
payWithTestCardButton: LocalizationValue;
|
6759
6760
|
};
|
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
|
} | {
|
@@ -4373,6 +4373,7 @@ interface EnterpriseAccountConnectionResource extends ClerkResource {
|
|
4373
4373
|
protocol: EnterpriseProtocol;
|
4374
4374
|
provider: EnterpriseProvider;
|
4375
4375
|
syncUserAttributes: boolean;
|
4376
|
+
enterpriseConnectionId: string | null;
|
4376
4377
|
__internal_toSnapshot: () => EnterpriseAccountConnectionJSONSnapshot;
|
4377
4378
|
}
|
4378
4379
|
|
@@ -5783,7 +5784,7 @@ type __internal_LocalizationResource = {
|
|
5783
5784
|
membershipRole__admin: LocalizationValue;
|
5784
5785
|
membershipRole__basicMember: LocalizationValue;
|
5785
5786
|
membershipRole__guestMember: LocalizationValue;
|
5786
|
-
|
5787
|
+
billing: {
|
5787
5788
|
month: LocalizationValue;
|
5788
5789
|
year: LocalizationValue;
|
5789
5790
|
free: LocalizationValue;
|
@@ -5820,14 +5821,28 @@ type __internal_LocalizationResource = {
|
|
5820
5821
|
totalDue: LocalizationValue;
|
5821
5822
|
totalDueToday: LocalizationValue;
|
5822
5823
|
pastDue: LocalizationValue;
|
5823
|
-
paymentMethods: LocalizationValue;
|
5824
|
-
addPaymentMethod: LocalizationValue;
|
5825
5824
|
pay: LocalizationValue<'amount'>;
|
5826
5825
|
cancelSubscriptionTitle: LocalizationValue<'plan'>;
|
5827
5826
|
cancelSubscriptionNoCharge: LocalizationValue;
|
5828
5827
|
cancelSubscriptionAccessUntil: LocalizationValue<'plan' | 'date'>;
|
5829
5828
|
cancelSubscriptionPastDue: LocalizationValue;
|
5830
5829
|
popular: LocalizationValue;
|
5830
|
+
paymentMethods__label: LocalizationValue;
|
5831
|
+
addPaymentMethod__label: LocalizationValue;
|
5832
|
+
paymentMethod: {
|
5833
|
+
dev: {
|
5834
|
+
testCardInfo: LocalizationValue;
|
5835
|
+
developmentMode: LocalizationValue;
|
5836
|
+
cardNumber: LocalizationValue;
|
5837
|
+
expirationDate: LocalizationValue;
|
5838
|
+
cvcZip: LocalizationValue;
|
5839
|
+
anyNumbers: LocalizationValue;
|
5840
|
+
};
|
5841
|
+
applePayDescription: {
|
5842
|
+
monthly: LocalizationValue;
|
5843
|
+
annual: LocalizationValue;
|
5844
|
+
};
|
5845
|
+
};
|
5831
5846
|
subscriptionDetails: {
|
5832
5847
|
title: LocalizationValue;
|
5833
5848
|
currentBillingCycle: LocalizationValue;
|
@@ -5851,20 +5866,6 @@ type __internal_LocalizationResource = {
|
|
5851
5866
|
billingCycle: LocalizationValue;
|
5852
5867
|
included: LocalizationValue;
|
5853
5868
|
};
|
5854
|
-
paymentSource: {
|
5855
|
-
dev: {
|
5856
|
-
testCardInfo: LocalizationValue;
|
5857
|
-
developmentMode: LocalizationValue;
|
5858
|
-
cardNumber: LocalizationValue;
|
5859
|
-
expirationDate: LocalizationValue;
|
5860
|
-
cvcZip: LocalizationValue;
|
5861
|
-
anyNumbers: LocalizationValue;
|
5862
|
-
};
|
5863
|
-
applePayDescription: {
|
5864
|
-
monthly: LocalizationValue;
|
5865
|
-
annual: LocalizationValue;
|
5866
|
-
};
|
5867
|
-
};
|
5868
5869
|
checkout: {
|
5869
5870
|
title: LocalizationValue;
|
5870
5871
|
title__paymentSuccessful: LocalizationValue;
|
@@ -6512,7 +6513,7 @@ type __internal_LocalizationResource = {
|
|
6512
6513
|
tableHeader__amount: LocalizationValue;
|
6513
6514
|
tableHeader__status: LocalizationValue;
|
6514
6515
|
};
|
6515
|
-
|
6516
|
+
paymentMethodsSection: {
|
6516
6517
|
title: LocalizationValue;
|
6517
6518
|
add: LocalizationValue;
|
6518
6519
|
addSubtitle: LocalizationValue;
|
@@ -6521,11 +6522,11 @@ type __internal_LocalizationResource = {
|
|
6521
6522
|
actionLabel__remove: LocalizationValue;
|
6522
6523
|
formButtonPrimary__add: LocalizationValue;
|
6523
6524
|
formButtonPrimary__pay: LocalizationValue;
|
6524
|
-
|
6525
|
+
removeMethod: {
|
6525
6526
|
title: LocalizationValue;
|
6526
6527
|
messageLine1: LocalizationValue<'identifier'>;
|
6527
6528
|
messageLine2: LocalizationValue;
|
6528
|
-
successMessage: LocalizationValue<'
|
6529
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6529
6530
|
};
|
6530
6531
|
payWithTestCardButton: LocalizationValue;
|
6531
6532
|
};
|
@@ -6740,7 +6741,7 @@ type __internal_LocalizationResource = {
|
|
6740
6741
|
tableHeader__amount: LocalizationValue;
|
6741
6742
|
tableHeader__status: LocalizationValue;
|
6742
6743
|
};
|
6743
|
-
|
6744
|
+
paymentMethodsSection: {
|
6744
6745
|
title: LocalizationValue;
|
6745
6746
|
add: LocalizationValue;
|
6746
6747
|
addSubtitle: LocalizationValue;
|
@@ -6749,11 +6750,11 @@ type __internal_LocalizationResource = {
|
|
6749
6750
|
actionLabel__remove: LocalizationValue;
|
6750
6751
|
formButtonPrimary__add: LocalizationValue;
|
6751
6752
|
formButtonPrimary__pay: LocalizationValue;
|
6752
|
-
|
6753
|
+
removeMethod: {
|
6753
6754
|
title: LocalizationValue;
|
6754
6755
|
messageLine1: LocalizationValue<'identifier'>;
|
6755
6756
|
messageLine2: LocalizationValue;
|
6756
|
-
successMessage: LocalizationValue<'
|
6757
|
+
successMessage: LocalizationValue<'paymentMethod'>;
|
6757
6758
|
};
|
6758
6759
|
payWithTestCardButton: LocalizationValue;
|
6759
6760
|
};
|