mapih v3.15.0

Mapih

Comprehensive collection of Discord, OpenAI, Anthropic, Spotify, YouTube, Twitter, Slack, Imgur, DropBox, Box and various Google API endpoint handlers

Discord is the only completed set of handlers, the rest are still in early development

Authentication

Choose one of the following options to authenticate:

Option 1: Using Environment Variablese

If you are using OnSocket, use this file to get the valid keys but add them to OnSocket's environment variables on the website itself.

Rename the provided .env.example file at the root of your project to .env and fill in any tokens/keys you wish to use.

Option 2: Using Initialization Function

const mapih = require('mapih');

// Minimum requirement if using this method
mapih.initialize({ discord: 'bot_token' });  

// All possible properties 
mapih.initialize({
  discord: 'bot_token',
  openai: 'sk-1p7NKtCpA0sG7XLdT3L7EqW9GFefX',
  spotify: {
    client_id: 'cc4287d9Cm4692a9f681d07d9boqji83',
    client_secret: '898Nb8f7b09tMnb2lkj3c55443ddmn0ze',
    redirect_uri: 'http:localhost:8001/spotify',
    scope: 'user-read-email user-read-private'
  },
  google: {
    api_key: 'AISlkuhyA4q4L9m0c3I09maoOYTN0wuyWdA',
    client_id: '2164170085-9r94msc46elo.apps.googleusercontent.com',
    client_secret: 'GOSLPM-sPn88Kn6GWk90Nh0uk_MNim7698By4',
    redirect_uri: 'http://localhost:8001/youtube'
  },
  slack: {
    user: '6942854604069-6272480346098-6284925009575-6901309',
    bot: '6942854604069-6262140883098-Vt6RKehxmTj4Luvvy',
    client_id: '6942854604069.624286609478',
    client_secret: '4e4998dh94rl846bdsdfegfb0f12',
    redirect_uri: 'http:localhost:8001/slack',
    user_scope: 'admin users:read.email',
    bot_scope: 'users:read.email channels:read'
  },
  dropbox: {
    basic_token: 'N09asdfGlzZzB9P63465efasNWxAvfpk3dQ',
    access_token: 'sl.BsobToktTBbsdf235aiihH7j60T_4T',
    client_id: '7cxvzmptyug7ymc9',
    client_secret: 'easdf8980k6csdf5y7u',
    redirect_uri: 'http:localhost:8001/dropbox'
  },
  box: {
    client_id: '3sdfgi8j90fpl8q25809sd0',
    client_secret: 'Jsdf6BB4UErgS2chrg4365sdfBXS',
    redirect_uri: 'http:localhost:8001/box'
  },
});

Basic usage

(async() => {

  await mapih.discord.channels.messages.create({
    channel_id: '774133713733812275',
    content: 'hello'
  });

})();

Table of Contents

| Discord | Slack | Spotify | YouTube | Dropbox | Box | Utils |

Discord Methods

• Applications
    ◦ getMe
    ◦ updateMe
    ◦ appRoleConnectionMeta
    ◦ updateAppRoleConnectionMeta
    ◦ commands
        ‣ retrieve
        ‣ getAll
        ‣ create
        ‣ update
        ‣ destroy
        ‣ bulkOverwrite
        ‣ retrievePermissions
        ‣ getAllPermissions
        ‣ updatePermissions
    ◦ entitlements
        ‣ getAll
        ‣ create
        ‣ destroy
    ◦ skus
        ‣ getAll
• Audit Log
    ◦ retrieve
• Auto Moderation
    ◦ retrieveRule
    ◦ getAllRules
    ◦ createRule
    ◦ updateRule
    ◦ destroyRule
