You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* By default, `@deprecated` is output with `**Deprecated**`. We want to add a full stop to it.
@@ -105,6 +140,15 @@ function getCatchAllReplacements() {
105
140
pattern: /\*\*Example\*\*`([^`]+)`/g,
106
141
replace: 'Example: `$1`.',
107
142
},
143
+
{
144
+
/**
145
+
* By default, multiple `@example` are output with "**Examples** `value1` `value2`". We want to capture the values and place them inside "Examples: `value1`, `value2`."
Copy file name to clipboardExpand all lines: packages/backend/src/api/resources/AllowlistIdentifier.ts
+24Lines changed: 24 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,38 @@
1
1
importtype{AllowlistIdentifierType}from'./Enums';
2
2
importtype{AllowlistIdentifierJSON}from'./JSON';
3
3
4
+
/**
5
+
* The Backend `AllowlistIdentifier` object represents an identifier that has been added to the allowlist of your application. The Backend `AllowlistIdentifier` object is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Allow-list-Block-list#operation/ListAllowlistIdentifiers) and is not directly accessible from the Frontend API.
6
+
*/
4
7
exportclassAllowlistIdentifier{
5
8
constructor(
9
+
/**
10
+
* A unique ID for the allowlist identifier.
11
+
*/
6
12
readonlyid: string,
13
+
/**
14
+
* The [identifier](https://clerk.com/docs/authentication/configuration/sign-up-sign-in-options#identifiers) that was added to the allowlist.
15
+
*/
7
16
readonlyidentifier: string,
17
+
/**
18
+
* The type of the allowlist identifier.
19
+
*/
8
20
readonlyidentifierType: AllowlistIdentifierType,
21
+
/**
22
+
* The date when the allowlist identifier was first created.
23
+
*/
9
24
readonlycreatedAt: number,
25
+
/**
26
+
* The date when the allowlist identifier was last updated.
27
+
*/
10
28
readonlyupdatedAt: number,
29
+
/**
30
+
* The ID of the instance that this allowlist identifier belongs to.
31
+
*/
11
32
readonlyinstanceId?: string,
33
+
/**
34
+
* The ID of the invitation sent to the identifier.
Copy file name to clipboardExpand all lines: packages/backend/src/api/resources/Client.ts
+27Lines changed: 27 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,42 @@
1
1
importtype{ClientJSON}from'./JSON';
2
2
import{Session}from'./Session';
3
3
4
+
/**
5
+
* The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/references/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.
6
+
*/
4
7
exportclassClient{
5
8
constructor(
9
+
/**
10
+
* The unique identifier for the `Client`.
11
+
*/
6
12
readonlyid: string,
13
+
/**
14
+
* An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} IDs associated with the `Client`.
15
+
*/
7
16
readonlysessionIds: string[],
17
+
/**
18
+
* An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} objects associated with the `Client`.
19
+
*/
8
20
readonlysessions: Session[],
21
+
/**
22
+
* The ID of the [`SignIn`](https://clerk.com/docs/references/javascript/sign-in){{ target: '_blank' }}.
23
+
*/
9
24
readonlysignInId: string|null,
25
+
/**
26
+
* The ID of the [`SignUp`](https://clerk.com/docs/references/javascript/sign-up){{ target: '_blank' }}.
27
+
*/
10
28
readonlysignUpId: string|null,
29
+
/**
30
+
* The ID of the last active [Session](https://clerk.com/docs/references/backend/types/backend-session).
Copy file name to clipboardExpand all lines: packages/backend/src/api/resources/Deserializer.ts
+17Lines changed: 17 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -39,10 +39,27 @@ import { ObjectType } from './JSON';
39
39
import{WaitlistEntry}from'./WaitlistEntry';
40
40
41
41
typeResourceResponse<T>={
42
+
/**
43
+
* An array that contains the fetched data.
44
+
*/
42
45
data: T;
43
46
};
44
47
48
+
/**
49
+
* An interface that describes the response of a method that returns a paginated list of resources.
50
+
*
51
+
* If the promise resolves, you will get back the [properties](#properties) listed below. `data` will be an array of the resource type you requested. You can use the `totalCount` property to determine how many total items exist remotely.
52
+
*
53
+
* Some methods that return this type allow pagination with the `limit` and `offset` parameters, in which case the first 10 items will be returned by default. For methods such as [`getAllowlistIdentifierList()`](https://clerk.com/docs/references/backend/allowlist/get-allowlist-identifier-list), which do not take a `limit` or `offset`, all items will be returned.
54
+
*
55
+
* If the promise is rejected, you will receive a `ClerkAPIResponseError` or network error.
Copy file name to clipboardExpand all lines: packages/backend/src/api/resources/EmailAddress.ts
+19Lines changed: 19 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,30 @@ import { IdentificationLink } from './IdentificationLink';
2
2
importtype{EmailAddressJSON}from'./JSON';
3
3
import{Verification}from'./Verification';
4
4
5
+
/**
6
+
* The Backend `EmailAddress` object is a model around an email address. Email addresses are one of the [identifiers](https://clerk.com/docs/authentication/configuration/sign-up-sign-in-options#identifiers) used to provide identification for users.
7
+
*
8
+
* Email addresses must be **verified** to ensure that they are assigned to their rightful owners. The `EmailAddress` object holds all necessary state around the verification process.
9
+
*
10
+
* For implementation examples for adding and verifying email addresses, see the [email link custom flow](https://clerk.com/docs/custom-flows/email-links) and [email code custom flow](https://clerk.com/docs/custom-flows/add-email) guides.
11
+
*/
5
12
exportclassEmailAddress{
6
13
constructor(
14
+
/**
15
+
* The unique identifier for the email address.
16
+
*/
7
17
readonlyid: string,
18
+
/**
19
+
* The value of the email address.
20
+
*/
8
21
readonlyemailAddress: string,
22
+
/**
23
+
* An object holding information on the verification of the email address.
24
+
*/
9
25
readonlyverification: Verification|null,
26
+
/**
27
+
* An array of objects containing information about any identifications that might be linked to the email address.
0 commit comments