Class: ModernTreasury::Models::BulkRequestListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::BulkRequestListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/bulk_request_list_params.rb

Overview

See Also:

• Resources::BulkRequests#list

Defined Under Namespace

Modules: ActionType, ResourceType, Status

Instance Attribute Summary

• #action_type ⇒ Symbol, ...

  One of create, or update.

• #after_cursor ⇒ String^?
• #metadata ⇒ Hash{Symbol=>String}^?

  For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`.

• #per_page ⇒ Integer^?
• #resource_type ⇒ Symbol, ...

  One of payment_order, expected_payment, or ledger_transaction.

• #status ⇒ Symbol, ...

  One of pending, processing, or completed.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see BulkRequestListParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::BulkRequestListParams for more details.

Parameters:

• action_type (Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType) (defaults to: nil) —

  One of create, or update.

• after_cursor (String, nil) (defaults to: nil)
• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  For example, if you want to query for records with metadata key ‘Type` and value

• per_page (Integer) (defaults to: nil)
• resource_type (Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType) (defaults to: nil) —

  One of payment_order, expected_payment, or ledger_transaction.

• status (Symbol, ModernTreasury::Models::BulkRequestListParams::Status) (defaults to: nil) —

  One of pending, processing, or completed.

• request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 46

Instance Attribute Details

#action_type ⇒ Symbol, ...

One of create, or update.

Returns:

• (Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType, nil)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 14

optional :action_type, enum: -> { ModernTreasury::BulkRequestListParams::ActionType }

#after_cursor ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 19

optional :after_cursor, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 27

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 32

optional :per_page, Integer

#resource_type ⇒ Symbol, ...

One of payment_order, expected_payment, or ledger_transaction.

Returns:

• (Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType, nil)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 38

optional :resource_type, enum: -> { ModernTreasury::BulkRequestListParams::ResourceType }

#status ⇒ Symbol, ...

One of pending, processing, or completed.

Returns:

• (Symbol, ModernTreasury::Models::BulkRequestListParams::Status, nil)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 44

optional :status, enum: -> { ModernTreasury::BulkRequestListParams::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/bulk_request_list_params.rb', line 72