• Channels
    ◦ retrieve
    ◦ update
    ◦ destroy
    ◦ updatePermissions
    ◦ deletePermissions
    ◦ getinvites
    ◦ inviteCreate
    ◦ typingCreate
    ◦ followAnnouncementChannel
    ◦ groupDMadd
    ◦ groupDMremove
    ◦ messages
        ‣ retrieve
        ‣ getAll
        ‣ create
        ‣ update
        ‣ destroy
        ‣ bulkDelete
        ‣ crosspost
        ‣ pin
        ‣ unpin
        ‣ getPinned
    ◦ threads
        ‣ forumThreadCreate
        ‣ createFromMessage
        ‣ createWithoutMessage
        ‣ join
        ‣ leave
        ‣ addMember
        ‣ removeMember
        ‣ retrieveMember
        ‣ getAllMembers
        ‣ getAllPublicArchived
        ‣ getAllPrivateArchived
        ‣ getAllJoinedPrivateArchived
    ◦ reactions
        ‣ create
        ‣ deleteOwn
        ‣ deleteUser
        ‣ deleteAll
        ‣ deleteAllEmoji
        ‣ getUsers
• Guilds
    ◦ create
    ◦ update
    ◦ destroy
    ◦ retrieve
    ◦ destroy
    ◦ getPreview
    ◦ retrieveBan
    ◦ getAllBans
    ◦ createBan
    ◦ destroyBan
    ◦ getInvites
    ◦ updateMFAlevel
    ◦ getPruneCount
    ◦ beginPrune
    ◦ getVoiceRegions
    ◦ getAllIntegrations
    ◦ destroyIntegration
    ◦ retrieveWidget
    ◦ retrieveWidgetImage
    ◦ retrieveWidgetSettings
    ◦ updateWidget
    ◦ retrieveVanityURL
    ◦ retrieveWelcomeScreen
    ◦ updateWelcomeScreen
    ◦ retrieveOnboarding
    ◦ updateOnboarding
    ◦ newMemberWelcome
    ◦ channels
        ‣ getAll
        ‣ create
        ‣ updatePositions
    ◦ members
        ‣ retrieve
        ‣ getAll
        ‣ search
        ‣ remove
        ‣ update
        ‣ updateCurrent
        ‣ addRole
        ‣ removeRole
        ‣ getPermissionNames
        ‣ timeout
    ◦ roles
        ‣ retrieve
        ‣ getAll
        ‣ create
        ‣ update
        ‣ destroy
        ‣ updatePositions
    ◦ emojis
        ‣ retrieve
        ‣ getAll
        ‣ create
        ‣ update
        ‣ destroy
    ◦ stickers
        ‣ retrieve
        ‣ nitroPacks
        ‣ getAll
        ‣ retrieveGuild
        ‣ create
        ‣ update
        ‣ destroy
    ◦ events
        ‣ retrieve
        ‣ getAll
        ‣ getUsers
        ‣ create
        ‣ update
        ‣ destroy
    ◦ templates
        ‣ retrieve
        ‣ getAll
        ‣ create
        ‣ createGuild
        ‣ sync
        ‣ update
        ‣ destroy
• Interactions
    ◦ callback
        ‣ reply
        ‣ defer
        ‣ get_original
        ‣ update_original
        ‣ delete_original
        ‣ component_defer
        ‣ component_update
        ‣ autocomplete_reply
        ‣ modal_reply
        ‣ upgrade
    ◦ followup
        ‣ retrieve
        ‣ create
        ‣ update
        ‣ destroy
• Invites
    ◦ retrieve
    ◦ revoke
• OAuth 2
• Stage Instances
    ◦ retrieve
    ◦ create
    ◦ update
    ◦ destroy
• Users
    ◦ retrieve
    ◦ currentUser
    ◦ myGuilds
    ◦ currentMember
    ◦ updateCurrent
    ◦ connections
    ◦ appRoleConnection
    ◦ updateAppRoleConnection
    ◦ createDM
    ◦ createGroupDM
    ◦ leaveGuild
