Class: Stripe::Tax::Form::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/tax/form.rb

Defined Under Namespace

Classes: Payee

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(ending_before: nil, expand: nil, limit: nil, payee: nil, starting_after: nil, type: nil) ⇒ ListParams

Returns a new instance of ListParams.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/stripe/resources/tax/form.rb', line 121

def initialize(
  ending_before: nil,
  expand: nil,
  limit: nil,
  payee: nil,
  starting_after: nil,
  type: nil
)
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @payee = payee
  @starting_after = starting_after
  @type = type
end

Instance Attribute Details

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



109
110
111
 
# File 'lib/stripe/resources/tax/form.rb', line 109

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



111
112
113
 
# File 'lib/stripe/resources/tax/form.rb', line 111

def expand
  @expand
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.



113
114
115
 
# File 'lib/stripe/resources/tax/form.rb', line 113

def limit
  @limit
end

#payee ⇒ Object

The payee whose volume is represented on the tax form.



115
116
117
 
# File 'lib/stripe/resources/tax/form.rb', line 115

def payee
  @payee
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.



117
118
119
 
# File 'lib/stripe/resources/tax/form.rb', line 117

def starting_after
  @starting_after
end

#type ⇒ Object

An optional filter on the list, based on the object ‘type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.



119
120
121
 
# File 'lib/stripe/resources/tax/form.rb', line 119

def type
  @type
end