api.md

Shared Types

from wootiv.types import AuditDto, ReferenceIDDto

Root

Methods:

• client.root.retrieve() -> None

Auth

Types:

from wootiv.types import (
    AuthLoginResponse,
    AuthSignupResponse,
    AuthVerifyBillingResponse,
)

Methods:

• client.auth.login(**params) -> AuthLoginResponse
• client.auth.signup(**params) -> AuthSignupResponse
• client.auth.verify_billing(**params) -> AuthVerifyBillingResponse

Token

Types:

from wootiv.types.auth import TokenRefreshResponse

Methods:

• client.auth.token.refresh(**params) -> TokenRefreshResponse

Recovery

Login

Methods:

• client.auth.recovery.login.create(**params) -> None

Password

Methods:

• client.auth.recovery.password.create(**params) -> None
• client.auth.recovery.password.update(**params) -> None

Passcode

Methods:

• client.auth.recovery.passcode.retrieve(passcode) -> None

Space

Members

Methods:

• client.space.members.retrieve(space_id, member_uid) -> None
• client.space.members.list(space_id) -> None

Tokens

Types:

from wootiv.types.space import TokenCreateResponse, TokenListResponse

Methods:

• client.space.tokens.create(space_sid, **params) -> TokenCreateResponse
• client.space.tokens.list(space_sid) -> TokenListResponse
• client.space.tokens.delete(space_sid, token_id) -> None

Wspaces

Types:

from wootiv.types import WorkspaceDto

Methods:

• client.wspaces.create(**params) -> WorkspaceDto
• client.wspaces.retrieve(id, **params) -> WorkspaceDto
• client.wspaces.update(path_id, **params) -> WorkspaceDto

Roles

Types:

from wootiv.types import (
    RoleDto,
    RolePaginatedDto,
    RoleListResponse,
    RoleDeleteResponse,
    RoleBulkCreateResponse,
)

Methods:

• client.roles.create(**params) -> RoleDto
• client.roles.retrieve(id, **params) -> RoleDto
• client.roles.update(id, **params) -> RoleDto
• client.roles.list(**params) -> RoleListResponse
• client.roles.delete(id) -> object
• client.roles.bulk_create(**params) -> RoleBulkCreateResponse

RoleAssignments

Types:

from wootiv.types import RoleAssignment, RoleAssignmentDto, RoleAssignmentPaginatedDto

Methods:

• client.role_assignments.create(assignment, **params) -> RoleAssignmentDto
• client.role_assignments.retrieve(assignment, id, **params) -> RoleAssignmentDto
• client.role_assignments.delete(assignment, id) -> object

Bulk

Types:

from wootiv.types.role_assignments import BulkCreateResponse

Methods:

• client.role_assignments.bulk.create(assignment, **params) -> BulkCreateResponse

Invitations

Types:

from wootiv.types import (
    InvitationDto,
    InvitationPaginatedDto,
    InvitationListResponse,
    InvitationDeleteResponse,
)

Methods:

• client.invitations.create(**params) -> InvitationDto
• client.invitations.retrieve(id, **params) -> InvitationDto
• client.invitations.list(**params) -> InvitationListResponse
• client.invitations.delete(id) -> object

InvitationAcceptance

Methods:

• client.invitation_acceptance.retrieve(code, **params) -> None
• client.invitation_acceptance.update(code, **params) -> None

InvitationReattempt

Methods:

• client.invitation_reattempt.create(code) -> None

Users

Types:

from wootiv.types import UserDto, UserPaginatedDto, UserListResponse

Methods:

• client.users.retrieve(id, **params) -> UserDto
• client.users.list(**params) -> UserListResponse

Recover

Types:

from wootiv.types.users import UserRecover

Methods:

• client.users.recover.update(id) -> object

Aws

Types:

from wootiv.types import AwsS3GetSignedURLResponse, AwsS3SignedURLPostSerialization

Methods:

• client.aws.create_signed_put_url(**params) -> AwsS3GetSignedURLResponse

Buckets

Types:

from wootiv.types.aws import (
    AwsS3GetManyBucketsSerialization,
    AwsS3GetOneBucketObjectResponse,
    AwsS3Serialization,
    BucketBulkUploadResponse,
)

Methods:

• client.aws.buckets.list() -> AwsS3GetManyBucketsSerialization
• client.aws.buckets.bulk_upload(**params) -> BucketBulkUploadResponse
• client.aws.buckets.retrieve_file(filename) -> AwsS3GetOneBucketObjectResponse
• client.aws.buckets.retrieve_file_in_path(pathname, filename) -> AwsS3GetOneBucketObjectResponse
• client.aws.buckets.upload(**params) -> AwsS3Serialization