• Webhooks
    ◦ retrieve
    ◦ retrieveWithToken
    ◦ retrieveChannel
    ◦ retrieveGuild
    ◦ retrieveMessage
    ◦ updateMessage
    ◦ destroyMessage
    ◦ create
    ◦ update
    ◦ updateWithToken
    ◦ destroy
    ◦ destroyWithToken
    ◦ execute
• Objects/Types
    ◦ Guilds
    ◦ Users
    ◦ Channels
    ◦ Interactions
    ◦ Roles
    ◦ Emojis/Stickers
    ◦ Message Components
    ◦ Webhooks
    ◦ Invites
    ◦ Application
    ◦ Audit Log
    ◦ Auto Moderation

OpenAI Methods

• Chat
    ◦ create
• Images
    ◦ create
• Speech
    ◦ create
• Embeddings
    ◦ create

Slack Methods

Docs coming soon

Spotify Methods

• Users
    ◦ me
    ◦ topItems
    ◦ getProfile
• Search
    ◦ advanced
    ◦ artists
    ◦ songs
    ◦ albums
• Songs
    ◦ retrieve
    ◦ retrieveMany
    ◦ recommendations
    ◦ save
    ◦ unsave
    ◦ saved
    ◦ isSaved
    ◦ analyze
    ◦ audioFeatures
    ◦ audioFeaturesMany
• Artists
    ◦ retrieve
    ◦ retrieveMany
    ◦ recommendations
    ◦ albums
    ◦ related
    ◦ follow
    ◦ unfollow
    ◦ following
    ◦ isFollowing
• Albums
    ◦ retrieve
    ◦ retrieveMany
    ◦ songs
    ◦ new
    ◦ save
    ◦ unsave
    ◦ saved
    ◦ isSaved
• Playlists
    ◦ featured
    ◦ category
    ◦ create
    ◦ addSongs
    ◦ update
    ◦ updateSongs
    ◦ removeSongs
    ◦ retrieveSongs
    ◦ created
    ◦ following
    ◦ isFollowing
    ◦ follow
    ◦ unfollow
    ◦ user
    ◦ cover
    ◦ updateCover
• Playback
    ◦ state
    ◦ currentSong
    ◦ devices
    ◦ togglePlayback
    ◦ pause
    ◦ skip
    ◦ previous
    ◦ seek
    ◦ setVolume
    ◦ toggleShuffle
    ◦ toggleRepeat
    ◦ queue
    ◦ recent
    ◦ addToQueue
    ◦ transfer

Utils Methods

• Storage
    ◦ get
    ◦ getMany
    ◦ set
    ◦ setMany
    ◦ delete
    ◦ deleteMany
    ◦ merge
    ◦ push
    ◦ export
    ◦ filter
    ◦ all
    ◦ has
    ◦ entries
    ◦ keys
    ◦ values
    ◦ size
    ◦ bytes
    ◦ toJson
    ◦ clear
    ◦ equals
    ◦ history
    ◦ clearHistory

Discord

Guilds

All functions relating to Discord Guilds (servers)

Get Guild

Parameters

Example

await mapih.discord.guilds.retrieve({
  guild_id: '0000000000'
});

Create Guild

This endpoint can be used only by bots in less than 10 servers.

Parameters

Example

await mapih.discord.guilds.create({
  name: "Eric's Server",
  icon: 'https://imgurl.png', // or buffer
  default_message_notifications: 1, // ONLY_MENTIONS
  verification_level: 0, // NONE
  explicit_content_filter: 0, // DISABLED
  roles: [{
    name: 'Administrator',
    permissions: 1 << 3,
    hoist: 'true',
    mentionable: 'false'
  }],
  channels: [
    {
      name: 'my-category',
      type: 4, // GUILD_CATEGORY
      id: 1
    },
    {
      name: 'bot-testing',
      type: 0, // GUILD_TEXT
      id: 2,
      parent_id: 1 // 'my-category'
    }
  ]
});

Modify Guild

