Alter endpoints for release & update method comments

Author: Majored

src/helpers/alerts.js

@@ -11,23 +11,23 @@ object.init = function(wrapper) {
 };
 
 /* functions */
-// List a single page of unread alerts (with optional sort options).
+// List a single page of unread alerts.
 //
-// See documentation for response array object fields: https://www.mc-market.org/wiki/ultimate-api-v1-alerts/
+// Response data: {}
 object.list = async function(sort_options) {
   return await this.wrapper.get(`/alerts`, sort_options);
 };
 
-// List all pages of unread alerts (with optional sort options).
+// List all pages of unread alerts.
 //
-// See documentation for response array object fields: https://www.mc-market.org/wiki/ultimate-api-v1-alerts/
+// Response data: {}
 object.list_all = async function(sort_options) {
   return await this.wrapper.list_until(`/alerts`, () => true, sort_options);
 };
 
-// List multiple pages of unread alerts (with optional sort options) until a condition is no longer met.
+// List multiple pages of unread alerts until a condition is no longer met.
 //
-// See documentation for response array object fields: https://www.mc-market.org/wiki/ultimate-api-v1-alerts/
+// Response data: {}
 object.list_until = async function(should_continue, sort_options) {
   return await this.wrapper.list_until(`/alerts`, should_continue, sort_options);
 };

src/helpers/conversations.js

@@ -10,59 +10,59 @@ object.init = function(wrapper) {
   return this;
 };
 
-// List a page of unread conversations (with optional sort options).
+// List a page of unread conversations.
 //
-// See documentation for response array object fields: https://www.mc-market.org/wiki/ultimate-api-v1-conversations/
+// Response data: {}
 object.list = async function(sort_options) {
   return await this.wrapper.get(`/conversations`, sort_options);
 };
 
-// List all pages of unread conversations (with optional sort options).
+// List all pages of unread conversations.
 //
-// See documentation for response array object fields: https://www.mc-market.org/wiki/ultimate-api-v1-conversations/
+// Response data: {}
 object.list_all = async function(sort_options) {
   return await this.wrapper.list_until(`/conversations`, () => true, sort_options);
 };
 
-// List multiple pages of unread conversations (with optional sort options) until a condition is no longer met.
+// List multiple pages of unread conversations until a condition is no longer met.
 //
-// See documentation for response array object fields: https://www.mc-market.org/wiki/ultimate-api-v1-conversations/
+// Response data: {}
 object.list_until = async function(should_continue, sort_options) {
   return await this.wrapper.list_until(`/conversations`, should_continue, sort_options);
 };
 
