api.md

AlbotAPISDK

Types:

• GetRootResponse

Methods:

• client.getRoot() -> unknown

Oauth2

Types:

• PlainAPIResponse
• URLAPIResponse

Methods:

• client.oauth2.callback({ ...params }) -> PlainAPIResponse
• client.oauth2.logout() -> PlainAPIResponse
• client.oauth2.redirect({ ...params }) -> URLAPIResponse

Shards

Types:

• ShardListResponse
• ShardAssignResponse
• ShardGetConnectionCommandsResponse

Methods:

• client.shards.list({ ...params }) -> ShardListResponse
• client.shards.assign() -> ShardAssignResponse
• client.shards.getConnectionCommands(shardID, { ...params }) -> ShardGetConnectionCommandsResponse
• client.shards.postMetrics(shardID, { ...params }) -> PlainAPIResponse
• client.shards.release(shardID) -> PlainAPIResponse

Guilds

Types:

• ListSubscriptions
• GuildCreateConnectionStatesResponse

Methods:

• client.guilds.create(guildID) -> PlainAPIResponse
• client.guilds.delete(guildID) -> PlainAPIResponse
• client.guilds.createConnectionStates(guildID, { ...params }) -> GuildCreateConnectionStatesResponse
• client.guilds.createQuickReport(guildID, { ...params }) -> PlainAPIResponse
• client.guilds.listSubscriptions(guildID) -> ListSubscriptions

Dict

Types:

• DictRetrieveResponse

Methods:

• client.guilds.dict.retrieve(guildID) -> DictRetrieveResponse
• client.guilds.dict.delete(guildID) -> PlainAPIResponse
• client.guilds.dict.replace(guildID, { ...params }) -> PlainAPIResponse

Settings

Types:

• SettingRetrieveResponse

Methods:

• client.guilds.settings.retrieve(guildID) -> SettingRetrieveResponse
• client.guilds.settings.update(guildID, { ...params }) -> PlainAPIResponse
• client.guilds.settings.delete(guildID) -> PlainAPIResponse

CharacterUsage

Types:

• CharacterUsage
• CharacterUsages
• CharacterUsageRetrieveResponse

Methods:

• client.guilds.characterUsage.retrieve(guildID) -> CharacterUsageRetrieveResponse
• client.guilds.characterUsage.update(guildID, { ...params }) -> PlainAPIResponse

TrustedRoles

Types:

• TrustedRoleListResponse

Methods:

• client.guilds.trustedRoles.update(guildID, { ...params }) -> PlainAPIResponse
• client.guilds.trustedRoles.list(guildID) -> TrustedRoleListResponse

ConnectionCommand

Types:

• ConnectionCommand
• ConnectionCommandRetrieveResponse

Methods:

• client.guilds.connectionCommand.retrieve(guildID) -> ConnectionCommandRetrieveResponse
• client.guilds.connectionCommand.update(guildID, { ...params }) -> PlainAPIResponse

MessageLinkExpandPreference

Types:

• MessageLinkExpandPreference
• MessageLinkExpandPreferenceRetrieveResponse

Methods:

• client.guilds.messageLinkExpandPreference.retrieve(guildID) -> MessageLinkExpandPreferenceRetrieveResponse
• client.guilds.messageLinkExpandPreference.update(guildID, { ...params }) -> PlainAPIResponse

Users

Me

Types:

• MeRetrieveInfoResponse

Methods:

• client.users.me.createCheckoutSession({ ...params }) -> URLAPIResponse
• client.users.me.retrieveInfo() -> MeRetrieveInfoResponse

Subscriptions

Types:

• SubscriptionActivate
• SubscriptionRenew

Methods:

• client.users.me.subscriptions.list() -> ListSubscriptions
• client.users.me.subscriptions.activate(subID, { ...params }) -> PlainAPIResponse
• client.users.me.subscriptions.cancel(subID) -> PlainAPIResponse
• client.users.me.subscriptions.renew(subID, { ...params }) -> PlainAPIResponse

Guilds

Types:

• PartialGuild
• GuildListResponse
• GuildRetrieveInfoResponse

Methods:

• client.users.me.guilds.list({ ...params }) -> GuildListResponse
• client.users.me.guilds.retrieveInfo(guildID) -> GuildRetrieveInfoResponse

Subscriptions

Methods:

• client.users.subscriptions.list(userID) -> ListSubscriptions
• client.users.subscriptions.activate(subID, { ...params }) -> PlainAPIResponse
• client.users.subscriptions.cancel(subID, { ...params }) -> PlainAPIResponse
• client.users.subscriptions.renew(subID, { ...params }) -> PlainAPIResponse

Metrics

Types:

• MetricRetrieveResponse

Methods:

• client.metrics.retrieve() -> MetricRetrieveResponse

Webhooks

Methods:

• client.webhooks.createStripe() -> PlainAPIResponse