Class: Stripe::FileService::CreateParams::FileLinkData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/file_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(create: nil, expires_at: nil, metadata: nil) ⇒ FileLinkData

Returns a new instance of FileLinkData.



63
64
65
66
67
 
# File 'lib/stripe/services/file_service.rb', line 63

def initialize(create: nil, expires_at: nil, metadata: nil)
  @create = create
  @expires_at = expires_at
  @metadata = metadata
end

Instance Attribute Details

#create ⇒ Object

Set this to ‘true` to create a file link for the newly created file. Creating a link is only possible when the file’s ‘purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.



57
58
59
 
# File 'lib/stripe/services/file_service.rb', line 57

def create
  @create
end

#expires_at ⇒ Object

The link isn’t available after this future timestamp.



59
60
61
 
# File 'lib/stripe/services/file_service.rb', line 59

def expires_at
  @expires_at
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



61
62
63
 
# File 'lib/stripe/services/file_service.rb', line 61

def metadata
  @metadata
end