Skip to content

Request Types

filesender.request_types.File

Bases: TypedDict

cid instance-attribute 

cid: NotRequired[str]

mime_type instance-attribute 

mime_type: NotRequired[str]

name instance-attribute 

name: str

size instance-attribute 

size: int

filesender.request_types.TransferOptions

Bases: TypedDict

add_me_to_recipients instance-attribute 

add_me_to_recipients: bool

collection instance-attribute 

collection: bool

email_daily_statistics instance-attribute 

email_daily_statistics: bool

email_download_complete instance-attribute 

email_download_complete: bool

email_me_copies instance-attribute 

email_me_copies: bool

email_me_on_expire instance-attribute 

email_me_on_expire: bool

email_recipient_when_transfer_expires instance-attribute 

email_recipient_when_transfer_expires: bool

email_report_on_closing instance-attribute 

email_report_on_closing: bool

email_upload_complete instance-attribute 

email_upload_complete: bool

enable_recipient_email_download_complete instance-attribute 

enable_recipient_email_download_complete: bool

encryption instance-attribute 

encryption: bool

get_a_link: bool

hide_sender_email instance-attribute 

hide_sender_email: bool

must_be_logged_in_to_download instance-attribute 

must_be_logged_in_to_download: bool

redirect_url_on_complete instance-attribute 

redirect_url_on_complete: str

storage_cloud_s3_bucket instance-attribute 

storage_cloud_s3_bucket: bool

verify_email_to_download instance-attribute 

verify_email_to_download: bool

web_notification_when_upload_is_complete instance-attribute 

web_notification_when_upload_is_complete: bool

filesender.request_types.PartialTransfer module-attribute 

PartialTransfer = TypedDict(
    "PartialTransfer",
    {
        "options": NotRequired[TransferOptions],
        "expires": NotRequired[int],
        "subject": NotRequired[str],
        "message": NotRequired[str],
        "recipients": NotRequired[List[str]],
        "from": NotRequired[str],
    },
)

filesender.request_types.Transfer

Bases: PartialTransfer

files instance-attribute 

files: List[File]

filesender.request_types.TransferUpdate

Bases: TypedDict

closed instance-attribute 

closed: NotRequired[bool]

complete instance-attribute 

complete: NotRequired[bool]

extend_expiry_date instance-attribute 

extend_expiry_date: NotRequired[bool]

remind instance-attribute 

remind: NotRequired[bool]

filesender.request_types.FileUpdate

Bases: TypedDict

complete instance-attribute 

complete: NotRequired[bool]

filesender.request_types.GuestOptions

Bases: TypedDict

can_only_send_to_me instance-attribute 

can_only_send_to_me: bool

email_guest_created instance-attribute 

email_guest_created: bool

email_guest_created_receipt instance-attribute 

email_guest_created_receipt: bool

email_guest_expired instance-attribute 

email_guest_expired: bool

email_upload_page_access instance-attribute 

email_upload_page_access: bool

email_upload_started instance-attribute 

email_upload_started: bool

valid_only_one_time instance-attribute 

valid_only_one_time: bool

filesender.request_types.GuestAllOptions

Bases: TypedDict

guest instance-attribute 

guest: NotRequired[GuestOptions]

transfer instance-attribute 

transfer: NotRequired[TransferOptions]

filesender.request_types.Guest module-attribute 

Guest = TypedDict(
    "Guest",
    {
        "recipient": str,
        "from": str,
        "subject": NotRequired[str],
        "message": NotRequired[str],
        "options": NotRequired[GuestAllOptions],
        "expires": NotRequired[int],
    },
)