Skip to content

Commit cee03d3

Browse files
SarahSoutoulSarahSoutoul
committed
Merge branch 'main' into chris/mobile-289-expo-google-universal-sign-in
2 parents 0168ba5 + 60ff1f1 commit cee03d3

File tree

180 files changed

+7579
-4568
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

180 files changed

+7579
-4568
lines changed

‎clerk-typedoc/backend/auth-object.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
| ---------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55
| <a id="debug"></a> `debug` | <code>() => \{ [key: string]: any; \}</code> | Used to help debug issues when using Clerk in development. |
66
| <a id="gettoken"></a> `getToken` | <code>() => Promise\<null\> \| () => Promise\<string\> \| ServerGetToken \| () => Promise\<null\></code> | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). |
7-
| <a id="has"></a> `has` | <code>CheckAuthorizationFromSessionClaims \| () => false</code> | A function that checks if the user has an organization role or custom permission. |
7+
| <a id="has"></a> `has` | <code>CheckAuthorizationFromSessionClaims \| () => false</code> | A function that checks if the user has an Organization Role or Custom Permission. |
88
| <a id="tokentype"></a> `tokenType` | <code>null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token"</code> | The allowed token type. |

‎clerk-typedoc/backend/authenticate-request-options.mdx‎

Lines changed: 24 additions & 24 deletions
Large diffs are not rendered by default.

