1. class
  2. Bulldog
  3. \
  4. Strype
  5. \
  6. Resources
  7. \
  8. File

File

class File extends Resource implements FileInterface

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).

Traits

Retrieve
Retrieve.
ListAll
List All.

Properties

string $id A unique identifier for the resource. from Resource
protected mixed $response A response from Stripe. from Resource

Methods

string
getId()

Returns the unique identifier for this resource.

from Resource
mixed
getResponse()

Returns the raw Stripe response.

from Resource
void
setProperties()

Set the response data as properties on the class.

from Resource
Retrieve
retrieve(string $id)

Get a resource by the ID.

from Retrieve
ListAll
listAll(array $arguments = [])

List all the resources.

from ListAll
FileInterface
create(FileTypeInterface $file, array $arguments = [], string $key = null)

Create a file.

void
stripe(string $method, $arguments, string $idempotencyKey = null)

No description

Details

in Resource at line 29
string getId()

Returns the unique identifier for this resource.

Return Value

string

in Resource at line 39
mixed getResponse()

Returns the raw Stripe response.

Return Value

mixed

in Resource at line 47
protected void setProperties()

Set the response data as properties on the class.

Return Value

void

in Retrieve at line 17
Retrieve retrieve(string $id)

Get a resource by the ID.

Parameters

string $id

Return Value

Retrieve

in ListAll at line 21
ListAll listAll(array $arguments = [])

List all the resources.

This will list all of the resources from which this trait belongs to. It will then return itself, so you can method chain it, or reuse the same instantiation.

Parameters

array $arguments

Return Value

ListAll

at line 34
FileInterface create(FileTypeInterface $file, array $arguments = [], string $key = null)

Create a file.

Parameters

FileTypeInterface $file
array $arguments
string $key

Return Value

FileInterface

See also

at line 44
protected void stripe(string $method, $arguments, string $idempotencyKey = null)

Parameters

string $method
$arguments
string $idempotencyKey

Return Value

void