Struct stripe::FileLink

pub struct FileLink {
    pub id: FileLinkId,
    pub created: Timestamp,
    pub expired: bool,
    pub expires_at: Option<Box<Timestamp>>,
    pub file: Expandable<File>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub url: Option<Box<String>>,
}

The resource representing a Stripe “FileLink”.

For more details see https://stripe.com/docs/api/file_links/object

Fields

id: FileLinkId

Unique identifier for the object.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

expired: bool

Whether this link is already expired.

expires_at: Option<Box<Timestamp>>

Time at which the link expires.

file: Expandable<File>

The file object this link points to.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Metadata

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format.

url: Option<Box<String>>

The publicly accessible URL to download the file.

Implementations

impl FileLink

pub fn list(
    client: &Client,
    params: ListFileLinks<'_>
) -> Response<List<FileLink>>

Returns a list of file links.

pub fn create(client: &Client, params: CreateFileLink<'_>) -> Response<FileLink>

Creates a new file link object.

pub fn retrieve(
    client: &Client,
    id: &FileLinkId,
    expand: &[&str]
) -> Response<FileLink>

Retrieves the file link with the given ID.

pub fn update(
    client: &Client,
    id: &FileLinkId,
    params: UpdateFileLink<'_>
) -> Response<FileLink>

Updates an existing file link object.

Expired links can no longer be updated.

Trait Implementations

impl Clone for FileLink

fn clone(&self) -> FileLink

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileLink

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileLink

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for FileLink

type Id = FileLinkId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for FileLink

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.