Parameters

Example

await mapih.discord.guilds.update({
  name: "Eric's New Server",
  // ...
});

Delete Guild

Parameters

Example

await mapih.discord.guilds.destroy({
  guild_id: '0000000000'
});

Get Guild Preview

• If the user is not in the guild, then the guild must be lurkable.

Parameters

Example

await mapih.discord.guilds.getPreview({
  guild_id: '0000000000'
});

Get Guild Ban

• Returns a ban object for the given user or a 404 not found if the ban cannot be found.
• Requires the BAN_MEMBERS permission.

Parameters

Example

await mapih.discord.guilds.retrieveBan({
  guild_id: '0000000000',
  user_id: '0000000000'
});

Get Guild Bans

Parameters

Example

await mapih.discord.guilds.getAllBans({
  guild_id: '0000000000',
  limit: 50,
  after: '0000000000'
});

Create Guild Ban

• Requires the BAN_MEMBERS permission.

Parameters

Example

await mapih.discord.guilds.createBan({
  guild_id: '0000000000',
  user_id: '0000000000',
  delete_message_seconds: 604800,
  reason: 'not cool enough'
});

Remove Guild Ban

• Requires the BAN_MEMBERS permission.

Parameters

Example

await mapih.discord.guilds.destroyBan({
  guild_id: '0000000000',
  user_id: '0000000000',
  reason: 'ok I guess you\'re alright'
});

Modify Guild MFA Level

• Requires guild ownership.

Parameters

Example

await mapih.discord.guilds.updateMFAlevel({
  guild_id: '0000000000',
  level: 0
});

Get Guild Prune Count

• By default, prune will not remove users with roles.
• You can optionally include specific roles in your prune by providing the include_roles parameter.
• Any inactive user that has a subset of the provided role(s) will be counted in the prune and users with additional roles will not.

Parameters

Example

await mapih.discord.guilds.getPruneCount({
  guild_id: '0000000000',
  days: 3,
  include_roles: [
    '0000000000'
  ]
});

Begin Guild Prune

• For large guilds it's recommended to set the compute_prune_count option to false, forcing pruned to null.
• By default, prune will not remove users with roles.
• You can optionally include specific roles in your prune by providing the include_roles parameter.
• Any inactive user that has a subset of the provided role(s) will be counted in the prune and users with additional roles will not.

Parameters

Example

await mapih.discord.guilds.beginPrune({
  guild_id: '0000000000',
  days: 3,
  compute_prune_count: true,
  include_roles: [
    '0000000000'
  ]
});

Get Guild Voice Regions

Parameters

Example

await mapih.discord.guilds.getVoiceRegions({
  guild_id: '0000000000'
});

Get Guild Integrations

This endpoint returns a maximum of 50 integrations.
If a guild has more integrations, they cannot be accessed.

Parameters

Example

await mapih.discord.guilds.getAllIntegrations({
  guild_id: '0000000000'
});

Delete Guild Integration

• Deletes any associated webhooks and kicks the associated bot if there is one.

Parameters

Example

await mapih.discord.guilds.destroyIntegration({
  guild_id: '0000000000'
});

Get Guild Widget

Parameters

Example

await mapih.discord.guilds.retrieveWidget({
  guild_id: '0000000000'
});

Get Guild Widget Settings

Parameters

Example

await mapih.discord.guilds.retrieveWidgetSettings({
  guild_id: '0000000000'
});

Get Guild Widget Image

Widget Style Options

Parameters

Example

await mapih.discord.guilds.retrieveWidgetImage({
  guild_id: '0000000000',
  style: 'banner3'
});

Modify Guild Widget

Parameters

Example

await mapih.discord.guilds.updateWidget({
  guild_id: '0000000000',
  enabled: true
});

Get Guild Vanity URL

Parameters

Example

await mapih.discord.guilds.retrieveVanityURL({
  guild_id: '0000000000'
});

