api.md

Shared Types

from linq.types import (
    ChatHandle,
    LinkPartResponse,
    MediaPartResponse,
    Reaction,
    ReactionType,
    ServiceType,
    TextDecoration,
    TextPartResponse,
)

Chats

Types:

from linq.types import (
    Chat,
    LinkPart,
    MediaPart,
    MessageContent,
    TextPart,
    ChatCreateResponse,
    ChatUpdateResponse,
    ChatLeaveChatResponse,
    ChatSendVoicememoResponse,
)

Methods:

• client.chats.create(**params) -> ChatCreateResponse
• client.chats.retrieve(chat_id) -> Chat
• client.chats.update(chat_id, **params) -> ChatUpdateResponse
• client.chats.leave_chat(chat_id) -> ChatLeaveChatResponse
• client.chats.list_chats(**params) -> SyncListChatsPagination[Chat]
• client.chats.mark_as_read(chat_id) -> None
• client.chats.send_voicememo(chat_id, **params) -> ChatSendVoicememoResponse
• client.chats.share_contact_card(chat_id) -> None

Participants

Types:

from linq.types.chats import ParticipantAddResponse, ParticipantRemoveResponse

Methods:

• client.chats.participants.add(chat_id, **params) -> ParticipantAddResponse
• client.chats.participants.remove(chat_id, **params) -> ParticipantRemoveResponse

Typing

Methods:

• client.chats.typing.start(chat_id) -> None
• client.chats.typing.stop(chat_id) -> None

Messages

Types:

from linq.types.chats import SentMessage, MessageSendResponse

Methods:

• client.chats.messages.list(chat_id, **params) -> SyncListMessagesPagination[Message]
• client.chats.messages.send(chat_id, **params) -> MessageSendResponse

Location

Types:

from linq.types.chats import GetChatLocationResponse, LocationRequestResponse

Methods:

• client.chats.location.retrieve(chat_id) -> GetChatLocationResponse
• client.chats.location.request(chat_id) -> LocationRequestResponse

Messages

Types:

from linq.types import (
    Message,
    MessageEffect,
    ReplyTo,
    MessageCreateResponse,
    MessageAddReactionResponse,
    MessageUpdateAppCardResponse,
)

Methods:

• client.messages.create(**params) -> MessageCreateResponse
• client.messages.retrieve(message_id) -> Message
• client.messages.update(message_id, **params) -> Message
• client.messages.delete(message_id) -> None
• client.messages.add_reaction(message_id, **params) -> MessageAddReactionResponse
• client.messages.list_messages_thread(message_id, **params) -> SyncListMessagesPagination[Message]
• client.messages.update_app_card(message_id, **params) -> MessageUpdateAppCardResponse

Attachments

Types:

from linq.types import SupportedContentType, AttachmentCreateResponse, AttachmentRetrieveResponse

Methods:

• client.attachments.create(**params) -> AttachmentCreateResponse
• client.attachments.retrieve(attachment_id) -> AttachmentRetrieveResponse
• client.attachments.delete(attachment_id) -> None

Phonenumbers

Types:

from linq.types import PhonenumberListResponse

Methods:

• client.phonenumbers.list() -> PhonenumberListResponse

PhoneNumbers

Types:

from linq.types import PhoneNumberUpdateResponse, PhoneNumberListResponse

Methods:

• client.phone_numbers.update(phone_number_id, **params) -> PhoneNumberUpdateResponse
• client.phone_numbers.list() -> PhoneNumberListResponse

AvailableNumber

Types:

from linq.types import AvailableNumberRetrieveResponse

Methods:

• client.available_number.retrieve(**params) -> AvailableNumberRetrieveResponse

WebhookEvents

Types:

from linq.types import WebhookEventType, WebhookEventListResponse

Methods:

• client.webhook_events.list() -> WebhookEventListResponse

WebhookSubscriptions

Types:

from linq.types import (
    WebhookSubscription,
    WebhookSubscriptionCreateResponse,
    WebhookSubscriptionListResponse,
)

Methods:

• client.webhook_subscriptions.create(**params) -> WebhookSubscriptionCreateResponse
• client.webhook_subscriptions.retrieve(subscription_id) -> WebhookSubscription
• client.webhook_subscriptions.update(subscription_id, **params) -> WebhookSubscription
• client.webhook_subscriptions.list() -> WebhookSubscriptionListResponse
• client.webhook_subscriptions.delete(subscription_id) -> None

Capability

Types:

from linq.types import HandleCheck, HandleCheckResponse

Methods:

• client.capability.check_i_message(**params) -> HandleCheckResponse
• client.capability.check_RCS(**params) -> HandleCheckResponse

Webhooks

Types:

from linq.types import (
    MessageEventV2,
    MessagePayload,
    ReactionEventBase,
    SchemasMediaPartResponse,
    SchemasMessageEffect,
    SchemasTextPartResponse,
    MessageSentWebhookEvent,
    MessageReceivedWebhookEvent,
    MessageReadWebhookEvent,
    MessageDeliveredWebhookEvent,
    MessageFailedWebhookEvent,
    MessageEditedWebhookEvent,
    ReactionAddedWebhookEvent,
    ReactionRemovedWebhookEvent,
    ParticipantAddedWebhookEvent,
    ParticipantRemovedWebhookEvent,
    ChatCreatedWebhookEvent,
    ChatGroupNameUpdatedWebhookEvent,
    ChatGroupIconUpdatedWebhookEvent,
    ChatGroupNameUpdateFailedWebhookEvent,
    ChatGroupIconUpdateFailedWebhookEvent,
    ChatTypingIndicatorStartedWebhookEvent,
    ChatTypingIndicatorStoppedWebhookEvent,
    PhoneNumberStatusUpdatedWebhookEvent,
    UnwrapWebhookEvent,
)

ContactCard

Types:

from linq.types import SetContactCard, ContactCardRetrieveResponse

Methods:

• client.contact_card.create(**params) -> SetContactCard
• client.contact_card.retrieve(**params) -> ContactCardRetrieveResponse
• client.contact_card.update(**params) -> SetContactCard