Class: FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Constructor Details

#initialize(payment_id: , limit: nil, offset: nil) ⇒ Object

Parameters:

  • payment_id (String) (defaults to: ) —

    A stable Finch ‘id` (UUID v4) for a payment.

  • limit (Integer) (defaults to: nil) —

    Number of pay statements to return (defaults to all).

  • offset (Integer) (defaults to: nil) —

    Index to start from.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb', line 25

class Request < FinchAPI::Internal::Type::BaseModel
  # @!attribute payment_id
  #   A stable Finch `id` (UUID v4) for a payment.
  #
  #   @return [String]
  required :payment_id, String

  # @!attribute limit
  #   Number of pay statements to return (defaults to all).
  #
  #   @return [Integer, nil]
  optional :limit, Integer

  # @!attribute offset
  #   Index to start from.
  #
  #   @return [Integer, nil]
  optional :offset, Integer

  # @!method initialize(payment_id:, limit: nil, offset: nil)
  #   @param payment_id [String] A stable Finch `id` (UUID v4) for a payment.
  #
  #   @param limit [Integer] Number of pay statements to return (defaults to all).
  #
  #   @param offset [Integer] Index to start from.
end

Instance Attribute Details

#limit ⇒ Integer?

Number of pay statements to return (defaults to all).

Returns:

  • (Integer, nil) 


36
 
# File 'lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb', line 36

optional :limit, Integer

#offset ⇒ Integer?

Index to start from.

Returns:

  • (Integer, nil) 


42
 
# File 'lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb', line 42

optional :offset, Integer

#payment_id ⇒ String

A stable Finch ‘id` (UUID v4) for a payment.

Returns:

  • (String) 


30
 
# File 'lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb', line 30

required :payment_id, String