@clerk/backend 3.2.1-snapshot.v20260311230607 → 3.2.1

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.
@@ -64,7 +64,7 @@ export declare class APIKey {
64
64
  */
65
65
  readonly updatedAt: number;
66
66
  /**
67
- * The API key secret. **This property is only present in the response from [`create()`](/docs/reference/javascript/api-keys#create) and cannot be retrieved later.**
67
+ * The API key secret. **This property is only present in the response from [`create()`](/docs/reference/objects/api-keys#create) and cannot be retrieved later.**
68
68
  */
69
69
  readonly secret?: string | undefined;
70
70
  constructor(
@@ -129,7 +129,7 @@ export declare class APIKey {
129
129
  */
130
130
  updatedAt: number,
131
131
  /**
132
- * The API key secret. **This property is only present in the response from [`create()`](/docs/reference/javascript/api-keys#create) and cannot be retrieved later.**
132
+ * The API key secret. **This property is only present in the response from [`create()`](/docs/reference/objects/api-keys#create) and cannot be retrieved later.**
133
133
  */
134
134
  secret?: string | undefined);
135
135
  static fromJSON(data: APIKeyJSON): APIKey;
@@ -2,7 +2,7 @@ import type { LastAuthenticationStrategy } from '@clerk/shared/types';
2
2
  import type { ClientJSON } from './JSON';
3
3
  import { Session } from './Session';
4
4
  /**
5
- * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/reference/javascript/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
5
+ * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/reference/objects/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
6
6
  */
7
7
  export declare class Client {
8
8
  /**
@@ -18,11 +18,11 @@ export declare class Client {
18
18
  */
19
19
  readonly sessions: Session[];
20
20
  /**
21
- * The ID of the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in){{ target: '_blank' }}.
21
+ * The ID of the [`SignIn`](https://clerk.com/docs/reference/objects/sign-in).
22
22
  */
23
23
  readonly signInId: string | null;
24
24
  /**
25
- * The ID of the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up){{ target: '_blank' }}.
25
+ * The ID of the [`SignUp`](https://clerk.com/docs/reference/objects/sign-up).
26
26
  */
27
27
  readonly signUpId: string | null;
28
28
  /**
@@ -55,11 +55,11 @@ export declare class Client {
55
55
  */
56
56
  sessions: Session[],
57
57
  /**
58
- * The ID of the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in){{ target: '_blank' }}.
58
+ * The ID of the [`SignIn`](https://clerk.com/docs/reference/objects/sign-in).
59
59
  */
60
60
  signInId: string | null,
61
61
  /**
62
- * The ID of the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up){{ target: '_blank' }}.
62
+ * The ID of the [`SignUp`](https://clerk.com/docs/reference/objects/sign-up).
63
63
  */
64
64
  signUpId: string | null,
65
65
  /**
@@ -2,7 +2,7 @@ import type { BillingMoneyAmount } from '@clerk/shared/types';
2
2
  import { Feature } from './Feature';
3
3
  import type { BillingPlanJSON } from './JSON';
4
4
  /**
5
- * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
5
+ * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
6
6
  *
7
7
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
8
8
  */
@@ -2,7 +2,7 @@ import type { BillingMoneyAmount } from '@clerk/shared/types';
2
2
  import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
3
3
  import type { BillingSubscriptionJSON } from './JSON';
4
4
  /**
5
- * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/reference/javascript/types/billing-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
5
+ * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/reference/types/billing-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
6
6
  *
7
7
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
8
8
  */
@@ -2,7 +2,7 @@ import type { BillingMoneyAmount } from '@clerk/shared/types';
2
2
  import { BillingPlan } from './CommercePlan';
3
3
  import type { BillingSubscriptionItemJSON } from './JSON';
4
4
  /**
5
- * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/reference/javascript/types/billing-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
5
+ * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/reference/types/billing-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
6
6
  *
7
7
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
8
8
  */
@@ -13,7 +13,7 @@ export declare class Invitation {
13
13
  */
14
14
  readonly emailAddress: string;
15
15
  /**
16
- * [Metadata](https://clerk.com/docs/reference/javascript/types/metadata#user-public-metadata){{ target: '_blank' }} that can be read from the Frontend API and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
16
+ * [Metadata](https://clerk.com/docs/reference/types/metadata#user-public-metadata){{ target: '_blank' }} that can be read from the Frontend API and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
17
17
  */
18
18
  readonly publicMetadata: Record<string, unknown> | null;
19
19
  /**
@@ -48,7 +48,7 @@ export declare class Invitation {
48
48
  */
49
49
  emailAddress: string,
50
50
  /**
51
- * [Metadata](https://clerk.com/docs/reference/javascript/types/metadata#user-public-metadata){{ target: '_blank' }} that can be read from the Frontend API and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
51
+ * [Metadata](https://clerk.com/docs/reference/types/metadata#user-public-metadata){{ target: '_blank' }} that can be read from the Frontend API and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
52
52
  */
53
53
  publicMetadata: Record<string, unknown> | null,
54
54
  /**
@@ -1,6 +1,6 @@
1
1
  import type { OrganizationJSON } from './JSON';
2
2
  /**
3
- * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/javascript/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API.
3
+ * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/objects/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API.
4
4
  */
5
5
  export declare class Organization {
6
6
  /**
@@ -1,7 +1,7 @@
1
1
  import type { OrganizationInvitationStatus, OrganizationMembershipRole } from './Enums';
2
2
  import type { OrganizationInvitationJSON, PublicOrganizationDataJSON } from './JSON';
3
3
  /**
4
- * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/javascript/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
4
+ * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
5
5
  */
6
6
  export declare class OrganizationInvitation {
7
7
  /**
@@ -2,7 +2,7 @@ import { Organization } from '../resources';
2
2
  import type { OrganizationMembershipRole } from './Enums';
3
3
  import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
4
4
  /**
5
- * The Backend `OrganizationMembership` object is similar to the [`OrganizationMembership`](https://clerk.com/docs/reference/javascript/types/organization-membership) object as it's the model around an Organization membership entity and describes the relationship between users and Organizations. However, the Backend `OrganizationMembership` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Memberships#operation/CreateOrganizationMembership){{ target: '_blank' }} and is not directly accessible from the Frontend API.
5
+ * The Backend `OrganizationMembership` object is similar to the [`OrganizationMembership`](https://clerk.com/docs/reference/types/organization-membership) object as it's the model around an Organization membership entity and describes the relationship between users and Organizations. However, the Backend `OrganizationMembership` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Memberships#operation/CreateOrganizationMembership){{ target: '_blank' }} and is not directly accessible from the Frontend API.
6
6
  */
7
7
  export declare class OrganizationMembership {
8
8
  /**
@@ -85,7 +85,7 @@ export declare class SamlConnection {
85
85
  */
86
86
  readonly updatedAt: number;
87
87
  /**
88
- * Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's [`User`](https://clerk.com/docs/reference/javascript/user) properties.
88
+ * Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's [`User`](https://clerk.com/docs/reference/objects/user) properties.
89
89
  */
90
90
  readonly attributeMapping: AttributeMapping;
91
91
  constructor(
@@ -170,7 +170,7 @@ export declare class SamlConnection {
170
170
  */
171
171
  updatedAt: number,
172
172
  /**
173
- * Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's [`User`](https://clerk.com/docs/reference/javascript/user) properties.
173
+ * Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's [`User`](https://clerk.com/docs/reference/objects/user) properties.
174
174
  */
175
175
  attributeMapping: AttributeMapping);
176
176
  static fromJSON(data: SamlConnectionJSON): SamlConnection;
@@ -71,7 +71,7 @@ export declare class SessionActivity {
71
71
  static fromJSON(data: SessionActivityJSON): SessionActivity;
72
72
  }
73
73
  /**
74
- * The Backend `Session` object is similar to the [`Session`](https://clerk.com/docs/reference/javascript/session) object as it is an abstraction over an HTTP session and models the period of information exchange between a user and the server. However, the Backend `Session` object is different as it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Sessions#operation/GetSessionList) and is not directly accessible from the Frontend API.
74
+ * The Backend `Session` object is similar to the [`Session`](https://clerk.com/docs/reference/objects/session) object as it is an abstraction over an HTTP session and models the period of information exchange between a user and the server. However, the Backend `Session` object is different as it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Sessions#operation/GetSessionList) and is not directly accessible from the Frontend API.
75
75
  */
76
76
  export declare class Session {
77
77
  /**
@@ -194,7 +194,7 @@ var require_dist = __commonJS({
194
194
  // src/constants.ts
195
195
  var API_URL = "https://api.clerk.com";
196
196
  var API_VERSION = "v1";
197
- var USER_AGENT = `${"@clerk/backend"}@${"3.2.1-snapshot.v20260311230607"}`;
197
+ var USER_AGENT = `${"@clerk/backend"}@${"3.2.1"}`;
198
198
  var MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
199
199
  var SUPPORTED_BAPI_VERSION = "2025-11-10";
200
200
  var Attributes = {
@@ -6170,4 +6170,4 @@ export {
6170
6170
  debugRequestState,
6171
6171
  createAuthenticateRequest
6172
6172
  };
6173
- //# sourceMappingURL=chunk-OZLC7RDZ.mjs.map
6173
+ //# sourceMappingURL=chunk-HVVD665T.mjs.map