Class: Stripe::Identity::VerificationSession::ListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/identity/verification_session.rb

Defined Under Namespace

Classes: Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(client_reference_id: nil, created: nil, ending_before: nil, expand: nil, limit: nil, related_customer: nil, starting_after: nil, status: nil) ⇒ ListParams

Returns a new instance of ListParams.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 156

def initialize(
  client_reference_id: nil,
  created: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  related_customer: nil,
  starting_after: nil,
  status: nil
)
  @client_reference_id = client_reference_id
  @created = created
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @related_customer = related_customer
  @starting_after = starting_after
  @status = status
end

Instance Attribute Details

#client_reference_id ⇒ Object

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.



140
141
142
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 140

def client_reference_id
  @client_reference_id
end

#created ⇒ Object

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



142
143
144
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 142

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.



144
145
146
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 144

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



146
147
148
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 146

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.



148
149
150
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 148

def limit
  @limit
end

#related_customer ⇒ Object

Attribute for param field related_customer



150
151
152
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 150

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



152
153
154
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 152

def starting_after
  @starting_after
end

#status ⇒ Object

Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](stripe.com/docs/identity/how-sessions-work).



154
155
156
 
# File 'lib/stripe/resources/identity/verification_session.rb', line 154

def status
  @status
end