exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.File (exoapi_stripe v0.1.4)

description: This is an object representing a file hosted on Stripe's servers. The file may have been uploaded by yourself using the create file request (for example, when uploading dispute evidence) or it may have been created by Stripe (for example, the results of a Sigma scheduled query).

Related guide: File Upload Guide.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:expires_at :: :integer

The time at which the file expires and is no longer available in epoch seconds.

:filename :: :string

A filename for the file, suitable for saving to a filesystem.

:id :: :string

Unique identifier for the object.

::data :: ExOAPI.Stripe.Schemas.FileLink

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

:url :: :string

The URL where this list can be accessed.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:purpose :: :string

The purpose of the uploaded file.

:size :: :integer

The size in bytes of the file object.

:title :: :string

A user friendly title for the document.

:type :: :string

The type of the file returned (e.g., csv, pdf, jpg, or png).

:url :: :string

The URL from which the file can be downloaded using your live secret API key.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.File{
  created: integer() | nil,
  expires_at: integer() | nil,
  filename: String.t() | nil,
  id: String.t() | nil,
  links: map() | nil,
  object: :file | nil,
  purpose:
    (:tax_document_user_upload
     | :sigma_scheduled_query
     | :selfie
     | :pci_document
     | :identity_document_downloadable
     | :identity_document
     | :finance_report_run
     | :document_provider_identity_document
     | :dispute_evidence
     | :customer_signature
     | :business_logo
     | :business_icon
     | :additional_verification
     | :account_requirement)
    | nil,
  size: integer() | nil,
  title: String.t() | nil,
  type: String.t() | nil,
  url: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()