Unhide an address-book entry

client.org(orgId).addressBook.unhide

Use the Core SDK to unhide an address-book entry.

Import and client prerequisite

import { createCapxulClient } from "@capxul/sdk";

const created = await createCapxulClient({
  publishableKey: "cap_pk_…",
});

if (!created.ok) throw created.error;
const client = created.value;

Usage

declare const orgId: OrgId;
declare const entryId: PartyId;

const result = await client.org(orgId).addressBook.unhide(entryId);

if (!result.ok) {
  console.error(result.error.code);
  return;
}

console.log(result.value);

Signature

client.org(orgId).addressBook.unhide(entryId: PartyId, options?: { readonly signal?: AbortSignal; }): Promise<CapxulResult<AddressBookEntry>>;

Source: packages/sdk/src/surface/contacts.ts:98.

Parameters

entryId

Required.

PartyId;

options

Optional.

{ readonly signal?: AbortSignal; } | undefined

Returns

Promise<CapxulResult<AddressBookEntry>>;

Read the ok discriminant before accessing value or error.

Errors

Expected failures resolve as { ok: false, error: CapxulError }; they are not thrown as the normal domain contract. Branch on result.ok and use the stable error.code. A pre-aborted AbortSignal returns a CANCELLED failure. Provider messages and internal causes are not public contracts.

Availability and evidence

Available in the Core SDK. Evidence classification: shipped-proven.

shipped-proven at the typed or hermetic Core SDK contract boundary. The callable surface and result mapping are covered by release-trunk type or hermetic tests. That does not by itself prove a live backend, provider, email, browser, or chain journey. Check the capability-status reference before presenting this operation as live.

Related

• No dedicated React SDK hook currently projects this method.
• Platform capability matrix
• Core SDK scaffold inventory
• Result and proof boundaries