jamespot-user-api
    Preparing search index...

    Class JBookmarkApi

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    network: Network

    Methods

    • Parameters

      • bookmark: Pick<
            BookmarkTypes[keyof BookmarkTypes],
            "bookmarkLabel"
            | "bookmarkMeta"
            | "bookmarkUrl",
        >
      • Optionalformat: 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,
          >,
      >

    • 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,
          >,
      >

    • 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

      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,
          >,
      >