BoothMate API Documentation - v0.4.0
    Preparing search index...

    Class WishlistService

    Index

    Constructors

    constructor

    Methods

    getNames getItems getDefaultItems getUncategorizedItems hasItem addItem removeItem

    Constructors

    Methods

    • ウィッシュリストの一覧を取得します。

      自分が作成したウィッシュリストの名前とIDのリストを取得します。

      Returns Promise<WishlistSummary[]>

      ウィッシュリストの名前とIDのリスト

      セッショントークン sessionToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // ウィッシュリストの名前を出力
      const wishlists = await client.wishlist.getNames();
      for (const wishlist of wishlists) {
        console.log(wishlist.name);
      }

    • ウィッシュリストの内容を取得します。

      指定されたウィッシュリストの商品一覧を取得します。 自分が作成したウィッシュリストと公開されているウィッシュリストのみ取得可能です。

      Parameters

      • wishlistId: string

        ウィッシュリストのID

      • page: number = 1

        取得するページ番号(デフォルト: 1)

      Returns Promise<undefined | Wishlist>

      ウィッシュリストの内容(存在しないまたは非公開の場合はundefined)

      自分が作成した非公開のスキリストの取得に限り、セッショントークン sessionToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // ウィッシュリストの1番目の商品名を出力
      const wishlist = await client.wishlist.getItems('my-wishlist');
      if (wishlist) {
       console.log(wishlist.items[0].name);
      }

    • デフォルトのウィッシュリストを取得します。

      ユーザーのデフォルト（すべて）のウィッシュリストの内容を取得します。

      https://accounts.booth.pm/wish_lists

      Parameters

      • page: number = 1

        取得するページ番号(デフォルト: 1)

      Returns Promise<WishlistBasic>

      デフォルトのウィッシュリストの内容

      セッショントークン sessionToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // デフォルトのウィッシュリストの1番目の商品名を出力
      const wishlist = await client.wishlist.getDefaultItems();
      console.log(wishlist.items[0].name);

    • 未分類のウィッシュリストを取得します。

      「未分類」カテゴリのウィッシュリストの内容を取得します。

      Parameters

      • page: number = 1

        取得するページ番号(デフォルト: 1)

      Returns Promise<WishlistBasic>

      未分類のウィッシュリストの内容

      セッショントークン sessionToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // 未分類のウィッシュリストの1番目の商品名を出力
      const wishlist = await client.wishlist.getUncategorizedItems();
      console.log(wishlist.items[0].name);

    • 商品のウィッシュリスト登録状況を確認します。

      指定された商品がウィッシュリストに含まれているかを確認します。

      Parameters

      • itemId: number

        確認する商品のID

      • OptionalwishlistId: string

        確認するウィッシュリストのID(省略時はデフォルトのウィッシュリスト)

      Returns Promise<boolean>

      商品がウィッシュリストに含まれている場合true、含まれていない場合false

      セッショントークン sessionToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // 商品ID 12345 がデフォルトのウィッシュリストに含まれているか確認
      const isInDefault = await client.wishlist.hasItem(12345);
      if (isInDefault) {
        console.log('商品はデフォルトのウィッシュリストに含まれています');
      }

      // 商品ID 12345 がウィッシュリストに含まれているか確認
      const isInWishlist = await client.wishlist.hasItem(12345, 'pQ9TlbPV');
      if (isInWishlist) {
        console.log('商品は指定されたウィッシュリストに含まれています');
      }

    • 商品をウィッシュリストに追加します。

      指定された商品をウィッシュリストに追加します。 複数のウィッシュリストに同時に追加することも可能です。

      Parameters

      • itemId: number

        追加する商品のID

      • OptionalwishlistIds: string | string[]

        追加先のウィッシュリストのID - 省略時: デフォルトのウィッシュリストに追加 - 文字列: 指定されたウィッシュリストに追加 - 配列: 複数のウィッシュリストに追加

      Returns Promise<void>

      セッショントークン sessionToken とCSRFトークン csrfToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // 商品ID 12345 をデフォルトのウィッシュリストに追加
      await client.wishlist.addItem(12345);

      // 商品ID 12345 をウィッシュリストに追加
      await client.wishlist.addItem(12345, 'pQ9TlbPV');

      // 商品ID 12345 を複数のウィッシュリストに追加
      await client.wishlist.addItem(12345, ['pQ9TlbPV', '8OVTLANn']);

    • 商品をウィッシュリストから削除します。

      指定された商品をウィッシュリストから削除します。 複数のウィッシュリストから同時に削除することも可能です。

      Parameters

      • itemId: number

        削除する商品のID

      • OptionalwishlistIds: string | string[]

        削除元のウィッシュリストのID - 省略時: デフォルトのウィッシュリストから削除 - 文字列: 指定されたウィッシュリストから削除 - 配列: 複数のウィッシュリストから削除

      Returns Promise<void>

      セッショントークン sessionToken とCSRFトークン csrfToken は必須です。

      指定せずに実行すると AuthError が発生します。

      // 商品ID 12345 をデフォルトのウィッシュリストから削除
      await client.wishlist.removeItem(12345);

      // 商品ID 12345 をウィッシュリストから削除
      await client.wishlist.removeItem(12345, 'pQ9TlbPV');

      // 商品ID 12345 を複数のウィッシュリストから削除
      await client.wishlist.removeItem(12345, ['pQ9TlbPV', '8OVTLANn']);

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods