Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/fix-organization-jsdoc-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
4 changes: 1 addition & 3 deletions packages/shared/src/types/billing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
6 changes: 3 additions & 3 deletions packages/shared/src/types/organizationDomain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export interface OrganizationDomainResource extends ClerkResource {
*
* <ul>
* <li>`manual_invitation`: No automatic enrollment. Users with a matching email domain are not given any [invitation](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-invitations) or [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions); an admin must invite them manually.</li>
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organizationinvitation) (assigned the Organization's default role) which they can accept to join.</li>
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organization-invitation) (assigned the Organization's default role) which they can accept to join.</li>
* <li>`automatic_suggestion`: Users with a matching email domain automatically receive a [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions) to join, which they can request.</li>
* </ul>
*/
Expand All @@ -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;
/**
Expand Down Expand Up @@ -132,7 +132,7 @@ export type AttemptAffiliationVerificationParams = {
/** @generateWithEmptyComment */
export type UpdateEnrollmentModeParams = Pick<OrganizationDomainResource, 'enrollmentMode'> & {
/**
* 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;
};
2 changes: 1 addition & 1 deletion packages/shared/src/types/organizationMembership.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/types/organizationSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface OrganizationSettingsResource extends ClerkResource {
*
* <ul>
* <li>`manual_invitation`: No automatic enrollment. Users with a matching email domain are not given any [invitation](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-invitations) or [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions); an admin must invite them manually.</li>
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organizationinvitation) (assigned the Organization's default role) which they can accept to join.</li>
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organization-invitation) (assigned the Organization's default role) which they can accept to join.</li>
* <li>`automatic_suggestion`: Users with a matching email domain automatically receive a [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions) to join, which they can request.</li>
* </ul>
*/
Expand Down
Loading