Class: Stripe::FileCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/file_create_params.rb

Defined Under Namespace

Classes: FileLinkData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil) ⇒ FileCreateParams

Returns a new instance of FileCreateParams.



29
30
31
32
33
34
 
# File 'lib/stripe/params/file_create_params.rb', line 29

def initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil)
  @expand = expand
  @file = file
  @file_link_data = file_link_data
  @purpose = purpose
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



21
22
23
 
# File 'lib/stripe/params/file_create_params.rb', line 21

def expand
  @expand
end

#file ⇒ Object

A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the ‘multipart/form-data` protocol.



23
24
25
 
# File 'lib/stripe/params/file_create_params.rb', line 23

def file
  @file
end

#file_link_data ⇒ Object

Optional parameters that automatically create a [file link](stripe.com/docs/api#file_links) for the newly created file.



25
26
27
 
# File 'lib/stripe/params/file_create_params.rb', line 25

def file_link_data
  @file_link_data
end

#purpose ⇒ Object

The [purpose](stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.



27
28
29
 
# File 'lib/stripe/params/file_create_params.rb', line 27

def purpose
  @purpose
end