Health

Methods:

• client.aws.buckets.health.retrieve() -> None

Objects

Methods:

• client.aws.objects.list() -> None

Registry

Resources

Methods:

• client.registry.resources.list() -> None

Actions

Methods:

• client.registry.actions.list() -> None

Features

Methods:

• client.features.list(**params) -> None

Subscriptions

Types:

from wootiv.types import SubscriptionDto

Methods:

• client.subscriptions.create(**params) -> SubscriptionDto
• client.subscriptions.retrieve(id, **params) -> SubscriptionDto
• client.subscriptions.update(path_id, **params) -> SubscriptionDto

Change

Methods:

• client.subscriptions.change.update(path_id, **params) -> SubscriptionDto

Contacts

Types:

from wootiv.types import (
    PaginatedContactDto,
    ReadContactDto,
    ContactListResponse,
    ContactDeleteResponse,
)

Methods:

• client.contacts.create(**params) -> ReadContactDto
• client.contacts.retrieve(id, **params) -> ReadContactDto
• client.contacts.update(id, **params) -> ReadContactDto
• client.contacts.list(**params) -> ContactListResponse
• client.contacts.delete(id) -> object

ContactGroup

Types:

from wootiv.types import (
    PaginatedContactGroupDto,
    ReadContactGroupDto,
    ContactGroupListResponse,
    ContactGroupDeleteResponse,
)

Methods:

• client.contact_group.create(**params) -> ReadContactGroupDto
• client.contact_group.retrieve(id, **params) -> ReadContactGroupDto
• client.contact_group.update(id, **params) -> ReadContactGroupDto
• client.contact_group.list(**params) -> ContactGroupListResponse
• client.contact_group.delete(id) -> object

Mailbox

Types:

from wootiv.types import (
    PaginatedPipelineDto,
    ReadPipelineDto,
    MailboxListResponse,
    MailboxDeleteResponse,
)

Methods:

• client.mailbox.create(**params) -> ReadPipelineDto
• client.mailbox.retrieve(id, **params) -> ReadPipelineDto
• client.mailbox.update(id) -> ReadPipelineDto
• client.mailbox.list(**params) -> MailboxListResponse
• client.mailbox.delete(id) -> object
• client.mailbox.check_availability(**params) -> None

Registry

Types:

from wootiv.types.mailbox import MailboxRegistryQueryDto, PaginatedMailboxRegistry

Methods:

• client.mailbox.registry.retrieve(id, **params) -> PaginatedMailboxRegistry

Action

Types:

from wootiv.types.mailbox.registry import ActionCreateResponse

Methods:

• client.mailbox.registry.action.create(id, **params) -> ActionCreateResponse
• client.mailbox.registry.action.retrieve(id, **params) -> PaginatedMailboxRegistry

Resource

Types:

from wootiv.types.mailbox.registry import ResourceCreateResponse

Methods:

• client.mailbox.registry.resource.create(id, **params) -> ResourceCreateResponse
• client.mailbox.registry.resource.retrieve(id, **params) -> PaginatedMailboxRegistry

Stream

Types:

from wootiv.types.mailbox import (
    QueryStreamDto,
    StreamCreateResponse,
    StreamRetrieveResponse,
)

Methods:

• client.mailbox.stream.create(id, slug, **params) -> StreamCreateResponse
• client.mailbox.stream.retrieve(id, slug) -> StreamRetrieveResponse

Registry

Types:

from wootiv.types.mailbox.stream import StreamRegistryQueryDto

Methods:

• client.mailbox.stream.registry.retrieve(id, slug, **params) -> PaginatedStreamRegistry

Action

Types:

from wootiv.types.mailbox.stream.registry import OneStreamRegistryAction

Methods:

• client.mailbox.stream.registry.action.create(id, slug, **params) -> OneStreamRegistryAction
• client.mailbox.stream.registry.action.retrieve(id, slug, **params) -> PaginatedStreamRegistry

Resource

Types:

from wootiv.types.mailbox.stream.registry import PaginatedStreamRegistry

Methods:

• client.mailbox.stream.registry.resource.create(id, slug, **params) -> OneStreamRegistryAction
• client.mailbox.stream.registry.resource.retrieve(id, slug, **params) -> PaginatedStreamRegistry

Inbound

Mail

Methods:

• client.inbound.mail.create(**params) -> None