sidechat.js 2.6.6 → 2.7.0

package/dist/index.cjs

@@ -2,219 +2,311 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-/**
- * A user-created post or comment, depending on the "type" prop
- * @typedef {Object} SidechatPostOrComment
- * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
- * @prop {String} id - alphanumeric ID of post or comment
- * @prop {Boolean} authored_by_user - whether or not the post or comment was created by the current user
- * @prop {String} alias - post creator's name in-app
- * @prop {String} group_id - alphanumeric ID of group
- * @prop {SidechatGroup} group - group in which post or comment was created
- * @prop {String} text - text content of post or comment
- * @prop {String} created_at - date string of post or comment creation time
- * @prop {Number} vote_total - sum of upvotes and downvotes
- * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
- * @prop {SidechatSimpleAsset[]} assets - array of simple assets attached to post or comment
- * @prop {Array} attachments - undocumented
- * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
- * @prop {String[]} tags - undocumented
- * @prop {SidechatIdentity} identity - creator's identity information
- * @prop {Boolean} pinned - undocumented
- * @prop {Boolean} is_saved - whether or not the current user has saved the post
- * @prop {"following"|"not_following"} follow_status - whether or not the current user should recieve activity notifications for the post
- * @prop {"group"} [destination] - undocumented
- * @prop {Number} [comment_count] - number of comments on post (only if type=post)
- * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
- * @prop {SidechatPoll} [poll] - poll attached to post (only if the post has a poll)
- * @prop {String} [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
- * @prop {String} [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
- * @prop {String} [context] - text content of comment being replied to, falls back to text (only if type=comment)
- */
-
-/**
- * A group object, containing metadata about a group as well as its join conditions and states.  Some properties vary based on the endpoint the object came from.
- * @typedef {Object} SidechatGroup
- * @prop {String} id - alphanumeric ID of group
- * @prop {String} name - human-readable name of group
- * @prop {String} analytics_name - name to file group under
- * @prop {"non_member"|"member"} membership_type - whether or not current user is a member of group
- * @prop {String} color -  group's theme color as hex code (e.g., #FFFFFF)
- * @prop {"open"|"closed"|"email_domain"} group_join_type - basis on which group accepts new members
- * @prop {"private"|"public_to_all"|"public_to_schools"} group_visibility - group's visibility setting
- * @prop {"show"|"hide"} asset_library_visibility - whether or not group's asset library is visible
- * @prop {Array} [roles] - undocumented
- * @prop {String} [description] - description of group
- * @prop {SidechatPrivateAssetURL} [icon_url] - image URL for group icon
- * @prop {Number} [member_count] - number of users in group
- * @prop {Boolean} [should_show_leaderboard] - undocumented
- */
-
-/**
- * An asset object, containing information about an image within a post or comment
- * @typedef {Object} SidechatSimpleAsset
- * @prop {String} id - alphanumeric ID of asset
- * @prop {"image"} type - undocumented
- * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
- * @prop {Number} width - width of asset
- * @prop {Number} height - height of asset
- * @prop {SidechatPrivateAssetURL} [url] - URL string of asset's location
- */
-
-/**
- * An asset object, containing information about an image from the asset library
- * @typedef {Object} SidechatLibraryAsset
- * @prop {String} id - alphanumeric ID of asset
- * @prop {String} created_at - date string of asset creation time
- * @prop {SidechatAssetMetadata} metadata - metadata associated with asset
- * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
- */
-
-/**
- * An asset object, containing information about an image from the asset library
- * @typedef {Object} SidechatAssetMetadata
- * @prop {Number} width - width of asset
- * @prop {Number} height - height of asset
- * @prop {"image"} type - undocumented
- * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
- */
-
-/**
- * A user's anonymous identity information
- * @typedef {Object} SidechatIdentity
- * @prop {String} name - representation of user's name (varies across app)
- * @prop {Boolean} posted_with_username - undocumented
- */
-
-/**
- * A conversation icon associated with a user
- * @typedef {Object} SidechatIcon
- * @prop {String} emoji - unicode emoji character
- * @prop {String} color - primary hex color code
- * @prop {String} secondary_color - secondary hex color code
- */
-
-/**
- * The current user's information
- * @typedef {Object} SidechatCurrentUser
- * @prop {String} id - alphanumeric ID of current user
- * @prop {String} hashedVerifiedEmail - verified email of current user in an unreadable hashed form
- * @prop {Boolean} isGlobalModerator - whether or not user is a moderator
- * @prop {Boolean} isGlobalAdmin - whether or not user is an admin
- * @prop {SidechatMembership[]} memberships
- * @prop {Array} roles - undocumented
- * @prop {String} emailDomain - domain of verified email address on account
- * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
- */
-
-/**
- * A user's public profile
- * @typedef {Object} SidechatProfile
- * @prop {String} id - alphanumeric ID of user
- * @prop {String} name - public-facing username
- * @prop {SidechatIcon} conversation_icon - icon associated with user
- * @prop {Boolean} description - the user bio
- * @prop {String} index_name - undocumented
- * @prop {String} analytics_name - undocumented
- * @prop {String} color - undocumented
- * @prop {String} share_color_start - undocumented
- * @prop {String} share_color_end - undocumented
- * @prop {"account"} group_join_type - undocumented
- * @prop {"public_to_all"} group_visibility - the profile visibility status
- */
-
-/**
- * Representation of a group membership
- * @typedef {Object} SidechatMembership
- * @prop {String} groupId - alphanumeric ID of group
- * @prop {String} type - role of current user in group
- */
-
-/**
- * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
- * @typedef {String} SidechatPrivateAssetURL
- */
-
-/**
- * A cursor for paginating through post lists
- * @typedef {String} SidechatCursorString
- */
-
-/**
- * A vote on a comment or post
- * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
- */
-
-/**
- * A user's bearer authentication token needed for most requests
- * @typedef {String} SidechatAuthToken
- */
-
-/**
- * A list of posts and the associated cursor
- * @typedef {Object} SidechatPostsAndCursor
- * @prop {SidechatPostOrComment[]} posts
- * @prop {SidechatCursorString} cursor
- */
-
-
-/**
- * A direct message thread
- * @typedef {Object} SidechatDirectThread
- * @prop {String} id - alphanumeric ID of thread
- * @prop {String} group_id - alphanumeric ID of group in which the thread exists
- * @prop {String} updated_at - date string of when the last message in the chat was sent
- * @prop {String} post_id - post or comment from which the thread was originally sent
- * @prop {String} post_context - the context of the DM thread (only "feed" is known at the moment)
- * @prop {"accepted"} accept_status - whether or not the other user has accepted this DM
- * @prop {"post"|"comment"} type - the type of the content from which the DM was originally sent
- * @prop {SidechatDirectMessage[]} messages - array of direct message objects
- */
-
-/**
- * A single direct message
- * @typedef {Object} SidechatDirectMessage
- * @prop {String} created_at - time at which the message was sent
- * @prop {String} client_id - alphanumeric ID of the device the message was sent on
- * @prop {String} obfuscatedUserId - obfuscated version of the sender's alphanumeric ID
- * @prop {String} text - body text of the message
- * @prop {String} id - alphanumeric ID of the message
- * @prop {String} chat_id - alphanumeric ID of the thread in which the message resides
- * @prop {Boolean} authored_by_user - whether or not the current user sent the message
- * @prop {"message"} type - undocumented
- */
-
-/**
- * Represents a poll with choices
- * @typedef {Object} SidechatPoll
- * @prop {String} id - alphanumeric ID of poll
- * @prop {String} post_id - alphanumeric ID of post to which poll is attached
- * @prop {SidechatPollChoice[]} choices - array of poll choices
- * @prop {Boolean} allows_view_results - whether or not poll results are publicly visible
- * @prop {Number} view_results_count - number of users who have viewed poll results
- * @prop {Boolean} participated - whether or not current user has voted in poll
-*/
-
-/**
- * Represents a poll choice
- * @typedef {Object} SidechatPollChoice
- * @prop {Number} count - number of votes for choice
- * @prop {String} text - user-visible text of choice
- * @prop {Boolean} selected - whether or not current user has voted for choice
-*/
-
+/**
+ * A user-created post or comment, depending on the "type" prop
+ * @typedef {Object} SidechatPostOrComment
+ * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
+ * @prop {String} id - alphanumeric ID of post or comment
+ * @prop {Boolean} authored_by_user - whether or not the post or comment was created by the current user
+ * @prop {String} alias - post creator's name in-app
+ * @prop {String} group_id - alphanumeric ID of group
+ * @prop {SidechatGroup} group - group in which post or comment was created
+ * @prop {String} text - text content of post or comment
+ * @prop {String} created_at - date string of post or comment creation time
+ * @prop {Number} vote_total - sum of upvotes and downvotes
+ * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
+ * @prop {SidechatSimpleAsset[]} assets - array of simple assets attached to post or comment
+ * @prop {SidechatAttachment[]} attachments - link attachments on the post
+ * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
+ * @prop {String[]} tags - undocumented
+ * @prop {SidechatIdentity} identity - creator's identity information
+ * @prop {Boolean} pinned - undocumented
+ * @prop {Boolean} is_saved - whether or not the current user has saved the post
+ * @prop {"following"|"following_commented"|"not_following"} follow_status - whether or not the current user should recieve activity notifications for the post
+ * @prop {"group"|"account"} [destination] - whether the post was made in a group or on the author's profile
+ * @prop {Boolean} [is_deleted] - whether or not the post or comment has been deleted
+ * @prop {{post: SidechatPostOrComment, is_unavailable: Boolean}} [quote_post] - the post being quoted, if this is a repost
+ * @prop {Number} [comment_count] - number of comments on post (only if type=post)
+ * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
+ * @prop {SidechatPoll} [poll] - poll attached to post (only if the post has a poll)
+ * @prop {String} [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
+ * @prop {String} [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
+ * @prop {String} [context] - text content of comment being replied to, falls back to text (only if type=comment)
+ */
+
+/**
+ * A group object, containing metadata about a group as well as its join conditions and states.  Some properties vary based on the endpoint the object came from.
+ * @typedef {Object} SidechatGroup
+ * @prop {String} id - alphanumeric ID of group
+ * @prop {String} name - human-readable name of group
+ * @prop {String} analytics_name - name to file group under
+ * @prop {"non_member"|"member"} membership_type - whether or not current user is a member of group
+ * @prop {String} color -  group's theme color as hex code (e.g., #FFFFFF)
+ * @prop {"open"|"closed"|"email_domain"} group_join_type - basis on which group accepts new members
+ * @prop {"private"|"public_to_all"|"public_to_schools"} group_visibility - group's visibility setting
+ * @prop {"show"|"hide"} asset_library_visibility - whether or not group's asset library is visible
+ * @prop {Array} [roles] - undocumented
+ * @prop {String} [description] - description of group
+ * @prop {SidechatPrivateAssetURL} [icon_url] - image URL for group icon
+ * @prop {Number} [member_count] - number of users in group
+ * @prop {Boolean} [should_show_leaderboard] - undocumented
+ */
+
+/**
+ * An asset object, containing information about an image within a post or comment
+ * @typedef {Object} SidechatSimpleAsset
+ * @prop {String} id - alphanumeric ID of asset
+ * @prop {"image"|"video"} type - whether the asset is an image or a video
+ * @prop {"jpeg"|"png"|"gif"|"webp"|"mp4"|"mov"} content_type - file type of asset
+ * @prop {Number} width - width of asset
+ * @prop {Number} height - height of asset
+ * @prop {SidechatPrivateAssetURL} [url] - URL string of asset's location (an HLS .m3u8 stream for processed videos)
+ * @prop {SidechatSimpleAsset} [thumbnail_asset] - preview image (only if type=video)
+ * @prop {"not_started"|"ingest"|"complete"|"error"} [vod_status] - processing status (only if type=video)
+ */
+
+/**
+ * An asset object, containing information about an image from the asset library
+ * @typedef {Object} SidechatLibraryAsset
+ * @prop {String} id - alphanumeric ID of asset
+ * @prop {String} created_at - date string of asset creation time
+ * @prop {SidechatAssetMetadata} metadata - metadata associated with asset
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
+ */
+
+/**
+ * An asset object, containing information about an image from the asset library
+ * @typedef {Object} SidechatAssetMetadata
+ * @prop {Number} width - width of asset
+ * @prop {Number} height - height of asset
+ * @prop {"image"} type - undocumented
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
+ */
+
+/**
+ * A user's anonymous identity information
+ * @typedef {Object} SidechatIdentity
+ * @prop {String} name - representation of user's name (varies across app)
+ * @prop {Boolean} posted_with_username - undocumented
+ */
+
+/**
+ * A conversation icon associated with a user
+ * @typedef {Object} SidechatIcon
+ * @prop {String} emoji - unicode emoji character
+ * @prop {String} color - primary hex color code
+ * @prop {String} secondary_color - secondary hex color code
+ */
+
+/**
+ * The current user's information
+ * @typedef {Object} SidechatCurrentUser
+ * @prop {String} id - alphanumeric ID of current user
+ * @prop {String} hashedVerifiedEmail - verified email of current user in an unreadable hashed form
+ * @prop {Boolean} isGlobalModerator - whether or not user is a moderator
+ * @prop {Boolean} isGlobalAdmin - whether or not user is an admin
+ * @prop {SidechatMembership[]} memberships
+ * @prop {Array} roles - undocumented
+ * @prop {String} emailDomain - domain of verified email address on account
+ * @prop {String} wildcardEmailDomain - domain of verified email address on account, preceeded by *. to support subdomains
+ */
+
+/**
+ * A user's public profile
+ * @typedef {Object} SidechatProfile
+ * @prop {String} id - alphanumeric ID of user
+ * @prop {String} name - public-facing username
+ * @prop {SidechatIcon} conversation_icon - icon associated with user
+ * @prop {Boolean} description - the user bio
+ * @prop {String} index_name - undocumented
+ * @prop {String} analytics_name - undocumented
+ * @prop {String} color - undocumented
+ * @prop {String} share_color_start - undocumented
+ * @prop {String} share_color_end - undocumented
+ * @prop {"account"} group_join_type - undocumented
+ * @prop {"public_to_all"} group_visibility - the profile visibility status
+ */
+
+/**
+ * Representation of a group membership
+ * @typedef {Object} SidechatMembership
+ * @prop {String} groupId - alphanumeric ID of group
+ * @prop {String} type - role of current user in group
+ */
+
+/**
+ * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
+ * @typedef {String} SidechatPrivateAssetURL
+ */
+
+/**
+ * A cursor for paginating through post lists
+ * @typedef {String} SidechatCursorString
+ */
+
+/**
+ * A vote on a comment or post
+ * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
+ */
+
+/**
+ * A user's bearer authentication token needed for most requests
+ * @typedef {String} SidechatAuthToken
+ */
+
+/**
+ * A list of posts and the associated cursor
+ * @typedef {Object} SidechatPostsAndCursor
+ * @prop {SidechatPostOrComment[]} posts
+ * @prop {SidechatCursorString} cursor
+ */
+
+/**
+ * A direct message thread
+ * @typedef {Object} SidechatDirectThread
+ * @prop {String} id - alphanumeric ID of thread
+ * @prop {String} group_id - alphanumeric ID of group in which the thread exists
+ * @prop {String} updated_at - date string of when the last message in the chat was sent
+ * @prop {String} post_id - post or comment from which the thread was originally sent
+ * @prop {String} post_context - the context of the DM thread (only "feed" is known at the moment)
+ * @prop {"accepted"} accept_status - whether or not the other user has accepted this DM
+ * @prop {"post"|"comment"} type - the type of the content from which the DM was originally sent
+ * @prop {SidechatDirectMessage[]} messages - array of direct message objects
+ */
+
+/**
+ * A single direct message
+ * @typedef {Object} SidechatDirectMessage
+ * @prop {String} created_at - time at which the message was sent
+ * @prop {String} client_id - alphanumeric ID of the device the message was sent on
+ * @prop {String} obfuscatedUserId - obfuscated version of the sender's alphanumeric ID
+ * @prop {String} text - body text of the message
+ * @prop {String} id - alphanumeric ID of the message
+ * @prop {String} chat_id - alphanumeric ID of the thread in which the message resides
+ * @prop {Boolean} authored_by_user - whether or not the current user sent the message
+ * @prop {"message"} type - undocumented
+ */
+
+/**
+ * Represents a poll with choices
+ * @typedef {Object} SidechatPoll
+ * @prop {String} id - alphanumeric ID of poll
+ * @prop {String} post_id - alphanumeric ID of post to which poll is attached
+ * @prop {SidechatPollChoice[]} choices - array of poll choices
+ * @prop {Boolean} allows_view_results - whether or not poll results are publicly visible
+ * @prop {Number} view_results_count - number of users who have viewed poll results
+ * @prop {Boolean} participated - whether or not current user has voted in poll
+ */
+
+/**
+ * Represents a poll choice
+ * @typedef {Object} SidechatPollChoice
+ * @prop {Number} count - number of votes for choice
+ * @prop {String} text - user-visible text of choice
+ * @prop {Boolean} selected - whether or not current user has voted for choice
+ */
+
+/**
+ * A link attachment on a post
+ * @typedef {Object} SidechatAttachment
+ * @prop {String} id - alphanumeric ID of attachment
+ * @prop {"link"|"youtube"} type - whether the link is a regular link or a YouTube video
+ * @prop {String} link_url - URL the attachment points to
+ * @prop {String} [display_url] - shortened URL for display
+ * @prop {String} [title] - title of the linked page
+ * @prop {{id: String, url: String, width: Number, height: Number, content_type: "png"|"gif"}} [asset] - preview image of the linked page
+ */
+
+/**
+ * A page of the home feed
+ * @typedef {Object} SidechatFeed
+ * @prop {SidechatFeedItem[]} feed_items - items in the feed
+ * @prop {SidechatCursorString} cursor
+ */
+
+/**
+ * A single item in the home feed
+ * @typedef {Object} SidechatFeedItem
+ * @prop {String} item_type - type of item (posts have a type of "post")
+ * @prop {SidechatPostOrComment} [post] - the post, if this item is a post
+ */
+
+/**
+ * A page of the user's activity
+ * @typedef {Object} SidechatActivityList
+ * @prop {SidechatActivityItem[]} items - activity items
+ * @prop {SidechatCursorString} cursor
+ */
+
+/**
+ * A single activity item (in-app notification)
+ * @typedef {Object} SidechatActivityItem
+ * @prop {String} id - alphanumeric ID of activity item
+ * @prop {String} type - kind of activity (e.g. "comment", "comment_reply", "votes", "new_follower", "quote", "trending_post")
+ * @prop {String} text - user-facing description of the activity
+ * @prop {String} timestamp - date string of when the activity happened
+ * @prop {Boolean} is_seen - whether or not the user has seen the activity
+ * @prop {String} [post_id] - alphanumeric ID of related post
+ * @prop {String} [comment_id] - alphanumeric ID of related comment
+ * @prop {String} [group_id] - alphanumeric ID of related group
+ * @prop {Number} [yakarma] - yakarma gained
+ * @prop {String} [username] - username of the other user involved, if any
+ */
+
+/**
+ * A group leaderboard and the current user's place in it
+ * @typedef {Object} SidechatLeaderboard
+ * @prop {Array<{value: Number}>} leaderboard - all-time leaderboard entries
+ * @prop {Array<{value: Number}>} season_leaderboard - leaderboard entries for the current season
+ * @prop {{year: Number, season: String, remaining_days: Number}} season - the current season
+ * @prop {SidechatKarma} karma - current user's all-time karma in the group
+ * @prop {SidechatKarma} season_karma - current user's karma this season
+ */
+
+/**
+ * A user's karma within a group
+ * @typedef {Object} SidechatKarma
+ * @prop {String} group_id - alphanumeric ID of group
+ * @prop {Number} post - karma from posts
+ * @prop {Number} comment - karma from comments
+ * @prop {Number} yakarma - total karma
+ */
+
+/**
+ * Which push notifications a user receives
+ * @typedef {Object} SidechatNotificationPreferences
+ * @prop {Boolean} [chats] - direct messages
+ * @prop {Boolean} [followed_posts_activity] - new comments on followed posts
+ * @prop {Boolean} [new_followers] - new followers
+ * @prop {Boolean} [post_activity] - comments and votes on the user's own posts
+ * @prop {Boolean} [trending] - trending posts
+ * @prop {Boolean} [community_activity] - undocumented
+ * @prop {Boolean} [leaderboards] - leaderboard updates
+ * @prop {Boolean} [rewards] - undocumented
+ * @prop {Boolean} [feature_updates] - announcements about new features
+ * @prop {Boolean} [yak_ball_updates] - undocumented
+ * @prop {Boolean} [game_reminders] - undocumented
+ * @prop {Boolean} [daily_game_reminders] - undocumented
+ * @prop {Boolean} [game_invitations] - undocumented
+ * @prop {Boolean} [game_match_updates] - undocumented
+ */
+/**
+ * A reason for reporting a post, comment, or direct message thread
+ * @typedef {"username"|"spam"|"offTopic"|"pii"|"selfHarmDangerousActs"|"illegalActivities"|"offensiveHateSpeech"|"harassmentBullying"|"minorSafety"|"sexualContent"|"violentGraphicContent"|"misinformation"|"other"} SidechatReportReason
+ */
+
 var SidechatTypes = {};
 
