# Class JBookmarkApi

#### Hierarchy (View Summary)

- JBaseApi
  - JBookmarkApi

- Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:13

##### Index

### Constructors

constructor

### Properties

jApi
network

### Methods

addBookmark
addFormattedLink
delete
getFormattedList
move
rename

## Constructors

### constructor

- new JBookmarkApi(jApi: JamespotUserApi): JBookmarkApi

  #### Parameters

  - jApi: JamespotUserApi

  #### Returns JBookmarkApi

  Inherited from JBaseApi.constructor

  - Defined in jamespot-user-api/src/apis/base.ts:8

## Properties

### jApi

jApi: JamespotUserApi

Inherited from JBaseApi.jApi

- Defined in jamespot-user-api/src/apis/base.ts:5

### network

network: Network

Inherited from JBaseApi.network

- Defined in jamespot-user-api/src/apis/base.ts:6

## Methods

### addBookmark

- addBookmark(
  bookmark: Pick<
  BookmarkTypes[keyof BookmarkTypes],
  "bookmarkLabel"
  | "bookmarkMeta"
  | "bookmarkUrl",
  >,
  format?: requiredKeys<
  baseObjectOutputType<
  {
  list: ZodObject<
  {
  _cssClass: ZodString;
  _cssColor: ZodString;
  _src: | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
  | ZodOptional<
  ZodObject<
  ZodShape<(...)> & { _url: ...; title: ... },
  "strip",
  ZodTypeAny,
  jObjectLittle,
  jObjectLittle,
  >,
  >;
  _target:
  | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
  | ZodOptional<
  ZodObject<
  ZodShape<(...)> & { _url: ...; title: ... },
  "strip",
  ZodTypeAny,
  jObjectLittle,
  jObjectLittle,
  >,
  >;
  _values: ZodOptional<
  ZodObject<
  { dateCreation: ZodString; dateModified: ZodString },
  "strip",
  ZodTypeAny,
  { dateCreation: string; dateModified: string },
  { dateCreation: string; dateModified: string },
  >,
  >;
  bookmarkLabel: ZodOptional<ZodString>;
  bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
  bookmarkOrder: ZodOptional<ZodString>;
  bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
  id: ZodNumber;
  mainType: ZodString;
  srcId: ZodNumber;
  srcType: ZodString;
  targetId: ZodNumber;
  targetType: ZodNullable<ZodString>;
  type: ZodString;
  uri: ZodString;
  url: ZodNullable<ZodOptional<ZodString>>;
  value: ZodNullable<ZodString>;
  },
  "strip",
  ZodTypeAny,
  {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  >;
  "raw-list": ZodObject<
  {
  _src: ZodOptional<
  | ZodType<jUserLittle, ZodTypeDef, jUserLittle>
  | ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>
  | ZodUnion<[(...), (...)]>,
  >;
  _target: ZodUnion<[ZodOptional<(...) | (...) | (...)>, ZodUndefined]>;
  dateCreation: ZodOptionalType<
  ZodType<string | undefined, ZodTypeDef, string | undefined>,
  >;
  dateModified: ZodOptionalType<
  ZodType<
  string
  | null
  | undefined,
  ZodTypeDef,
  string | null | undefined,
  >,
  >;
  id: ZodType<number, ZodTypeDef, number>;
  mainType: ZodType<string, ZodTypeDef, string>;
  srcId: ZodNumber;
  srcType: ZodString;
  targetId: ZodNumber;
  targetType: ZodNullable<ZodString>;
  uri: ZodType<string, ZodTypeDef, string>;
  value: ZodNullable<ZodString>;
  } & {
  bookmarkLabel: ZodOptional<ZodString>;
  bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
  bookmarkOrder: ZodOptional<ZodNumber>;
  bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
  type: ZodLiteral<"bookmarkLink">;
  url: ZodNullable<ZodOptional<ZodString>>;
  },
  "strip",
  ZodTypeAny,
  {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  },
  {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  },
  >;
  },
  >,
  >,
  ): Promise<
  ApiWrapper<
  | {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  }
  | {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  BaseMessagesOne,
  >,
  >

  #### Parameters

  - bookmark: Pick<
    BookmarkTypes[keyof BookmarkTypes],
    "bookmarkLabel"
    | "bookmarkMeta"
    | "bookmarkUrl",
    >
  - `Optional` format: requiredKeys<
    baseObjectOutputType<
    {
    list: ZodObject<
    {
    _cssClass: ZodString;
    _cssColor: ZodString;
    _src: | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
    | ZodOptional<
    ZodObject<
    ZodShape<(...)> & { _url: ...; title: ... },
    "strip",
    ZodTypeAny,
    jObjectLittle,
    jObjectLittle,
    >,
    >;
    _target:
    | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
    | ZodOptional<
    ZodObject<
    ZodShape<(...)> & { _url: ...; title: ... },
    "strip",
    ZodTypeAny,
    jObjectLittle,
    jObjectLittle,
    >,
    >;
    _values: ZodOptional<
    ZodObject<
    { dateCreation: ZodString; dateModified: ZodString },
    "strip",
    ZodTypeAny,
    { dateCreation: string; dateModified: string },
    { dateCreation: string; dateModified: string },
    >,
    >;
    bookmarkLabel: ZodOptional<ZodString>;
    bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
    bookmarkOrder: ZodOptional<ZodString>;
    bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
    id: ZodNumber;
    mainType: ZodString;
    srcId: ZodNumber;
    srcType: ZodString;
    targetId: ZodNumber;
    targetType: ZodNullable<ZodString>;
    type: ZodString;
    uri: ZodString;
    url: ZodNullable<ZodOptional<ZodString>>;
    value: ZodNullable<ZodString>;
    },
    "strip",
    ZodTypeAny,
    {
    _cssClass: string;
    _cssColor: string;
    _src?: jObjectLittle;
    _target?: jObjectLittle;
    _values?: { dateCreation: string; dateModified: string };
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: string;
    bookmarkUrl?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: string;
    uri: string;
    url?: string | null;
    value: string | null;
    },
    {
    _cssClass: string;
    _cssColor: string;
    _src?: jObjectLittle;
    _target?: jObjectLittle;
    _values?: { dateCreation: string; dateModified: string };
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: string;
    bookmarkUrl?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: string;
    uri: string;
    url?: string | null;
    value: string | null;
    },
    >;
    "raw-list": ZodObject<
    {
    _src: ZodOptional<
    | ZodType<jUserLittle, ZodTypeDef, jUserLittle>
    | ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>
    | ZodUnion<[(...), (...)]>,
    >;
    _target: ZodUnion<[ZodOptional<(...) | (...) | (...)>, ZodUndefined]>;
    dateCreation: ZodOptionalType<
    ZodType<string | undefined, ZodTypeDef, string | undefined>,
    >;
    dateModified: ZodOptionalType<
    ZodType<
    string
    | null
    | undefined,
    ZodTypeDef,
    string | null | undefined,
    >,
    >;
    id: ZodType<number, ZodTypeDef, number>;
    mainType: ZodType<string, ZodTypeDef, string>;
    srcId: ZodNumber;
    srcType: ZodString;
    targetId: ZodNumber;
    targetType: ZodNullable<ZodString>;
    uri: ZodType<string, ZodTypeDef, string>;
    value: ZodNullable<ZodString>;
    } & {
    bookmarkLabel: ZodOptional<ZodString>;
    bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
    bookmarkOrder: ZodOptional<ZodNumber>;
    bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
    type: ZodLiteral<"bookmarkLink">;
    url: ZodNullable<ZodOptional<ZodString>>;
    },
    "strip",
    ZodTypeAny,
    {
    _src?: jObjectLittle
    | UserLittle
    | jUserLittle;
    _target?: jObjectLittle | UserLittle | jUserLittle;
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: number;
    bookmarkUrl?: string | null;
    dateCreation?: string;
    dateModified?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: "bookmarkLink";
    uri: string;
    url?: string | null;
    value: string | null;
    },
    {
    _src?: jObjectLittle
    | UserLittle
    | jUserLittle;
    _target?: jObjectLittle | UserLittle | jUserLittle;
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: number;
    bookmarkUrl?: string | null;
    dateCreation?: string;
    dateModified?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: "bookmarkLink";
    uri: string;
    url?: string | null;
    value: string | null;
    },
    >;
    },
    >,
    >

  #### Returns Promise<
  ApiWrapper<
  | {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  }
  | {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  BaseMessagesOne,
  >,
  >

  - Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:35

### addFormattedLink

- addFormattedLink<
  T extends
  requiredKeys<
  baseObjectOutputType<
  {
  list: ZodObject<
  {
  _cssClass: ZodString;
  _cssColor: ZodString;
  _src: | ZodOptional<
  ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>,
  >
  | ZodOptional<
  ZodObject<
  ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
  "strip",
  ZodTypeAny,
  jObjectLittle,
  jObjectLittle,
  >,
  >;
  _target:
  | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
  | ZodOptional<
  ZodObject<
  ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
  "strip",
  ZodTypeAny,
  jObjectLittle,
  jObjectLittle,
  >,
  >;
  _values: ZodOptional<
  ZodObject<
  { dateCreation: ZodString; dateModified: ZodString },
  "strip",
  ZodTypeAny,
  { dateCreation: string; dateModified: string },
  { dateCreation: string; dateModified: string },
  >,
  >;
  bookmarkLabel: ZodOptional<ZodString>;
  bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
  bookmarkOrder: ZodOptional<ZodString>;
  bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
  id: ZodNumber;
  mainType: ZodString;
  srcId: ZodNumber;
  srcType: ZodString;
  targetId: ZodNumber;
  targetType: ZodNullable<ZodString>;
  type: ZodString;
  uri: ZodString;
  url: ZodNullable<ZodOptional<ZodString>>;
  value: ZodNullable<ZodString>;
  },
  "strip",
  ZodTypeAny,
  {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  >;
  "raw-list": ZodObject<
  {
  _src: ZodOptional<
  | ZodType<jUserLittle, ZodTypeDef, jUserLittle>
  | ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>
  | ZodUnion<
  [
  ZodObject<(...), (...), (...), (...), (...)>,
  ZodObject<(...), (...), (...), (...), (...)>,
  ],
  >,
  >;
  _target: ZodUnion<
  [
  ZodOptional<
  | ZodType<(...), (...), (...)>
  | ZodType<(...), (...), (...)>
  | ZodUnion<(...)>,
  >,
  ZodUndefined,
  ],
  >;
  dateCreation: ZodOptionalType<
  ZodType<string | undefined, ZodTypeDef, string | undefined>,
  >;
  dateModified: ZodOptionalType<
  ZodType<
  string
  | null
  | undefined,
  ZodTypeDef,
  string | null | undefined,
  >,
  >;
  id: ZodType<number, ZodTypeDef, number>;
  mainType: ZodType<string, ZodTypeDef, string>;
  srcId: ZodNumber;
  srcType: ZodString;
  targetId: ZodNumber;
  targetType: ZodNullable<ZodString>;
  uri: ZodType<string, ZodTypeDef, string>;
  value: ZodNullable<ZodString>;
  } & {
  bookmarkLabel: ZodOptional<ZodString>;
  bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
  bookmarkOrder: ZodOptional<ZodNumber>;
  bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
  type: ZodLiteral<"bookmarkLink">;
  url: ZodNullable<ZodOptional<ZodString>>;
  },
  "strip",
  ZodTypeAny,
  {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  },
  {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  },
  >;
  },
  >,
  >,
  >(
  targetId: number,
  targetType: string,
  format: T,
  ): Promise<
  ApiWrapper<
  {
  list: {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  };
  "raw-list": {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  };
  }[T],
  BaseMessages,
  >,
  >

  #### Type Parameters

  - T extends requiredKeys<
    baseObjectOutputType<
    {
    list: ZodObject<
    {
    _cssClass: ZodString;
    _cssColor: ZodString;
    _src: | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
    | ZodOptional<
    ZodObject<
    ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
    "strip",
    ZodTypeAny,
    jObjectLittle,
    jObjectLittle,
    >,
    >;
    _target:
    | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
    | ZodOptional<
    ZodObject<
    ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
    "strip",
    ZodTypeAny,
    jObjectLittle,
    jObjectLittle,
    >,
    >;
    _values: ZodOptional<
    ZodObject<
    { dateCreation: ZodString; dateModified: ZodString },
    "strip",
    ZodTypeAny,
    { dateCreation: string; dateModified: string },
    { dateCreation: string; dateModified: string },
    >,
    >;
    bookmarkLabel: ZodOptional<ZodString>;
    bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
    bookmarkOrder: ZodOptional<ZodString>;
    bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
    id: ZodNumber;
    mainType: ZodString;
    srcId: ZodNumber;
    srcType: ZodString;
    targetId: ZodNumber;
    targetType: ZodNullable<ZodString>;
    type: ZodString;
    uri: ZodString;
    url: ZodNullable<ZodOptional<ZodString>>;
    value: ZodNullable<ZodString>;
    },
    "strip",
    ZodTypeAny,
    {
    _cssClass: string;
    _cssColor: string;
    _src?: jObjectLittle;
    _target?: jObjectLittle;
    _values?: { dateCreation: string; dateModified: string };
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: string;
    bookmarkUrl?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: string;
    uri: string;
    url?: string | null;
    value: string | null;
    },
    {
    _cssClass: string;
    _cssColor: string;
    _src?: jObjectLittle;
    _target?: jObjectLittle;
    _values?: { dateCreation: string; dateModified: string };
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: string;
    bookmarkUrl?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: string;
    uri: string;
    url?: string | null;
    value: string | null;
    },
    >;
    "raw-list": ZodObject<
    {
    _src: ZodOptional<
    | ZodType<jUserLittle, ZodTypeDef, jUserLittle>
    | ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>
    | ZodUnion<
    [
    ZodObject<(...), (...), (...), (...), (...)>,
    ZodObject<(...), (...), (...), (...), (...)>,
    ],
    >,
    >;
    _target: ZodUnion<
    [
    ZodOptional<
    | ZodType<(...), (...), (...)>
    | ZodType<(...), (...), (...)>
    | ZodUnion<(...)>,
    >,
    ZodUndefined,
    ],
    >;
    dateCreation: ZodOptionalType<
    ZodType<string | undefined, ZodTypeDef, string | undefined>,
    >;
    dateModified: ZodOptionalType<
    ZodType<
    string
    | null
    | undefined,
    ZodTypeDef,
    string | null | undefined,
    >,
    >;
    id: ZodType<number, ZodTypeDef, number>;
    mainType: ZodType<string, ZodTypeDef, string>;
    srcId: ZodNumber;
    srcType: ZodString;
    targetId: ZodNumber;
    targetType: ZodNullable<ZodString>;
    uri: ZodType<string, ZodTypeDef, string>;
    value: ZodNullable<ZodString>;
    } & {
    bookmarkLabel: ZodOptional<ZodString>;
    bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
    bookmarkOrder: ZodOptional<ZodNumber>;
    bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
    type: ZodLiteral<"bookmarkLink">;
    url: ZodNullable<ZodOptional<ZodString>>;
    },
    "strip",
    ZodTypeAny,
    {
    _src?: jObjectLittle
    | UserLittle
    | jUserLittle;
    _target?: jObjectLittle | UserLittle | jUserLittle;
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: number;
    bookmarkUrl?: string | null;
    dateCreation?: string;
    dateModified?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: "bookmarkLink";
    uri: string;
    url?: string | null;
    value: string | null;
    },
    {
    _src?: jObjectLittle
    | UserLittle
    | jUserLittle;
    _target?: jObjectLittle | UserLittle | jUserLittle;
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: number;
    bookmarkUrl?: string | null;
    dateCreation?: string;
    dateModified?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: "bookmarkLink";
    uri: string;
    url?: string | null;
    value: string | null;
    },
    >;
    },
    >,
    >

  #### Parameters

  - targetId: number
  - targetType: string
  - format: T

  #### Returns Promise<
  ApiWrapper<
  {
  list: {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  };
  "raw-list": {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  };
  }[T],
  BaseMessages,
  >,
  >

  - Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:23

### delete

- delete(bookmarkId: number): Promise<ApiWrapper<null, BaseMessagesOne>>

  #### Parameters

  - bookmarkId: number

  #### Returns Promise<ApiWrapper<null, BaseMessagesOne>>

  - Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:48

### getFormattedList

- getFormattedList<
  T extends
  requiredKeys<
  baseObjectOutputType<
  {
  list: ZodObject<
  {
  _cssClass: ZodString;
  _cssColor: ZodString;
  _src: | ZodOptional<
  ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>,
  >
  | ZodOptional<
  ZodObject<
  ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
  "strip",
  ZodTypeAny,
  jObjectLittle,
  jObjectLittle,
  >,
  >;
  _target:
  | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
  | ZodOptional<
  ZodObject<
  ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
  "strip",
  ZodTypeAny,
  jObjectLittle,
  jObjectLittle,
  >,
  >;
  _values: ZodOptional<
  ZodObject<
  { dateCreation: ZodString; dateModified: ZodString },
  "strip",
  ZodTypeAny,
  { dateCreation: string; dateModified: string },
  { dateCreation: string; dateModified: string },
  >,
  >;
  bookmarkLabel: ZodOptional<ZodString>;
  bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
  bookmarkOrder: ZodOptional<ZodString>;
  bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
  id: ZodNumber;
  mainType: ZodString;
  srcId: ZodNumber;
  srcType: ZodString;
  targetId: ZodNumber;
  targetType: ZodNullable<ZodString>;
  type: ZodString;
  uri: ZodString;
  url: ZodNullable<ZodOptional<ZodString>>;
  value: ZodNullable<ZodString>;
  },
  "strip",
  ZodTypeAny,
  {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  },
  >;
  "raw-list": ZodObject<
  {
  _src: ZodOptional<
  | ZodType<jUserLittle, ZodTypeDef, jUserLittle>
  | ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>
  | ZodUnion<
  [
  ZodObject<(...), (...), (...), (...), (...)>,
  ZodObject<(...), (...), (...), (...), (...)>,
  ],
  >,
  >;
  _target: ZodUnion<
  [
  ZodOptional<
  | ZodType<(...), (...), (...)>
  | ZodType<(...), (...), (...)>
  | ZodUnion<(...)>,
  >,
  ZodUndefined,
  ],
  >;
  dateCreation: ZodOptionalType<
  ZodType<string | undefined, ZodTypeDef, string | undefined>,
  >;
  dateModified: ZodOptionalType<
  ZodType<
  string
  | null
  | undefined,
  ZodTypeDef,
  string | null | undefined,
  >,
  >;
  id: ZodType<number, ZodTypeDef, number>;
  mainType: ZodType<string, ZodTypeDef, string>;
  srcId: ZodNumber;
  srcType: ZodString;
  targetId: ZodNumber;
  targetType: ZodNullable<ZodString>;
  uri: ZodType<string, ZodTypeDef, string>;
  value: ZodNullable<ZodString>;
  } & {
  bookmarkLabel: ZodOptional<ZodString>;
  bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
  bookmarkOrder: ZodOptional<ZodNumber>;
  bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
  type: ZodLiteral<"bookmarkLink">;
  url: ZodNullable<ZodOptional<ZodString>>;
  },
  "strip",
  ZodTypeAny,
  {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  },
  {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  },
  >;
  },
  >,
  >,
  >(
  filterSpecs: ListFilterSpec,
  format: T,
  ): Promise<
  ApiWrapper<
  PagingResults<
  {
  list: {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  };
  "raw-list": {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  };
  }[T],
  >,
  BaseMessages,
  >,
  >

  #### Type Parameters

  - T extends requiredKeys<
    baseObjectOutputType<
    {
    list: ZodObject<
    {
    _cssClass: ZodString;
    _cssColor: ZodString;
    _src: | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
    | ZodOptional<
    ZodObject<
    ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
    "strip",
    ZodTypeAny,
    jObjectLittle,
    jObjectLittle,
    >,
    >;
    _target:
    | ZodOptional<ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>>
    | ZodOptional<
    ZodObject<
    ZodShape<jObjectBase> & { _url: ZodString; title: ZodString },
    "strip",
    ZodTypeAny,
    jObjectLittle,
    jObjectLittle,
    >,
    >;
    _values: ZodOptional<
    ZodObject<
    { dateCreation: ZodString; dateModified: ZodString },
    "strip",
    ZodTypeAny,
    { dateCreation: string; dateModified: string },
    { dateCreation: string; dateModified: string },
    >,
    >;
    bookmarkLabel: ZodOptional<ZodString>;
    bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
    bookmarkOrder: ZodOptional<ZodString>;
    bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
    id: ZodNumber;
    mainType: ZodString;
    srcId: ZodNumber;
    srcType: ZodString;
    targetId: ZodNumber;
    targetType: ZodNullable<ZodString>;
    type: ZodString;
    uri: ZodString;
    url: ZodNullable<ZodOptional<ZodString>>;
    value: ZodNullable<ZodString>;
    },
    "strip",
    ZodTypeAny,
    {
    _cssClass: string;
    _cssColor: string;
    _src?: jObjectLittle;
    _target?: jObjectLittle;
    _values?: { dateCreation: string; dateModified: string };
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: string;
    bookmarkUrl?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: string;
    uri: string;
    url?: string | null;
    value: string | null;
    },
    {
    _cssClass: string;
    _cssColor: string;
    _src?: jObjectLittle;
    _target?: jObjectLittle;
    _values?: { dateCreation: string; dateModified: string };
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: string;
    bookmarkUrl?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: string;
    uri: string;
    url?: string | null;
    value: string | null;
    },
    >;
    "raw-list": ZodObject<
    {
    _src: ZodOptional<
    | ZodType<jUserLittle, ZodTypeDef, jUserLittle>
    | ZodType<jObjectLittle, ZodTypeDef, jObjectLittle>
    | ZodUnion<
    [
    ZodObject<(...), (...), (...), (...), (...)>,
    ZodObject<(...), (...), (...), (...), (...)>,
    ],
    >,
    >;
    _target: ZodUnion<
    [
    ZodOptional<
    | ZodType<(...), (...), (...)>
    | ZodType<(...), (...), (...)>
    | ZodUnion<(...)>,
    >,
    ZodUndefined,
    ],
    >;
    dateCreation: ZodOptionalType<
    ZodType<string | undefined, ZodTypeDef, string | undefined>,
    >;
    dateModified: ZodOptionalType<
    ZodType<
    string
    | null
    | undefined,
    ZodTypeDef,
    string | null | undefined,
    >,
    >;
    id: ZodType<number, ZodTypeDef, number>;
    mainType: ZodType<string, ZodTypeDef, string>;
    srcId: ZodNumber;
    srcType: ZodString;
    targetId: ZodNumber;
    targetType: ZodNullable<ZodString>;
    uri: ZodType<string, ZodTypeDef, string>;
    value: ZodNullable<ZodString>;
    } & {
    bookmarkLabel: ZodOptional<ZodString>;
    bookmarkMeta: ZodNullable<ZodOptional<ZodString>>;
    bookmarkOrder: ZodOptional<ZodNumber>;
    bookmarkUrl: ZodNullable<ZodOptional<ZodString>>;
    type: ZodLiteral<"bookmarkLink">;
    url: ZodNullable<ZodOptional<ZodString>>;
    },
    "strip",
    ZodTypeAny,
    {
    _src?: jObjectLittle
    | UserLittle
    | jUserLittle;
    _target?: jObjectLittle | UserLittle | jUserLittle;
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: number;
    bookmarkUrl?: string | null;
    dateCreation?: string;
    dateModified?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: "bookmarkLink";
    uri: string;
    url?: string | null;
    value: string | null;
    },
    {
    _src?: jObjectLittle
    | UserLittle
    | jUserLittle;
    _target?: jObjectLittle | UserLittle | jUserLittle;
    bookmarkLabel?: string;
    bookmarkMeta?: string | null;
    bookmarkOrder?: number;
    bookmarkUrl?: string | null;
    dateCreation?: string;
    dateModified?: string | null;
    id: number;
    mainType: string;
    srcId: number;
    srcType: string;
    targetId: number;
    targetType: string | null;
    type: "bookmarkLink";
    uri: string;
    url?: string | null;
    value: string | null;
    },
    >;
    },
    >,
    >

  #### Parameters

  - filterSpecs: ListFilterSpec
  - format: T

  #### Returns Promise<
  ApiWrapper<
  PagingResults<
  {
  list: {
  _cssClass: string;
  _cssColor: string;
  _src?: jObjectLittle;
  _target?: jObjectLittle;
  _values?: { dateCreation: string; dateModified: string };
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: string;
  bookmarkUrl?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: string;
  uri: string;
  url?: string | null;
  value: string | null;
  };
  "raw-list": {
  _src?: jObjectLittle
  | UserLittle
  | jUserLittle;
  _target?: jObjectLittle | UserLittle | jUserLittle;
  bookmarkLabel?: string;
  bookmarkMeta?: string | null;
  bookmarkOrder?: number;
  bookmarkUrl?: string | null;
  dateCreation?: string;
  dateModified?: string | null;
  id: number;
  mainType: string;
  srcId: number;
  srcType: string;
  targetId: number;
  targetType: string | null;
  type: "bookmarkLink";
  uri: string;
  url?: string | null;
  value: string | null;
  };
  }[T],
  >,
  BaseMessages,
  >,
  >

  - Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:14

### move

- move(
  bookmarkID: number,
  bookmarkReference: number,
  position: "before" | "after",
  ): Promise<ApiWrapper<null, BaseMessagesOne>>

  #### Parameters

  - bookmarkID: number
  - bookmarkReference: number
  - position: "before" | "after"

  #### Returns Promise<ApiWrapper<null, BaseMessagesOne>>

  - Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:70

### rename

- rename(
  bookmarkID: number,
  bookmarkLabel: string,
  bookmarkUrl?: string,
  ): Promise<ApiWrapper<null, BaseMessagesOne>>

  #### Parameters

  - bookmarkID: number
  - bookmarkLabel: string
  - `Optional` bookmarkUrl: string

  #### Returns Promise<ApiWrapper<null, BaseMessagesOne>>

  - Defined in jamespot-user-api/src/apis/bookmark/bookmark.ts:56