Skip to content

chore(backend,react,shared,vue): Update docs links #8047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexisintech merged 2 commits into from
Mar 12, 2026
Merged

chore(backend,react,shared,vue): Update docs links #8047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f350523
chore(docs): Update docs links
alexisintech Mar 11, 2026
4b2eae7
add empty changeset
alexisintech Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/better-ways-doubt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
93 changes: 46 additions & 47 deletions .typedoc/custom-plugin.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,25 +43,25 @@ const FILES_WITHOUT_HEADINGS = [
* Ideally this is a temporary solution until every one of these files are published in production and can be linked to.
*/
const LINK_REPLACEMENTS = [
['set-active-params', '/docs/reference/javascript/types/set-active-params'],
['clerk-paginated-response', '/docs/reference/javascript/types/clerk-paginated-response'],
['set-active-params', '/docs/reference/types/set-active-params'],
['clerk-paginated-response', '/docs/reference/types/clerk-paginated-response'],
['paginated-resources', '#paginated-resources'],
['use-checkout-options', '#use-checkout-options'],
['needs-reverification-parameters', '#needs-reverification-parameters'],
['create-organization-params', '#create-organization-params'],
['session-resource', '/docs/reference/javascript/session'],
['signed-in-session-resource', '/docs/reference/javascript/session'],
['sign-in-resource', '/docs/reference/javascript/sign-in'],
['sign-up-resource', '/docs/reference/javascript/sign-up'],
['user-resource', '/docs/reference/javascript/user'],
['session-status-claim', '/docs/reference/javascript/types/session-status'],
['user-organization-invitation-resource', '/docs/reference/javascript/types/user-organization-invitation'],
['organization-membership-resource', '/docs/reference/javascript/types/organization-membership'],
['organization-suggestion-resource', '/docs/reference/javascript/types/organization-suggestion'],
['organization-resource', '/docs/reference/javascript/organization'],
['organization-domain-resource', '/docs/reference/javascript/types/organization-domain-resource'],
['organization-invitation-resource', '/docs/reference/javascript/types/organization-invitation'],
['organization-membership-request-resource', '/docs/reference/javascript/types/organization-membership-request'],
['session-resource', '/docs/reference/objects/session'],
['signed-in-session-resource', '/docs/reference/objects/session'],
['sign-in-resource', '/docs/reference/objects/sign-in'],
['sign-up-resource', '/docs/reference/objects/sign-up'],
['user-resource', '/docs/reference/objects/user'],
['session-status-claim', '/docs/reference/types/session-status'],
['user-organization-invitation-resource', '/docs/reference/types/user-organization-invitation'],
['organization-membership-resource', '/docs/reference/types/organization-membership'],
['organization-suggestion-resource', '/docs/reference/types/organization-suggestion'],
['organization-resource', '/docs/reference/objects/organization'],
['organization-domain-resource', '/docs/reference/types/organization-domain-resource'],
['organization-invitation-resource', '/docs/reference/types/organization-invitation'],
['organization-membership-request-resource', '/docs/reference/types/organization-membership-request'],
['session', '/docs/reference/backend/types/backend-session'],
['session-activity', '/docs/reference/backend/types/backend-session-activity'],
['organization', '/docs/reference/backend/types/backend-organization'],
Expand All @@ -77,22 +77,22 @@ const LINK_REPLACEMENTS = [
['invitation', '/docs/reference/backend/types/backend-invitation'],
['verify-token-options', '#verify-token-options'],
['localization-resource', '/docs/guides/customizing-clerk/localization'],
['confirm-checkout-params', '/docs/reference/javascript/types/billing-checkout-resource#parameters'],
['billing-payment-method-resource', '/docs/reference/javascript/types/billing-payment-method-resource'],
['billing-payer-resource', '/docs/reference/javascript/types/billing-payer-resource'],
['billing-plan-resource', '/docs/reference/javascript/types/billing-plan-resource'],
['billing-checkout-totals', '/docs/reference/javascript/types/billing-checkout-totals'],
['billing-checkout-resource', '/docs/reference/javascript/types/billing-checkout-resource'],
['billing-money-amount', '/docs/reference/javascript/types/billing-money-amount'],
['billing-subscription-item-resource', '/docs/reference/javascript/types/billing-subscription-item-resource'],
['feature-resource', '/docs/reference/javascript/types/feature-resource'],
['billing-statement-group', '/docs/reference/javascript/types/billing-statement-group'],
['billing-statement-resource', '/docs/reference/javascript/types/billing-statement-resource'],
['billing-subscription-resource', '/docs/reference/javascript/types/billing-subscription-resource'],
['clerk-api-response-error', '/docs/reference/javascript/types/clerk-api-response-error'],
['billing-statement-totals', '/docs/reference/javascript/types/billing-statement-totals'],
['billing-payment-resource', '/docs/reference/javascript/types/billing-payment-resource'],
['deleted-object-resource', '/docs/reference/javascript/types/deleted-object-resource'],
['confirm-checkout-params', '/docs/reference/types/billing-checkout-resource#parameters'],
['billing-payment-method-resource', '/docs/reference/types/billing-payment-method-resource'],
['billing-payer-resource', '/docs/reference/types/billing-payer-resource'],
['billing-plan-resource', '/docs/reference/types/billing-plan-resource'],
['billing-checkout-totals', '/docs/reference/types/billing-checkout-totals'],
['billing-checkout-resource', '/docs/reference/types/billing-checkout-resource'],
['billing-money-amount', '/docs/reference/types/billing-money-amount'],
['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
['feature-resource', '/docs/reference/types/feature-resource'],
['billing-statement-group', '/docs/reference/types/billing-statement-group'],
['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
['billing-statement-totals', '/docs/reference/types/billing-statement-totals'],
['billing-payment-resource', '/docs/reference/types/billing-payment-resource'],
['deleted-object-resource', '/docs/reference/types/deleted-object-resource'],
['checkout-flow-resource', '/docs/reference/hooks/use-checkout#checkout-flow-resource'],
['organization-creation-defaults-resource', '#organization-creation-defaults-resource'],
];
Expand Down Expand Up @@ -133,7 +133,7 @@ function getCatchAllReplacements() {
},
{
pattern: /`LoadedClerk`/g,
replace: '[Clerk](/docs/reference/javascript/clerk)',
replace: '[Clerk](/docs/reference/objects/clerk)',
},
{
pattern: /(?<![\[\w`])`?LocalizationResource`?(?![\]\w`])/g,
Expand All @@ -143,64 +143,63 @@ function getCatchAllReplacements() {
// SessionResource appears in plain text, with an array next to it, with backticks, etc.
// e.g. `SessionResource[]`
pattern: /(?<![`[\]])\bSessionResource(\[\])?\b(?![\]\)`])/g,
replace: '[`SessionResource`](/docs/reference/javascript/session)$1',
replace: '[`SessionResource`](/docs/reference/objects/session)$1',
},
{
pattern: /(?<![\[\w`])`?SessionStatusClaim`?(?![\]\w`])/g,
replace: '[`SessionStatusClaim`](/docs/reference/javascript/types/session-status)',
replace: '[`SessionStatusClaim`](/docs/reference/types/session-status)',
},
{
pattern: /(?<![`[\]])\bSetActiveParams\b(?![\]\(])/g,
replace: '[SetActiveParams](/docs/reference/javascript/types/set-active-params)',
replace: '[SetActiveParams](/docs/reference/types/set-active-params)',
},
{
pattern: /(?<![\[\w`])`?SignInResource`?(?![\]\w`])/g,
replace: '[`SignInResource`](/docs/reference/javascript/sign-in)',
replace: '[`SignInResource`](/docs/reference/objects/sign-in)',
},
{
pattern: /(?<![\[\w`])`?SignedInSessionResource`?(?![\]\w`])/g,
replace: '[`SignedInSessionResource`](/docs/reference/javascript/session)',
replace: '[`SignedInSessionResource`](/docs/reference/objects/session)',
},
{
pattern: /(?<![\[\w`])`?SignUpResource`?(?![\]\w`])/g,
replace: '[`SignUpResource`](/docs/reference/javascript/sign-up)',
replace: '[`SignUpResource`](/docs/reference/objects/sign-up)',
},
{
pattern: /(?<![\[\w`])`?OrganizationResource`?(?![\]\w`])/g,
replace: '[`OrganizationResource`](/docs/reference/javascript/organization)',
replace: '[`OrganizationResource`](/docs/reference/objects/organization)',
},
{
pattern: /`OrganizationPrivateMetadata`/g,
replace:
'[`OrganizationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-private-metadata)',
replace: '[`OrganizationPrivateMetadata`](/docs/reference/types/metadata#organization-private-metadata)',
},
{
pattern: /OrganizationPublicMetadata/g,
replace: '[OrganizationPublicMetadata](/docs/reference/javascript/types/metadata#organization-public-metadata)',
replace: '[OrganizationPublicMetadata](/docs/reference/types/metadata#organization-public-metadata)',
},
{
pattern: /`OrganizationInvitationPrivateMetadata`/g,
replace:
'[`OrganizationInvitationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-private-metadata)',
'[`OrganizationInvitationPrivateMetadata`](/docs/reference/types/metadata#organization-invitation-private-metadata)',
},
{
pattern: /`OrganizationInvitationPublicMetadata`/g,
replace:
'[`OrganizationInvitationPublicMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-public-metadata)',
'[`OrganizationInvitationPublicMetadata`](/docs/reference/types/metadata#organization-invitation-public-metadata)',
},
{
pattern: /`OrganizationMembershipPrivateMetadata`/g,
replace:
'[`OrganizationMembershipPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-membership-private-metadata)',
'[`OrganizationMembershipPrivateMetadata`](/docs/reference/types/metadata#organization-membership-private-metadata)',
},
{
pattern: /`OrganizationMembershipPublicMetadata`/g,
replace:
'[`OrganizationMembershipPublicMetadata`](/docs/reference/javascript/types/metadata#organization-membership-public-metadata)',
'[`OrganizationMembershipPublicMetadata`](/docs/reference/types/metadata#organization-membership-public-metadata)',
},
{
pattern: /(?<![\[\w`])`?UserResource`?(?![\]\w`])/g,
replace: '[`UserResource`](/docs/reference/javascript/user)',
replace: '[`UserResource`](/docs/reference/objects/user)',
},
{
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/APIKey.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export class APIKey {
*/
readonly updatedAt: number,
/**
* 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.**
* 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.**
*/
readonly secret?: string,
) {}
Expand Down
6 changes: 3 additions & 3 deletions packages/backend/src/api/resources/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { ClientJSON } from './JSON';
import { Session } from './Session';

/**
* 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.
* 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.
*/
export class Client {
constructor(
Expand All @@ -21,11 +21,11 @@ export class Client {
*/
readonly sessions: Session[],
/**
* The ID of the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in){{ target: '_blank' }}.
* The ID of the [`SignIn`](https://clerk.com/docs/reference/objects/sign-in).
*/
readonly signInId: string | null,
/**
* The ID of the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up){{ target: '_blank' }}.
* The ID of the [`SignUp`](https://clerk.com/docs/reference/objects/sign-up).
*/
readonly signUpId: string | null,
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/CommercePlan.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Feature } from './Feature';
import type { BillingPlanJSON } from './JSON';

/**
* 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.
* 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.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# First, let's look at the CommercePlan.ts file to see the actual documentation links
cat -n packages/backend/src/api/resources/CommercePlan.ts | head -20

Repository: clerk/javascript

Length of output: 1261

🏁 Script executed:

# Check for similar documentation route changes in the PR
git diff HEAD~1 -- '**/*.ts' '**/*.tsx' | grep -A 3 -B 3 'docs/reference' | head -50

Repository: clerk/javascript

Length of output: 88

🏁 Script executed:

# Search for documentation link patterns in the codebase to understand the scope
rg 'docs/reference/(types|objects)' --type ts --type tsx -c

Repository: clerk/javascript

Length of output: 87

🏁 Script executed:

# Search for documentation links in TypeScript files
rg 'docs/reference' --type ts -c 2>/dev/null || rg 'docs/reference' -t ts -c 2>/dev/null || rg 'docs/reference' | grep -E '\.(ts|tsx):' | head -30

Repository: clerk/javascript

Length of output: 3294

🏁 Script executed:

# Look for any recent commits or changes that might indicate the PR scope
git log --oneline -10 2>/dev/null || echo "Git log unavailable"

Repository: clerk/javascript

Length of output: 88

🏁 Script executed:

# Check if there are any documentation or migration-related files that hint at route changes
fd -t f 'clerk-docs' . 2>/dev/null | head -10 || echo "No clerk-docs references found"

Repository: clerk/javascript

Length of output: 42

🏁 Script executed:

# Search more broadly for the specific types/objects pattern in comments
rg 'billing-plan-resource' --type ts 2>/dev/null || rg 'billing-plan-resource' | head -20

Repository: clerk/javascript

Length of output: 525

🌐 Web query:

site:clerk.com/docs/reference/types/billing-plan-resource

💡 Result:

The Clerk Docs page you’re looking for is the BillingPlanResource type reference (Clerk’s Billing “Plan” object). It’s available at https://clerk.com/docs/reference/javascript/types/billing-plan-resource. [1]

What BillingPlanResource contains (key properties): id, name, slug, description, avatarUrl, features (FeatureResource[]), pricing fields like fee (monthly), annualFee, annualMonthlyFee, trial fields like freeTrialEnabled and freeTrialDays, plus flags like isDefault, publiclyVisible, isRecurring, hasBaseFee, and forPayerType ("org" | "user"). [1]

🌐 Web query:

clerk clerk-docs 3185 billing plan resource new documentation routes

💡 Result:

PR #3185 in clerk/clerk-docs (draft as of Mar 11, 2026) is a JavaScript reference-docs revamp that changes documentation routes by: (1) moving object reference pages from /docs/reference/javascript/** → /docs/reference/objects/**, and (2) moving type reference pages from /docs/reference/javascript/types/** → /docs/reference/types/**, with redirects added so old links keep working. [1]

For BillingPlanResource specifically, the current live page is still under the old JavaScript types route: /docs/reference/javascript/types/billing-plan-resource (last updated Mar 4, 2026). [2] Under the PR’s plan, it would be reachable at /docs/reference/types/billing-plan-resource. [1]

Sources:
[1] PR #3185 description (route moves + redirects) clerk/clerk-docs#3185
[2] Current BillingPlanResource doc page https://clerk.com/docs/reference/javascript/types/billing-plan-resource

🌐 Web query:

site:clerk.com/docs/reference/types/billing-plan-resource

💡 Result:

The Clerk docs page you’re pointing to is BillingPlanResource (JavaScript Types). It defines the shape of a subscription plan object and includes these key properties: id, name, slug, description, avatarUrl, fee (monthly), annualFee, annualMonthlyFee, isDefault, publiclyVisible, forPayerType ("org" | "user"), isRecurring, hasBaseFee, plus free-trial fields freeTrialEnabled and freeTrialDays, and features: FeatureResource[]. (clerk.com)

Citations:

🌐 Web query:

clerk-docs PR 3185 merged deployed live March 2026 documentation routes /types /objects

💡 Result:

  • PR status (clerk/clerk-docs #3185): As of March 11, 2026, PR Nextjs 14, docker, production error: Failed to load Clerk #3185 is still a Draft and not merged into main. (github.com)
  • Deployed? It has a Vercel preview deployment (e.g. clerk-docs-git-aa-javascript-revamp.clerkstage.dev) updated Mar 11, 2026 10:01pm UTC, but that is not the live production docs site. (github.com)
  • Route changes proposed in the PR:
    • Move object reference docs from /docs/reference/javascript/** → /docs/reference/objects/** (github.com)
    • Move type reference docs from /docs/reference/javascript/types/** → /docs/reference/types/** (github.com)
    • Add redirects for the moved routes. (github.com)
  • What’s live on clerk.com right now: the types overview page is currently accessible under the JavaScript path (example: /docs/reference/javascript/types/overview, “Last updated on Mar 6, 2026”). (clerk.com)

Citations:

🏁 Script executed:

# Search for all documentation link references being modified in this PR to assess scope
rg '/docs/reference/(types|objects)' packages/backend/src/api/resources/ -n

Repository: clerk/javascript

Length of output: 5524

🏁 Script executed:

# Check broader codebase for organization-membership and sign-up doc links
rg 'organization-membership|sign-up' --type ts -n | grep 'docs/reference' | head -10

Repository: clerk/javascript

Length of output: 2674

Block merge until clerk/clerk-docs#3185 is deployed.

This PR updates documentation links across ~10 files to point to the new /docs/reference/types/* and /docs/reference/objects/* routes (e.g., organization-membership, sign-up, billing-plan-resource). However, these new routes are not yet live—the referenced clerk-docs PR is still in draft status as of March 11, 2026. Merging now would replace working links (currently under /docs/reference/javascript/types/* and /docs/reference/objects/*) with non-existent ones. Wait for clerk/clerk-docs#3185 to be deployed and include redirects before merging.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@packages/backend/src/api/resources/CommercePlan.ts` at line 7, The changes
replace working doc links with new routes that aren't live yet; stop this merge
and either revert the updated links back to the current working routes (e.g.,
the javascript/types and objects paths) or hold the PR until
clerk/clerk-docs#3185 is deployed with redirects; specifically, in the
CommercePlan.ts description referencing the `BillingPlan` object (and any other
files that now point to `/docs/reference/types/*` or
`/docs/reference/objects/*`), restore the original
`/docs/reference/javascript/types/*` and `/docs/reference/objects/*` links or
wait to update all links in one coordinated change once the docs PR is live.

*
* @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.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/CommerceSubscription.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
import type { BillingSubscriptionJSON } from './JSON';

/**
* 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.
* 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.
*
* @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.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/CommerceSubscriptionItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { BillingPlan } from './CommercePlan';
import type { BillingSubscriptionItemJSON } from './JSON';

/**
* 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.
* 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.
*
* @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.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/Invitation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export class Invitation {
*/
readonly emailAddress: string,
/**
* [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.
* [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.
*/
readonly publicMetadata: Record<string, unknown> | null,
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/Organization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { OrganizationJSON } from './JSON';

/**
* 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.
* 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.
*/
export class Organization {
private _raw: OrganizationJSON | null = null;
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/OrganizationInvitation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { OrganizationInvitationStatus, OrganizationMembershipRole } from '.
import type { OrganizationInvitationJSON, PublicOrganizationDataJSON } from './JSON';

/**
* 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.
* 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.
*/
export class OrganizationInvitation {
private _raw: OrganizationInvitationJSON | null = null;
Expand Down
Loading
Loading