-/**
- * Throwable error caused by the Sidechat API
- * @class
- * @extends Error
- */
-class SidechatAPIError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "SidechatAPIError";
-  }
+/**
+ * Throwable error caused by the Sidechat API
+ * @class
+ * @extends Error
+ */
+class SidechatAPIError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "SidechatAPIError";
+  }
 }
 
 /** @import * as types from "../types/SidechatTypes.js"  */
@@ -284,6 +376,16 @@ class SidechatAPIClient {
     this.apiRoot = url;
   };
 
+  /**
+   * Set an identifier for this device, which will be sent with every request in the `X-Device-ID` header.  Should be stable across sessions on the same device.
+   * @method
+   * @param {String} deviceIdentifier - stable identifier for this device
+   * @since 2.7.0
+   */
+  setDeviceIdentifier = (deviceIdentifier) => {
+    this.defaultHeaders["X-Device-ID"] = deviceIdentifier;
+  };
+
   /**
    * Run an arbitrary API request using the current client's authentication
    * @method
@@ -314,19 +416,32 @@ class SidechatAPIClient {
   };
 
   /**
-   * Initiate the login process with a phone number.  Should be followed up with verifySMSCode().
+   * Initiate the login process with a phone number.  Should be followed up with verifySMSCode().  If the response has an `error_code` of `"captcha_required"`, the server wants a captcha solved before it will send a code, and the request should be repeated with a captcha response.  I haven't been able to recreate this yet, so I honestly don't know what captcha provider they want.
    * @method
    * @since 1.0.0
    * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
+   * @param {Boolean} [useFallback] - send the code through the backup SMS route, which the official app offers when a code doesn't arrive
+   * @param {String} [captchaMethod] - type of captcha being answered
+   * @param {String} [captchaResponse] - solved captcha token
    */
