View Source Hellosign.File (hellosign_ex v0.1.4)
Summary
Types
@type data_uri_response() :: %{data_uri: String.t()}
@type download_criteria() :: atom()
The Download file criteria type
An atom representing the criteria to download the file Enum:
:default => This will return the binary of the requested file
:file_url => This will return the file url of the requested file
:data_uri => This will return the encode64 data_uri of the requested file
@type download_params() :: %{ optional(:file_type) => String.t(), optional(:force_download) => non_neg_integer() }
The download file params type
The fields are:
file_type
- Allows requester to specify the file type (see list of allowed types)Enum: "pdf" "zip" default: "pdf"
force_download
- Allows requester to specify wheather browser will download the file and save it locally. When set to 0 the file will be displayed in the browser. (see list of allowed types)Enum: 0 1 default: 1
@type download_path_type() :: String.t()
The Download file path type
A string representing the signature request id to download the file
@type file_url_response() :: %{expires_at: non_neg_integer(), file_url: String.t()}
Functions
@spec download( download_criteria(), download_path_type(), download_params(), Hellosign.Config.t() ) :: {:ok, bitstring() | data_uri_response() | file_url_response()} | {:error, map()}