Class: Stripe::FileLinkListParams

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

Defined Under Namespace

Classes: Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, ending_before: nil, expand: nil, expired: nil, file: nil, limit: nil, starting_after: nil) ⇒ FileLinkListParams

Returns a new instance of FileLinkListParams.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/stripe/params/file_link_list_params.rb', line 38

def initialize(
  created: nil,
  ending_before: nil,
  expand: nil,
  expired: nil,
  file: nil,
  limit: nil,
  starting_after: nil
)
  @created = created
  @ending_before = ending_before
  @expand = expand
  @expired = expired
  @file = file
  @limit = limit
  @starting_after = starting_after
end

Instance Attribute Details

#created ⇒ Object

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



24
25
26
 
# File 'lib/stripe/params/file_link_list_params.rb', line 24

def created
  @created
end

#ending_before ⇒ Object

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.



26
27
28
 
# File 'lib/stripe/params/file_link_list_params.rb', line 26

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



28
29
30
 
# File 'lib/stripe/params/file_link_list_params.rb', line 28

def expand
  @expand
end

#expired ⇒ Object

Filter links by their expiration status. By default, Stripe returns all links.



30
31
32
 
# File 'lib/stripe/params/file_link_list_params.rb', line 30

def expired
  @expired
end

#file ⇒ Object

Only return links for the given file.



32
33
34
 
# File 'lib/stripe/params/file_link_list_params.rb', line 32

def file
  @file
end

#limit ⇒ Object

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



34
35
36
 
# File 'lib/stripe/params/file_link_list_params.rb', line 34

def limit
  @limit
end

#starting_after ⇒ Object

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.



36
37
38
 
# File 'lib/stripe/params/file_link_list_params.rb', line 36

def starting_after
  @starting_after
end