Class Item

Readonlycontainer

Readonlyid

url

• get url(): string

• Returns a reference URL to the resource. Used for linking in Permissions.

  Returns string

delete

• delete<T>(options?): Promise<ItemResponse<T>>

• Delete the item.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it.

  Type Parameters

  • T extends ItemDefinition = any

  Parameters

  • options: RequestOptions = {}

    Additional options for the request

  Returns Promise<ItemResponse<T>>

patch

• patch<T>(body, options?): Promise<ItemResponse<T>>

• Perform a JSONPatch on the item.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it.

  Type Parameters

  • T extends ItemDefinition = any

  Parameters

  • body: PatchRequestBody
  • options: RequestOptions = {}

    Additional options for the request

  Returns Promise<ItemResponse<T>>

read

• read<T>(options?): Promise<ItemResponse<T>>

• Read the item's definition.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it. If the type, T, is a class, it won't pass typeof comparisons, because it won't have a match prototype. It's recommended to only use interfaces.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Type Parameters

  • T extends ItemDefinition = any

  Parameters

  • options: RequestOptions = {}

    Additional options for the request

  Returns Promise<ItemResponse<T>>

  Example: Using custom type for response

  interface TodoItem {
    title: string;
    done: bool;
    id: string;
  }
  
  let item: TodoItem;
  ({body: item} = await item.read<TodoItem>());
  Copy

replace

• replace(body, options?): Promise<ItemResponse<ItemDefinition>>

• Replace the item's definition.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Parameters

  • body: ItemDefinition

    The definition to replace the existing Item's definition with.
  • Optionaloptions: RequestOptions

    Additional options for the request

  Returns Promise<ItemResponse<ItemDefinition>>
• replace<T>(body, options?): Promise<ItemResponse<T>>

• Replace the item's definition.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Type Parameters

  • T extends ItemDefinition

  Parameters

  • body: T

    The definition to replace the existing Item's definition with.
  • Optionaloptions: RequestOptions

    Additional options for the request

  Returns Promise<ItemResponse<T>>