Struct ListFile

pub struct ListFile { /* private fields */ }

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

Implementations

impl ListFile

pub fn new() -> Self

Construct a new ListFile.

pub fn created(self, created: impl Into<RangeQueryTs>) -> Self

Only return files that were created during the given date interval.

pub fn ending_before(self, ending_before: impl Into<String>) -> Self

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn limit(self, limit: impl Into<i64>) -> Self

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

pub fn purpose(self, purpose: impl Into<FilePurpose>) -> Self

Filter queries by the file purpose. If you don’t provide a purpose, the queries return unfiltered files.

pub fn starting_after(self, starting_after: impl Into<String>) -> Self

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

impl ListFile

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

pub fn paginate(&self) -> ListPaginator<List<File>>

Trait Implementations

impl Clone for ListFile

fn clone(&self) -> ListFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListFile

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

Formats the value using the given formatter.

impl Default for ListFile

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ListFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for ListFile

type Output = List<File>

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.