Get Guild Welcome Screen

Parameters

Example

await mapih.discord.guilds.retrieveWelcomeScreen({
  guild_id: '0000000000'
});

Modify Guild Welcome Screen

Parameters

Example

await mapih.discord.guilds.updateWelcomeScreen({
  guild_id: '0000000000',
  enabled: true
});

Get Guild Onboarding

Parameters

Example

await mapih.discord.guilds.retrieveOnboarding({
  guild_id: '0000000000',
  enabled: true
});

Modify Guild Onboarding

• Requires the MANAGE_GUILD and MANAGE_ROLES permissions.
• Onboarding enforces constraints when enabled. These constraints are that there must be at least 7 Default Channels and at least 5 of them must allow sending messages to the @everyone role. The mode field modifies what is considered when enforcing these constraints.**

Parameters

Example

await mapih.discord.guilds.updateOnboarding({
  guild_id: '0000000000',
  prompts: [{
    id: '0000000000',
    type: 0,
    title: 'Prompt Title',
    single_select: true,
    required: true,
    in_onboarding: true,
    options: [{
      title: 'Option Title',
      description: 'Option description',
      id: '0000000000',
      channel_ids: [
        '0000000000'
      ],
      role_ids: [
        '0000000000'
      ],
      emoji: {
        id: '0000000000',
        name: 'emoji_name',
        animated: false
      }
    }]
  }]
});

Guild Channels

Get Guild Channels

Does not include threads

Parameters

Example

await mapih.discord.guilds.channels.getAll({
  guild_id: '0000000000'
});

Create Guild Channel

All parameters to this endpoint are optional and nullable excluding name

Parameters

Example

await mapih.discord.guilds.channels.create({
  guild_id: '0000000000',
  name: 'my-new-channel',
  type: 0,
  topic: 'Cool people only',
  position: 19
});

Modify Guild Channel Positions

Only channels to be modified are required

Parameters

Example

await mapih.discord.guilds.channels.updatePositions({
  guild_id: '0000000000',
  channels: [{
    id: '0000000000',
    position: 3,
    lock_permissions: true,
    parent_id: '0000000000'
  }]
});

Guild Members

Get Guild Member

Parameters

Example

await mapih.discord.guilds.members.retrieve({
  guild_id: '0000000000',
  user_id: '0000000000'
});

List Guild Members

Parameters

Example

await mapih.discord.guilds.members.getAll({
  guild_id: '0000000000',
  limit: 1000
});

Search Guild Members

Parameters

Example

await mapih.discord.guilds.members.search({
  guild_id: '0000000000',
  query: 'lostmyinfo',
  limit: 1
});

Remove Guild Member

Parameters

Example

await mapih.discord.guilds.members.remove({
  guild_id: '0000000000',
  user_id: '0000000000',
  reason: 'not cool enough'
});

Modify Guild Member

• If the channel_id is set to null, this will force the target user to be disconnected from voice.

All parameters to this endpoint are optional and nullable.

Parameters

Example

await mapih.discord.guilds.members.update({
  guild_id: '0000000000',
  nick: 'cool new nick'
});

Modify Current Member

Parameters

Example

await mapih.discord.guilds.members.updateCurrent({
  guild_id: '0000000000',
  nick: 'cool new nick'
});

Add Guild Member Role

Parameters

Example

await mapih.discord.guilds.members.addRole({
  guild_id: '0000000000',
  user_id: '0000000000',
  role_id: '0000000000'
});

Remove Guild Member Role

Parameters

Example

await mapih.discord.guilds.members.removeRole({
  guild_id: '0000000000',
  user_id: '0000000000',
  role_id: '0000000000'
});

Get Member Permission Names

Parameters

Example

const x = params.member.roles;
const y = params.guild.roles;
const permNames = getPermissionNames(x, y);

Timeout Guild Member

• Sets/adjusts/clears a member's timeout

Parameters