Skip to content

docs(sdk): sync auth-client@2.22.0 #42

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
Xaxis merged 1 commit into from
Jul 6, 2026
Merged

docs(sdk): sync auth-client@2.22.0 #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion src/pages/sdk/auth-client/functions/OcLinkedIdentities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const metadata = {
function OcLinkedIdentities(__namedParameters: OcLinkedIdentitiesProps): ReactElement;
```

Defined in: [linked-identities.tsx:94](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L94)
Defined in: [linked-identities.tsx:102](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L102)

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion src/pages/sdk/auth-client/functions/fetchOcLinkedIdentities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function fetchOcLinkedIdentities(opts?: {
}): Promise<OcLinkedIdentity[]>;
```

Defined in: [linked-identities.tsx:70](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L70)
Defined in: [linked-identities.tsx:72](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L72)

Fetch the signed-in user's linked identities from the auth host —
the same data `<OcLinkedIdentities>` renders, exposed as a plain
Expand Down
8 changes: 4 additions & 4 deletions src/pages/sdk/auth-client/interfaces/OcLinkedIdentitiesProps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ export const metadata = {

# Interface: OcLinkedIdentitiesProps

Defined in: [linked-identities.tsx:83](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L83)
Defined in: [linked-identities.tsx:91](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L91)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| &lt;a id="property-authorigin">&lt;/a> `authOrigin?` | `string` | Auth host origin. Defaults to `https://ochk.io`. | [linked-identities.tsx:85](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L85) |
| &lt;a id="property-classname">&lt;/a> `className?` | `string` | Outer container className. | [linked-identities.tsx:87](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L87) |
| &lt;a id="property-onchange">&lt;/a> `onChange?` | () => `void` | Called after every successful link / unlink / transfer. | [linked-identities.tsx:89](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L89) |
| &lt;a id="property-authorigin">&lt;/a> `authOrigin?` | `string` | Auth host origin. Defaults to `https://ochk.io`. | [linked-identities.tsx:93](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L93) |
| &lt;a id="property-classname">&lt;/a> `className?` | `string` | Outer container className. | [linked-identities.tsx:95](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L95) |
| &lt;a id="property-onchange">&lt;/a> `onChange?` | () => `void` | Called after every successful link / unlink / transfer. | [linked-identities.tsx:97](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L97) |
14 changes: 7 additions & 7 deletions src/pages/sdk/auth-client/interfaces/OcLinkedIdentity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ export const metadata = {

# Interface: OcLinkedIdentity

Defined in: [linked-identities.tsx:36](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L36)
Defined in: [linked-identities.tsx:38](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L38)

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| &lt;a id="property-id">&lt;/a> `id` | `string` | - | [linked-identities.tsx:37](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L37) |
| &lt;a id="property-is_primary">&lt;/a> `is_primary` | `boolean` | The signup-time identity for its kind · cannot be unlinked here. | [linked-identities.tsx:44](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L44) |
| &lt;a id="property-kind">&lt;/a> `kind` | `"email"` \| `"btc"` | - | [linked-identities.tsx:38](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L38) |
| &lt;a id="property-value">&lt;/a> `value` | `string` \| `null` | Raw value · null when the identity is pending recovery. | [linked-identities.tsx:40](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L40) |
| &lt;a id="property-verification_method">&lt;/a> `verification_method` | `"email-otp"` \| `"bip322"` \| `null` | - | [linked-identities.tsx:42](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L42) |
| &lt;a id="property-verified_at">&lt;/a> `verified_at` | `string` \| `null` | - | [linked-identities.tsx:41](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L41) |
| &lt;a id="property-id">&lt;/a> `id` | `string` | - | [linked-identities.tsx:39](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L39) |
| &lt;a id="property-is_primary">&lt;/a> `is_primary` | `boolean` | The signup-time identity for its kind · cannot be unlinked here. | [linked-identities.tsx:46](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L46) |
| &lt;a id="property-kind">&lt;/a> `kind` | `"email"` \| `"btc"` | - | [linked-identities.tsx:40](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L40) |
| &lt;a id="property-value">&lt;/a> `value` | `string` \| `null` | Raw value · null when the identity is pending recovery. | [linked-identities.tsx:42](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L42) |
| &lt;a id="property-verification_method">&lt;/a> `verification_method` | `"email-otp"` \| `"bip322"` \| `null` | - | [linked-identities.tsx:44](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L44) |
| &lt;a id="property-verified_at">&lt;/a> `verified_at` | `string` \| `null` | - | [linked-identities.tsx:43](https://github.com/orangecheck/oc-packages/blob/main/auth-client/src/linked-identities.tsx#L43) |