diff --git a/.changeset/fix-organization-jsdoc-links.md b/.changeset/fix-organization-jsdoc-links.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/fix-organization-jsdoc-links.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/packages/shared/src/types/billing.ts b/packages/shared/src/types/billing.ts index c4591f516e7..60390e1206e 100644 --- a/packages/shared/src/types/billing.ts +++ b/packages/shared/src/types/billing.ts @@ -157,9 +157,7 @@ export type GetPlansParams = ClerkPaginationParams<{ */ for?: ForPayerType; /** - * The organization ID to fetch plans for (needs to match the current active organization ID). Providing this - * parameter will populate the `availablePrices` field with the prices that are available to the - * authenticated organization. + * The organization ID to fetch plans for (needs to match the current [Active Organization](!active-organization) ID). Providing this parameter will populate the `availablePrices` field with the prices that are available to the authenticated organization. */ orgId?: string; /** diff --git a/packages/shared/src/types/organizationDomain.ts b/packages/shared/src/types/organizationDomain.ts index d9d72746975..f9a08a428d5 100644 --- a/packages/shared/src/types/organizationDomain.ts +++ b/packages/shared/src/types/organizationDomain.ts @@ -54,7 +54,7 @@ export interface OrganizationDomainResource extends ClerkResource { * * */ @@ -76,7 +76,7 @@ export interface OrganizationDomainResource extends ClerkResource { */ affiliationEmailAddress: string | null; /** - * The total number of pending [invitations](https://clerk.com/docs/reference/types/organizationinvitation) associated with this domain. + * The total number of pending [invitations](https://clerk.com/docs/reference/types/organization-invitation) associated with this domain. */ totalPendingInvitations: number; /** @@ -132,7 +132,7 @@ export type AttemptAffiliationVerificationParams = { /** @generateWithEmptyComment */ export type UpdateEnrollmentModeParams = Pick & { /** - * Whether to delete any pending [invitations](https://clerk.com/docs/reference/types/organizationinvitation) or [suggestions](https://clerk.com/docs/reference/types/organizationsuggestion) that were created by the previous enrollment mode. + * Whether to delete any pending [invitations](https://clerk.com/docs/reference/types/organization-invitation) or [suggestions](https://clerk.com/docs/reference/types/organization-suggestion) that were created by the previous enrollment mode. */ deletePending?: boolean; }; diff --git a/packages/shared/src/types/organizationMembership.ts b/packages/shared/src/types/organizationMembership.ts index a4f50101108..ca17721a71a 100644 --- a/packages/shared/src/types/organizationMembership.ts +++ b/packages/shared/src/types/organizationMembership.ts @@ -46,7 +46,7 @@ export interface OrganizationMembershipResource extends ClerkResource { */ id: string; /** - * The [`Organization`](https://clerk.com/docs/reference/types/organization) object the membership belongs to. + * The [`Organization`](https://clerk.com/docs/reference/objects/organization) object the membership belongs to. */ organization: OrganizationResource; /** diff --git a/packages/shared/src/types/organizationSettings.ts b/packages/shared/src/types/organizationSettings.ts index f7ce2739f1c..d35fd3db2a4 100644 --- a/packages/shared/src/types/organizationSettings.ts +++ b/packages/shared/src/types/organizationSettings.ts @@ -65,7 +65,7 @@ export interface OrganizationSettingsResource extends ClerkResource { * * */