-  loginViaSMS = async (phoneNumber) => {
+  loginViaSMS = async (
+    phoneNumber,
+    useFallback = false,
+    captchaMethod = undefined,
+    captchaResponse = undefined,
+  ) => {
     try {
-      const res = await fetch(`${this.apiRoot}/v1/login_register`, {
+      const endpoint = useFallback
+        ? "/v1/login_register_sms_fallback"
+        : "/v1/login_register";
+      const res = await fetch(`${this.apiRoot}${endpoint}`, {
         method: "POST",
         headers: this.defaultHeaders,
         body: JSON.stringify({
           phone_number: `+1${phoneNumber}`,
           version: 3,
+          captcha_method: captchaMethod,
+          captcha_response: captchaResponse,
         }),
       });
       const json = await res.json();
@@ -371,8 +486,15 @@ class SidechatAPIClient {
    * @since 1.0.0
    * @param {Number} age - user's age in years
    * @param {String} registrationID  - the registration ID generated by verifySMSCode()
+   * @param {String} [timeZone] - time zone of the user (e.g. "America/Chicago").  Falls back to the system time zone.
+   * @param {String} [inviteLinkURL] - group invite link that the user signed up through
    */
-  setAge = async (age, registrationID) => {
+  setAge = async (
+    age,
+    registrationID,
+    timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone,
+    inviteLinkURL = undefined,
+  ) => {
     if (age < 13) {
       throw new SidechatAPIError("You're too young to use Offsides.");
     }
@@ -383,6 +505,9 @@ class SidechatAPIClient {
         body: JSON.stringify({
           age: Number(age),
           registration_id: registrationID,
+          time_zone: timeZone,
+          invite_link_url: inviteLinkURL,
+          device_id: this.defaultHeaders["X-Device-ID"],
         }),
       });
       const json = await res.json();
@@ -465,8 +590,9 @@ class SidechatAPIClient {
    * @method
    * @since 1.0.0
    * @param {String} deviceId - the device ID to set
+   * @param {"com.flowerave.sidechat"|"com.flowerave.yikyak"} [bundleID] - bundle ID of the app the push token belongs to
    */
-  setDeviceID = async (deviceID) => {
+  setDeviceID = async (deviceID, bundleID = "com.flowerave.sidechat") => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
     }
@@ -479,7 +605,7 @@ class SidechatAPIClient {
         },
         body: JSON.stringify({
           build_type: "release",
-          bundle_id: "com.flowerave.sidechat",
+          bundle_id: bundleID,
           device_token: deviceID,
         }),
       });
@@ -539,9 +665,10 @@ class SidechatAPIClient {
    * @param {String} groupID - group ID
    * @param {"hot"|"recent"|"top"} category - category to filter posts
    * @param {types.SidechatCursorString} [cursor] - cursor string
+   * @param {"day"|"week"|"month"|"year"|"all_time"} [period] - time period to pull top posts from (only if category is "top")
    * @returns {Promise<types.SidechatPostsAndCursor>} List of posts and cursor
    */
-  getGroupPosts = async (groupID, category = "hot", cursor) => {
+  getGroupPosts = async (groupID, category = "hot", cursor, period) => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
     }
@@ -549,6 +676,8 @@ class SidechatAPIClient {
       const res = await fetch(
         `${this.apiRoot}/v1/posts?${
           cursor ? "cursor=" + encodeURIComponent(cursor) + "&" : ""
+        }${
+          period ? "period=" + period + "&" : ""
         }group_id=${groupID}&type=${category}&cacheBust=${Date.now()}`,
         {
           method: "GET",
@@ -645,7 +774,7 @@ class SidechatAPIClient {
       contentType = "my_comments";
     }
     try {
-      const res = await fetch(`${this.apiRoot}/v1/posts&type=${contentType}`, {
+      const res = await fetch(`${this.apiRoot}/v1/posts?type=${contentType}`, {
         method: "GET",
         headers: {
           ...this.defaultHeaders,
@@ -885,8 +1014,9 @@ class SidechatAPIClient {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
+      // Joining moved to the v2 endpoint, which takes a list of IDs.  Leave still sends group_id by itself, no list.
       const res = await fetch(
-        `${this.apiRoot}/v1/groups/${isMember ? "join" : "leave"}`,
+        `${this.apiRoot}${isMember ? "/v2/groups/join" : "/v1/groups/leave"}`,
         {
           method: "POST",
           headers: {
@@ -894,7 +1024,8 @@ class SidechatAPIClient {
             Authorization: `Bearer ${this.userToken}`,
           },
           body: JSON.stringify({
-            group_id: groupID,
+            group_id: isMember ? undefined : groupID,
+            group_ids: [groupID],
           }),
         },
       );
@@ -953,15 +1084,17 @@ class SidechatAPIClient {
         }),
       });
       const json = await res.json();
+      if (!res.ok) throw new SidechatAPIError(json.message);
       return await json.comment;
     } catch (err) {
       console.error(err);
+      if (err instanceof SidechatAPIError && err.message) throw err;
       throw new SidechatAPIError(`Failed to post comment.`);
     }
   };
 
   /**
-   * Creates a new post in the specified group
+   * Creates a new post in the specified group.  Users can only make two posts a minute; if a post is rejected, the thrown error contains the reason from the server.
    * @method
    * @since 2.2.0
    * @param {String} text - text content of comment
@@ -971,6 +1104,7 @@ class SidechatAPIClient {
    * @param {Boolean} [disableComments] - whether or not comments should be disabled on post
    * @param {Boolean} [anonymous] - whether or not to hide user's name and icon on post
    * @param {Array<String>} [pollOptions] - List of poll options.  If provided, a poll will be created with these options.
+   * @param {Array<String>} [attachmentIDs] - IDs of link attachments created with createLinkAttachment()
    * @returns {Promise<types.SidechatPostOrComment>} the created post
    */
   createPost = async (
@@ -982,6 +1116,7 @@ class SidechatAPIClient {
     anonymous = false,
     repostId = undefined,
     pollOptions = undefined,
+    attachmentIDs = [],
   ) => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
@@ -993,7 +1128,7 @@ class SidechatAPIClient {
         assets: assetList,
         group_ids: [groupID],
         text: text,
-        attachments: [],
+        attachments: attachmentIDs,
         dms_disabled: disableDMs,
         comments_disabled: disableComments,
         using_identity: !anonymous,
@@ -1015,9 +1150,11 @@ class SidechatAPIClient {
         body: JSON.stringify(body),
       });
       const json = await res.json();
+      if (!res.ok) throw new SidechatAPIError(json.message);
       return await json.posts[0];
     } catch (err) {
       console.error(err);
+      if (err instanceof SidechatAPIError && err.message) throw err;
       throw new SidechatAPIError(`Failed to make post.`);
     }
   };
@@ -1094,7 +1231,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `${this.apiRoot}/v1/polls/view_results&cacheBust=${Date.now()}`,
+        `${this.apiRoot}/v1/polls/view_results?cacheBust=${Date.now()}`,
         {
           method: "POST",
           headers: {
@@ -1115,22 +1252,27 @@ class SidechatAPIClient {
   };
 
   /**
-   * Uploads an asset to AWS S3 for use in posts and comments.  Currently photos only
+   * Uploads an asset to AWS S3 for use in posts and comments.  Supports images and videos (videos must be under 50MB and are processed after upload)
    * @method
    * @param {String} uri - URI of the asset to upload
-   * @param {String} mimeType - mimetype of the asset (e.g. "image/png")
+   * @param {String} mimeType - mimetype of the asset (e.g. "image/png" or "video/mp4")
    * @param {String} [name] - filename of the asset
+   * @param {"post"|"post_vod_source"|"chat"|"chat_icon"|"group_icon"|"profile_picture_icon"} [context] - where the asset will be used.  Videos default to "post_vod_source", which is required for them to be processed into a playable stream.
    * @returns {Promise<String>} URL of the uploaded asset
    * @since 2.5.1
    */
-  uploadAsset = async (uri, mimeType, name = "") => {
+  uploadAsset = async (uri, mimeType, name = "", context = undefined) => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
     }
 
     let imageType = mimeType.split("/")[1];
-    if (!["png", "jpeg", "gif"].includes(imageType)) {
-      throw new SidechatAPIError("Unsupported image format.");
+    if (imageType == "quicktime") imageType = "mov";
+    if (!["png", "jpeg", "gif", "webp", "mp4", "mov"].includes(imageType)) {
+      throw new SidechatAPIError("Unsupported file format.");
+    }
+    if (!context && ["mp4", "mov"].includes(imageType)) {
+      context = "post_vod_source";
     }
 
     const data = new FormData();
@@ -1141,7 +1283,9 @@ class SidechatAPIClient {
     });
 
     const urlReq = await this.sendRequest(
-      `/v1/assets/upload_url?content_type=${imageType}`,
+      `/v1/assets/upload_url?content_type=${imageType}${
+        context ? "&context=" + context : ""
+      }`,
     );
     const urlJson = await urlReq.json();
 
@@ -1397,7 +1541,7 @@ class SidechatAPIClient {
     }
     try {
       const res = await fetch(
-        `${this.apiRoot}/v1/chats/explore&cacheBust=${Date.now()}`,
+        `${this.apiRoot}/v1/chats/explore?cacheBust=${Date.now()}`,
         {
           method: "GET",
           headers: {
@@ -1462,21 +1606,27 @@ class SidechatAPIClient {
   /**
    * Gets a list of the user's direct messages
    * @method
+   * @param {types.SidechatCursorString} [cursor] - cursor string
    * @returns {Promise<types.SidechatDirectThread[]>}
    * @since 2.4.4
    */
-  getDMs = async () => {
+  getDMs = async (cursor) => {
     if (!this.userToken) {
       throw new SidechatAPIError("User is not authenticated.");
     }
     try {
-      const res = await fetch(`${this.apiRoot}/v1/chats`, {
-        method: "GET",
-        headers: {
-          ...this.defaultHeaders,
-          Authorization: `Bearer ${this.userToken}`,
+      const res = await fetch(
+        `${this.apiRoot}/v1/chats${
+          cursor ? "?cursor=" + encodeURIComponent(cursor) : ""
+        }`,
+        {
+          method: "GET",
+          headers: {
+            ...this.defaultHeaders,
+            Authorization: `Bearer ${this.userToken}`,
+          },
         },
-      });
+      );
       const json = await res.json();
       const list = await json.chats;
       let r = [];
@@ -1605,6 +1755,7 @@ class SidechatAPIClient {
    * @method
    * @param {String} postID - alphanumeric ID of post to hide
    * @since 2.6.2
+   * @deprecated since 2.7.0.  Please use `blockUser` instead!
    */
   hidePostsFromUser = async (postID) => {
     if (!this.userToken) {
@@ -1635,6 +1786,7 @@ class SidechatAPIClient {
    * Unhides all posts from all users
    * @method
    * @since 2.6.2
+   * @deprecated since 2.7.0.  No longer used by the official app and may stop working.
    */
   unhidePostsFromAllUsers = async () => {
     if (!this.userToken) {
@@ -1656,81 +1808,471 @@ class SidechatAPIClient {
       throw new SidechatAPIError(`Failed to unhide post.`);
     }
   };
+
+  /**
+   * Fetches the home feed, which mixes posts from all of the user's groups
+   * @method
+   * @param {"for_you"|"hot"|"recent"} [type] - how the feed should be sorted
+   * @param {String} [schoolGroupID] - alphanumeric ID of the user's school group
+   * @param {types.SidechatCursorString} [cursor] - cursor string
+   * @returns {Promise<types.SidechatFeed>} feed items and cursor
+   * @since 2.7.0
+   */
+  getHomeFeed = async (type = "for_you", schoolGroupID, cursor) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const params = new URLSearchParams({ type: type });
+      if (schoolGroupID) params.set("school_group_id", schoolGroupID);
+      if (cursor) params.set("cursor", cursor);
+      const res = await this.sendRequest(`/v1/posts/home?${params}`);
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get home feed.`);
+    }
+  };
+
+  /**
+   * Follows or unfollows a post.  Followed posts send activity notifications when they get new comments.
+   * @method
+   * @param {String} postID - alphanumeric ID of post
+   * @param {Boolean} following - whether or not the user should follow the post
+   * @returns {Promise<{post: types.SidechatPostOrComment}>} the updated post
+   * @since 2.7.0
+   */
+  setPostFollowing = async (postID, following) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        `/v1/posts/${following ? "follow" : "unfollow"}`,
+        "POST",
+        JSON.stringify({ post_id: postID }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to change post follow status.`);
+    }
+  };
+
+  /**
+   * Reports a post or comment to the group's moderators
+   * @method
+   * @param {String} postID - alphanumeric ID of post or comment to report
+   * @param {types.SidechatReportReason} reason - why the content is being reported
+   * @param {String} [note] - explanation to send along with the report
+   * @since 2.7.0
+   */
+  flagPost = async (postID, reason, note = undefined) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/posts/flag",
+        "POST",
+        JSON.stringify({ post_id: postID, reason: reason, note: note }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to report post.`);
+    }
+  };
+
+  /**
+   * Blocks the author of a post or comment, hiding all of their content from the user.  Replaces `hidePostsFromUser`.
+   * @method
+   * @param {String} postID - alphanumeric ID of a post or comment by the user to block
+   * @param {Boolean} [report] - whether or not to also report the content
+   * @param {"feed"|"chat"} [postContext] - where the content was seen
+   * @since 2.7.0
+   */
+  blockUser = async (postID, report = false, postContext = "feed") => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/posts/block_user",
+        "POST",
+        JSON.stringify({
+          post_id: postID,
+          post_context: postContext,
+          report: report,
+        }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to block user.`);
+    }
+  };
+
+  /**
+   * Creates a link attachment that can be added to a post with createPost().  YouTube links are recognized and shown as embedded videos.
+   * @method
+   * @param {String} url - URL to attach
+   * @returns {Promise<types.SidechatAttachment>} the created attachment
+   * @since 2.7.0
+   */
+  createLinkAttachment = async (url) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/attachments/upload_link",
+        "POST",
+        JSON.stringify({ link_url: url }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to create link attachment.`);
+    }
+  };
+
+  /**
+   * Gets the user's activity feed (notifications for comments, votes, followers, etc.)
+   * @method
+   * @param {types.SidechatCursorString} [cursor] - cursor string
+   * @returns {Promise<types.SidechatActivityList>} activity items and cursor
+   * @since 2.7.0
+   */
+  getActivity = async (cursor) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        `/v1/activity${cursor ? "?cursor=" + encodeURIComponent(cursor) : ""}`,
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get activity.`);
+    }
+  };
+
+  /**
+   * Gets the groups the user is a member of
+   * @method
+   * @returns {Promise<types.SidechatGroup[]>}
+   * @since 2.7.0
+   */
+  getGroups = async () => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest("/v1/groups");
+      const json = await res.json();
+      return json.groups;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get groups.`);
+    }
+  };
+
+  /**
+   * Gets groups suggested for the user to join
+   * @method
+   * @param {Number} [limit] - maximum number of groups to return
+   * @returns {Promise<types.SidechatGroup[]>}
+   * @since 2.7.0
+   */
+  getSuggestedGroups = async (limit = 10) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        `/v1/groups/suggestions?limit=${limit}`,
+      );
+      const json = await res.json();
+      return json.groups;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get suggested groups.`);
+    }
+  };
+
+  /**
+   * Gets a shareable invite link for a group.  School groups don't have invite links and will throw an error.
+   * @method
+   * @param {String} groupID - alphanumeric ID of group
+   * @returns {Promise<String>} invite link URL
+   * @since 2.7.0
+   */
+  getGroupInviteLink = async (groupID) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        `/v1/groups/invite_link?group_id=${groupID}`,
+      );
+      const json = await res.json();
+      return json.link;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get invite link.`);
+    }
+  };
+
+  /**
+   * Gets the yakarma leaderboard for a group, along with the user's own karma
+   * @method
+   * @param {String} groupID - alphanumeric ID of group
+   * @returns {Promise<types.SidechatLeaderboard>}
+   * @since 2.7.0
+   */
+  getLeaderboard = async (groupID) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(`/v1/leaderboard?group_id=${groupID}`);
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get leaderboard.`);
+    }
+  };
+
+  /**
+   * Gets the existing direct message thread for a post or comment.  Returns undefined if the user hasn't started one.
+   * @method
+   * @param {String} postID - alphanumeric ID of post or comment
+   * @returns {Promise<types.SidechatDirectThread>}
+   * @since 2.7.0
+   */
+  getDMForPost = async (postID) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(`/v1/chats/by_post?post_id=${postID}`);
+      const json = await res.json();
+      return json.chat;
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to get DM thread for post.`);
+    }
+  };
+
+  /**
+   * Reports a direct message thread
+   * @method
+   * @param {String} chatID - alphanumeric ID of the thread to report
+   * @param {types.SidechatReportReason} reason - why the thread is being reported
+   * @since 2.7.0
+   */
+  reportDM = async (chatID, reason) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/chats/report",
+        "POST",
+        JSON.stringify({ chat_id: chatID, reason: reason }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to report DM.`);
+    }
+  };
+
+  /**
+   * Sets which push notifications the user receives
+   * @method
+   * @param {types.SidechatNotificationPreferences} preferences - notification types to enable or disable
+   * @since 2.7.0
+   */
+  setNotificationPreferences = async (preferences) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/users/set_notification_preferences",
+        "POST",
+        JSON.stringify({ notification_preferences: preferences }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to set notification preferences.`);
+    }
+  };
+
+  /**
+   * Verifies the user's school email by signing in with Google or Microsoft instead of clicking an emailed link.  Returns the same object as checkEmailVerification().  This was discovered from me decompiling the new Android app, I haven't tested this but based on the implementation it should work fine and might resolve the problem that a lot of people have with their accounts not being associated with their school automatically.
+   * @method
+   * @param {String} authToken - token from the Google or Microsoft sign-in
+   * @param {"google"|"microsoft"} authType - provider the token came from
+   * @param {Boolean} [isIncomingFreshman] - whether or not the user is an incoming freshman
+   * @since 2.7.0
+   * @tutorial Email Registration
+   */
+  verifyEmailWithThirdParty = async (
+    authToken,
+    authType,
+    isIncomingFreshman = false,
+  ) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/users/third_party_email_verified",
+        "POST",
+        JSON.stringify({
+          auth: authToken,
+          auth_type: authType,
+          is_incoming_freshman: isIncomingFreshman,
+        }),
+      );
+      const json = await res.json();
+      if (json.verified_email_updates_response) {
+        return json.verified_email_updates_response;
+      } else {
+        throw new SidechatAPIError(json?.message || "Email is not verified.");
+      }
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError("Failed to verify email.");
+    }
+  };
+
+  /**
+   * Authorizes a realtime (Pusher) connection to subscribe to a private channel, such as `private-chat-<chatID>` for live direct messages.  Pass the result to your Pusher client's channel authorizer.  This hasn't been tested, and is mostly theoretical.
+   * @method
+   * @param {String} socketID - socket ID assigned by Pusher
+   * @param {String} channelName - name of the private channel to subscribe to
+   * @returns {Promise<{auth: String}>} signed channel authorization
+   * @since 2.7.0
+   */
+  authorizeRealtimeChannel = async (socketID, channelName) => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/pusher/auth",
+        "POST",
+        JSON.stringify({ socket_id: socketID, channel_name: channelName }),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to authorize realtime channel.`);
+    }
+  };
+
+  /**
+   * Permanently deletes the current user's account.  This cannot be undone!
+   * @method
+   * @since 2.7.0
+   */
+  deleteAccount = async () => {
+    if (!this.userToken) {
+      throw new SidechatAPIError("User is not authenticated.");
+    }
+    try {
+      const res = await this.sendRequest(
+        "/v1/users/delete",
+        "POST",
+        JSON.stringify({}),
+      );
+      return await res.json();
+    } catch (err) {
+      console.error(err);
+      throw new SidechatAPIError(`Failed to delete account.`);
+    }
+  };
 }
 
-/**
- * @typedef SidechatColor
- * @prop {String} primary - hex code of primary color
- * @prop {String} secondary - hex code of secondary color
- */
-
-/**
- * List of colors compatible with user conversation icons
- * @prop {SidechatColor[]} colors - list of color themes for user icons
- */
-class SidechatColorList {
-  colors = [
-    {
-      primary: "#74DEEE",
-      secondary: "#239EAB",
-    },
-    {
-      primary: "#15FF46",
-      secondary: "#3FC0FF",
-    },
-    {
-      primary: "#D9FB8A",
-      secondary: "#B1FD00",
-    },
-    {
-      primary: "#FC40FF",
-      secondary: "#0DD5B2",
-    },
-    {
-      primary: "#3E973C",
-      secondary: "#0F430E",
-    },
-    {
-      primary: "#FFD305",
-      secondary: "#F4B320",
-    },
-    {
-      primary: "#8483FF",
-      secondary: "#5857FF",
-    },
-    {
-      primary: "#FA81FF",
-      secondary: "#722DFF",
-    },
-    {
-      primary: "#00CBFE",
-      secondary: "#0D13D5",
-    },
-    {
-      primary: "#FF7B51",
-      secondary: "#B2431F",
-    },
-    {
-      primary: "#FF47CC",
-      secondary: "#69004C",
-    },
-    {
-      primary: "#00EE6E",
-      secondary: "#0C75E6",
-    },
-    {
-      primary: "#FF1885",
-      secondary: "#FA81FF",
-    },
-    {
-      primary: "#D8DC44",
-      secondary: "#228B3F",
-    },
-    {
-      primary: "#0968E5",
-      secondary: "#091970",
-    },
-  ];
+/**
+ * @typedef SidechatColor
+ * @prop {String} primary - hex code of primary color
+ * @prop {String} secondary - hex code of secondary color
+ */
+
+/**
+ * List of colors compatible with user conversation icons
+ * @prop {SidechatColor[]} colors - list of color themes for user icons
+ */
+class SidechatColorList {
+  colors = [
+    {
+      primary: "#74DEEE",
+      secondary: "#239EAB",
+    },
+    {
+      primary: "#15FF46",
+      secondary: "#3FC0FF",
+    },
+    {
+      primary: "#D9FB8A",
+      secondary: "#B1FD00",
+    },
+    {
+      primary: "#FC40FF",
+      secondary: "#0DD5B2",
+    },
+    {
+      primary: "#3E973C",
+      secondary: "#0F430E",
+    },
+    {
+      primary: "#FFD305",
+      secondary: "#F4B320",
+    },
+    {
+      primary: "#8483FF",
+      secondary: "#5857FF",
+    },
+    {
+      primary: "#FA81FF",
+      secondary: "#722DFF",
+    },
+    {
+      primary: "#00CBFE",
+      secondary: "#0D13D5",
+    },
+    {
+      primary: "#FF7B51",
+      secondary: "#B2431F",
+    },
+    {
+      primary: "#FF47CC",
+      secondary: "#69004C",
+    },
+    {
+      primary: "#00EE6E",
+      secondary: "#0C75E6",
+    },
+    {
+      primary: "#FF1885",
+      secondary: "#FA81FF",
+    },
+    {
+      primary: "#D8DC44",
+      secondary: "#228B3F",
+    },
+    {
+      primary: "#0968E5",
+      secondary: "#091970",
+    },
+  ];
 }
 
 exports.SidechatAPIClient = SidechatAPIClient;