‎clerk-typedoc/backend/billing-plan.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
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](/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
1+
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](/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
22

33
## Properties
44

55
| Property | Type | Description |
66
| ------------------------------------------------ | --------------------------------------- | --------------------------------------------------------------- |
7-
| <a id="annualfee"></a> `annualFee` | <code>null \| BillingMoneyAmount</code> | The annual fee of the plan. |
8-
| <a id="annualmonthlyfee"></a> `annualMonthlyFee` | <code>null \| BillingMoneyAmount</code> | The annual fee of the plan on a monthly basis. |
9-
| <a id="description"></a> `description` | <code>null \| string</code> | The description of the plan. |
10-
| <a id="features"></a> `features` | <code>[Feature](feature.mdx)[]</code> | The features the plan offers. |
11-
| <a id="fee"></a> `fee` | `BillingMoneyAmount` | The monthly fee of the plan. |
12-
| <a id="forpayertype"></a> `forPayerType` | <code>"user" \| "org"</code> | The type of payer for the plan. |
13-
| <a id="hasbasefee"></a> `hasBaseFee` | `boolean` | Whether the plan has a base fee. |
14-
| <a id="id"></a> `id` | `string` | The unique identifier for the plan. |
15-
| <a id="isdefault"></a> `isDefault` | `boolean` | Whether the plan is the default plan. |
16-
| <a id="isrecurring"></a> `isRecurring` | `boolean` | Whether the plan is recurring. |
17-
| <a id="name"></a> `name` | `string` | The name of the plan. |
18-
| <a id="publiclyvisible"></a> `publiclyVisible` | `boolean` | Whether the plan is displayed in the `<PriceTable/>` component. |
19-
| <a id="slug"></a> `slug` | `string` | The URL-friendly identifier of the plan. |
7+
| <a id="annualfee"></a> `annualFee` | <code>null \| BillingMoneyAmount</code> | The annual fee of the Plan. |
8+
| <a id="annualmonthlyfee"></a> `annualMonthlyFee` | <code>null \| BillingMoneyAmount</code> | The annual fee of the Plan on a monthly basis. |
9+
| <a id="description"></a> `description` | <code>null \| string</code> | The description of the Plan. |
10+
| <a id="features"></a> `features` | <code>[Feature](feature.mdx)[]</code> | The features the Plan offers. |
11+
| <a id="fee"></a> `fee` | `BillingMoneyAmount` | The monthly fee of the Plan. |
12+
| <a id="forpayertype"></a> `forPayerType` | <code>"user" \| "org"</code> | The type of payer for the Plan. |
13+
| <a id="hasbasefee"></a> `hasBaseFee` | `boolean` | Whether the Plan has a base fee. |
14+
| <a id="id"></a> `id` | `string` | The unique identifier for the Plan. |
15+
| <a id="isdefault"></a> `isDefault` | `boolean` | Whether the Plan is the default Plan. |
16+
| <a id="isrecurring"></a> `isRecurring` | `boolean` | Whether the Plan is recurring. |
17+
| <a id="name"></a> `name` | `string` | The name of the Plan. |
18+
| <a id="publiclyvisible"></a> `publiclyVisible` | `boolean` | Whether the Plan is displayed in the `<PriceTable/>` component. |
19+
| <a id="slug"></a> `slug` | `string` | The URL-friendly identifier of the Plan. |

‎clerk-typedoc/backend/billing-subscription-item.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItem
1616
| <a id="payerid"></a> `payerId` | <code>undefined \| string</code> | The payer ID. |
1717
| <a id="periodend"></a> `periodEnd` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the current period ends. |
1818
| <a id="periodstart"></a> `periodStart` | `number` | Unix timestamp (milliseconds) of when the current period starts. |
19-
| <a id="plan"></a> `plan` | <code>null \| [BillingPlan](billing-plan.mdx)</code> | The plan associated with this subscription item. |
20-
| <a id="planid"></a> `planId` | <code>null \| string</code> | The plan ID. |
21-
| <a id="planperiod"></a> `planPeriod` | <code>"month" \| "annual"</code> | The plan period for the subscription item. |
19+
| <a id="plan"></a> `plan` | <code>null \| [BillingPlan](billing-plan.mdx)</code> | The Plan associated with this subscription item. |
20+
| <a id="planid"></a> `planId` | <code>null \| string</code> | The Plan ID. |
21+
| <a id="planperiod"></a> `planPeriod` | <code>"month" \| "annual"</code> | The Plan period for the subscription item. |
2222
| <a id="status"></a> `status` | `BillingSubscriptionItemStatus` | The status of the subscription item. |
2323
| <a id="updatedat"></a> `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was last updated. |

‎clerk-typedoc/backend/feature.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
The `Feature` object represents a feature of a subscription plan.
1+
The `Feature` object represents a Feature of a Subscription Plan.
22

33
## Properties
44

55
| Property | Type | Description |
66
| -------------------------------------- | --------------------------- | ------------------------------------------- |
7-
| <a id="avatarurl"></a> `avatarUrl` | <code>null \| string</code> | The URL of the feature's avatar image. |
8-
| <a id="description"></a> `description` | <code>null \| string</code> | The description of the feature. |
9-
| <a id="id"></a> `id` | `string` | The unique identifier for the feature. |
10-
| <a id="name"></a> `name` | `string` | The name of the feature. |
11-
| <a id="slug"></a> `slug` | `string` | The URL-friendly identifier of the feature. |
7+
| <a id="avatarurl"></a> `avatarUrl` | <code>null \| string</code> | The URL of the Feature's avatar image. |
8+
| <a id="description"></a> `description` | <code>null \| string</code> | The description of the Feature. |
9+
| <a id="id"></a> `id` | `string` | The unique identifier for the Feature. |
10+
| <a id="name"></a> `name` | `string` | The name of the Feature. |
11+
| <a id="slug"></a> `slug` | `string` | The URL-friendly identifier of the Feature. |

‎clerk-typedoc/backend/organization-invitation.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](/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](/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
1+
The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](/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](/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
22

33
## Properties
44

@@ -11,9 +11,9 @@ The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvi
1111
| <a id="organizationid"></a> `organizationId` | `string` | The ID of the [`Organization`](/docs/reference/backend/types/backend-organization) that the user is invited to. |
1212
| <a id="privatemetadata"></a> `privateMetadata` | [`OrganizationInvitationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-private-metadata) | Metadata that can be read and set only from the [Backend API](/docs/reference/backend-api){{ target: '_blank' }}. |
1313
| <a id="publicmetadata"></a> `publicMetadata` | [`OrganizationInvitationPublicMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-public-metadata) | Metadata that can be read from the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. |
14-
| <a id="publicorganizationdata"></a> `publicOrganizationData?` | <code>null \| [PublicOrganizationDataJSON](#public-organization-data-json)</code> | Public data about the organization that the user is invited to. |
15-
| <a id="role"></a> `role` | `string` | The role of the invited user. |
16-
| <a id="rolename"></a> `roleName` | `string` | The name of the role of the invited user. |
14+
| <a id="publicorganizationdata"></a> `publicOrganizationData?` | <code>null \| [PublicOrganizationDataJSON](#public-organization-data-json)</code> | Public data about the Organization that the user is invited to. |
15+
| <a id="role"></a> `role` | `string` | The Role of the invited user. |
16+
| <a id="rolename"></a> `roleName` | `string` | The name of the Role of the invited user. |
1717
| <a id="status"></a> `status?` | <code>"revoked" \| "pending" \| "accepted"</code> | The status of the invitation. |
1818
| <a id="updatedat"></a> `updatedAt` | `number` | The date when the invitation was last updated. |
1919
| <a id="url"></a> `url` | <code>null \| string</code> | The URL that the user can use to accept the invitation. |

0 commit comments

Comments
 (0)