api.md

AlbotAPISDK

Methods:

• client.get_root() -> object

Oauth2

Types:

from albot_api_sdk.types import PlainAPIResponse, URLAPIResponse

Methods:

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

Shards

Types:

from albot_api_sdk.types import (
    ShardListResponse,
    ShardAssignResponse,
    ShardGetConnectionCommandsResponse,
)

Methods:

• client.shards.list(**params) -> ShardListResponse
• client.shards.assign() -> ShardAssignResponse
• client.shards.get_connection_commands(shard_id, **params) -> ShardGetConnectionCommandsResponse
• client.shards.post_metrics(shard_id, **params) -> PlainAPIResponse
• client.shards.release(shard_id) -> PlainAPIResponse

Guilds

Types:

from albot_api_sdk.types import ListSubscriptions, GuildCreateConnectionStatesResponse

Methods:

• client.guilds.create(guild_id) -> PlainAPIResponse
• client.guilds.delete(guild_id) -> PlainAPIResponse
• client.guilds.create_connection_states(guild_id, **params) -> GuildCreateConnectionStatesResponse
• client.guilds.create_quick_report(guild_id, **params) -> PlainAPIResponse
• client.guilds.list_subscriptions(guild_id) -> ListSubscriptions

Dict

Types:

from albot_api_sdk.types.guilds import DictRetrieveResponse

Methods:

• client.guilds.dict.retrieve(guild_id) -> DictRetrieveResponse
• client.guilds.dict.delete(guild_id) -> PlainAPIResponse
• client.guilds.dict.replace(guild_id, **params) -> PlainAPIResponse

Settings

Types:

from albot_api_sdk.types.guilds import SettingRetrieveResponse

Methods:

• client.guilds.settings.retrieve(guild_id) -> SettingRetrieveResponse
• client.guilds.settings.update(guild_id, **params) -> PlainAPIResponse
• client.guilds.settings.delete(guild_id) -> PlainAPIResponse

CharacterUsage

Types:

from albot_api_sdk.types.guilds import (
    CharacterUsage,
    CharacterUsages,
    CharacterUsageRetrieveResponse,
)

Methods:

• client.guilds.character_usage.retrieve(guild_id) -> CharacterUsageRetrieveResponse
• client.guilds.character_usage.update(guild_id, **params) -> PlainAPIResponse

TrustedRoles

Types:

from albot_api_sdk.types.guilds import TrustedRoleListResponse

Methods:

• client.guilds.trusted_roles.update(guild_id, **params) -> PlainAPIResponse
• client.guilds.trusted_roles.list(guild_id) -> TrustedRoleListResponse

ConnectionCommand

Types:

from albot_api_sdk.types.guilds import ConnectionCommand, ConnectionCommandRetrieveResponse

Methods:

• client.guilds.connection_command.retrieve(guild_id) -> ConnectionCommandRetrieveResponse
• client.guilds.connection_command.update(guild_id, **params) -> PlainAPIResponse

MessageLinkExpandPreference

Types:

from albot_api_sdk.types.guilds import (
    MessageLinkExpandPreference,
    MessageLinkExpandPreferenceRetrieveResponse,
)

Methods:

• client.guilds.message_link_expand_preference.retrieve(guild_id) -> MessageLinkExpandPreferenceRetrieveResponse
• client.guilds.message_link_expand_preference.update(guild_id, **params) -> PlainAPIResponse

Users

Me

Types:

from albot_api_sdk.types.users import MeRetrieveInfoResponse

Methods:

• client.users.me.create_checkout_session(**params) -> URLAPIResponse
• client.users.me.retrieve_info() -> MeRetrieveInfoResponse

Subscriptions

Types:

from albot_api_sdk.types.users.me import SubscriptionActivate, SubscriptionRenew

Methods:

• client.users.me.subscriptions.list() -> ListSubscriptions
• client.users.me.subscriptions.activate(sub_id, **params) -> PlainAPIResponse
• client.users.me.subscriptions.cancel(sub_id) -> PlainAPIResponse
• client.users.me.subscriptions.renew(sub_id, **params) -> PlainAPIResponse

Guilds

Types:

from albot_api_sdk.types.users.me import PartialGuild, GuildListResponse, GuildRetrieveInfoResponse

Methods:

• client.users.me.guilds.list(**params) -> GuildListResponse
• client.users.me.guilds.retrieve_info(guild_id) -> GuildRetrieveInfoResponse

Subscriptions

Methods:

• client.users.subscriptions.list(user_id) -> ListSubscriptions
• client.users.subscriptions.activate(sub_id, *, user_id, **params) -> PlainAPIResponse
• client.users.subscriptions.cancel(sub_id, *, user_id) -> PlainAPIResponse
• client.users.subscriptions.renew(sub_id, *, user_id, **params) -> PlainAPIResponse

Metrics

Types:

from albot_api_sdk.types import MetricRetrieveResponse

Methods:

• client.metrics.retrieve() -> MetricRetrieveResponse

Webhooks

Methods:

• client.webhooks.create_stripe() -> PlainAPIResponse