-// Create a new conversation.
-object.create = async function(title, message, recipient_ids) {
+// Start a new conversation.
+//
+// Response data: {}
+object.start = async function(title, message, recipient_ids) {
   let body_data = {title: title, message: message, recipient_id: recipient_ids};
   return await this.wrapper.post(`/conversations`, body_data);
 };
 
-// List a page of replies to an unread conversation (with optional sort options).
+// List a page of replies to an unread conversation.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-conversations-replies/
+// Response data: {}
 object.list_replies = async function(conversation_id, sort_options) {
   return await this.wrapper.get(`/conversations/${conversation_id}/replies`, sort_options);
 };
 
-// List all pages of replies to an unread conversation (with optional sort options).
+// List all pages of replies to an unread conversation.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-conversations-replies/
+// Response data: {}
 object.list_replies_all = async function(conversation_id, sort_options) {
   return await this.wrapper.list_until(`/conversations/${conversation_id}/replies`, () => true, sort_options);
 };
 
-// List multiple pages of replies to an unread conversation (with optional sort options) until a condition is no longer
-// met.
+// List multiple pages of replies to an unread conversation until a condition is no longer met.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-conversations-replies/
+// Response data: {}
 object.list_replies_until = async function(conversation_id, should_continue, sort_options) {
   return await this.wrapper.list_until(`/conversations/${conversation_id}/replies`, should_continue, sort_options);
 };
 
 // Reply to an unread conversation
+//
+// Response data: {}
 object.reply = async function(conversation_id, message) {
   return await this.wrapper.post(`/conversations/${conversation_id}/replies`, {message: message});
 };

src/helpers/members/members.js

@@ -15,30 +15,39 @@ object.init = function(wrapper) {
 };
 
 /* functions */
-// Fetch detailed information about yourself.
+// Fetch information about yourself.
 //
-// See documentation for response object fields: https://www.mc-market.org/wiki/ultimate-api-v1-members/
+// Response data: {}
 object.self = async function() {
   return await this.wrapper.get(`/members/self`);
 };
 
-// Fetch detailed information about a member.
+/* functions */
+// Modify information about yourself.
+//
+// Response data: {}
+object.modify_self = async function(about_me, custom_title, signature) {
+  let body = {about_me: about_me, custom_title: custom_title, signature: signature};
+  return await this.wrapper.patch(`/members/self`, body);
+};
+
+// Fetch information about a member.
 //
-// See documentation for response object fields: https://www.mc-market.org/wiki/ultimate-api-v1-members/
+// Response data: {}
 object.fetch = async function(member_id) {
   return await this.wrapper.get(`/members/${member_id}`);
 };
 
-// Fetch detailed information about a member by username.
+// Fetch information about a member by username.
 //
-// See documentation for response object fields: https://www.mc-market.org/wiki/ultimate-api-v1-members/
+// Response data: {}
 object.fetch_by_username = async function(username) {
-  return await this.wrapper.get(`/members/username/${username}`);
+  return await this.wrapper.get(`/members/usernames/${username}`);
 };
 
 // Fetch a list of recently issued bans.
 //
-// See documentation for response object fields: https://www.mc-market.org/wiki/ultimate-api-v1-members/
+// Response data: {}
 object.bans = async function() {
   return await this.wrapper.get("/members/bans");
 };

src/helpers/members/profile_posts.js

@@ -11,41 +11,36 @@ object.init = function(wrapper) {
 };
 
 /* functions */
-// List a page of profile posts on your profile (with optional sort options).
+// List a page of profile posts on your profile.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-members-profile-posts/
+// Response data: {}
 object.list = async function(sort_options) {
   return await this.wrapper.get(`/members/self/profile-posts`, sort_options);
 };
 
-// List all pages of profile posts on your profile (with optional sort options).
+// List all pages of profile posts on your profile.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-members-profile-posts/
+// Response data: {}
 object.list_all = async function(sort_options) {
   return await this.wrapper.list_until(`/members/self/profile-posts`, () => true, sort_options);
 };
 
-// List multiple pages of profile posts on your profile (with optional sort options) until a condition is no longer
-// met.
+// List multiple pages of profile posts on your profile until a condition is no longer met.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-members-profile-posts/
+// Response data: {}
 object.list_until = async function(should_continue, sort_options) {
   return await this.wrapper.list_until(`/members/self/profile-posts`, should_continue, sort_options);
 };
 
 // Fetch information about a profile post on your profile.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-members-profile-posts/
+// Response data: {}
 object.fetch = async function(profile_post_id) {
   return await this.wrapper.get(`/members/self/profile-posts/${profile_post_id}`);
 };
 
-// Edit a profile post on your profile that you've authored.
-object.edit = async function(profile_post_id, message) {
+// Modify a profile post on your profile that you've authored.
+object.modify = async function(profile_post_id, message) {
   return await this.wrapper.patch(`/members/self/profile-posts/${profile_post_id}`, {message: message});
 };
 

src/helpers/resources/downloads.js

@@ -11,83 +11,71 @@ object.init = function(wrapper) {
 };
 
 /* functions */
-// List a page of downloads for a given resource (with optional sort options).
+// List a page of downloads for a given resource.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list = async function(resource_id, sort_options) {
   return await this.wrapper.get(`/resources/${resource_id}/downloads`, sort_options);
 };
 
-// List all pages of downloads for a given resource (with optional sort options).
+// List all pages of downloads for a given resource.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_all = async function(resource_id, sort_options) {
   return await this.wrapper.list_until(`/resources/${resource_id}/downloads`, () => true, sort_options);
 };
 
-// List multiple pages of downloads for a given resource (with optional sort options) until a condition is no longer
-// met.
+// List multiple pages of downloads for a given resource until a condition is no longer met.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_until = async function(resource_id, should_continue, sort_options) {
   return await this.wrapper.list_until(`/resources/${resource_id}/downloads`, should_continue, sort_options);
 };
 
-// List a page of downloads by member for a given resource (with optional sort options).
+// List a page of downloads by member for a given resource.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_by_member = async function(resource_id, member_id, sort_options) {
   return await this.wrapper.get(`/resources/${resource_id}/downloads/members/${member_id}`, sort_options);
 };
 
-// List all pages of downloads by member for a given resource (with optional sort options).
+// List all pages of downloads by member for a given resource.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_by_member_all = async function(resource_id, member_id, sort_options) {
   return await this.wrapper.list_until(
     `/resources/${resource_id}/downloads/members/${member_id}`, () => true, sort_options
   );
 };
 
-// List multiple pages of downloads by member for a given resource (with optional sort options) until a condition is no
-// longer met.
+// List multiple pages of downloads by member for a given resource until a condition is no longer met.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_by_member_until = async function(resource_id, member_id, should_continue, sort_options) {
   return await this.wrapper.list_until(
     `/resources/${resource_id}/downloads/members/${member_id}`, should_continue, sort_options
   );
 };
 
-// List a page of downloads by version for a given resource (with optional sort options).
+// List a page of downloads by version for a given resource.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_by_version = async function(resource_id, version_id, sort_options) {
   return await this.wrapper.get(`/resources/${resource_id}/downloads/versions/${version_id}`, sort_options);
 };
 
-// List all pages of downloads by version for a given resource (with optional sort options).
+// List all pages of downloads by version for a given resource.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_by_version_all = async function(resource_id, version_id, sort_options) {
   return await this.wrapper.list_until(
     `/resources/${resource_id}/downloads/versions/${version_id}`, () => true, sort_options
   );
 };
 
-// List multiple pages of downloads by version for a given resource (with optional sort options) until a condition is
-// no longer met.
+// List multiple pages of downloads by version for a given resource until a condition is no longer met.
 //
-// See documentation for response array object fields:
-// https://www.mc-market.org/wiki/ultimate-api-v1-resources-downloads/
+// Response data: {}
 object.list_by_version_until = async function(resource_id, version_id, should_continue, sort_options) {
   return await this.wrapper.list_until(
     `/resources/${resource_id}/downloads/versions/${version_id}`, should_continue, sort_options