Class: ModernTreasury::Models::BulkResultListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/bulk_result_list_params.rb

Overview

See Also:

• Resources::BulkResults#list

Defined Under Namespace

Modules: EntityType, RequestType, Status

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #entity_id ⇒ String^?

  Unique identifier for the result entity object.

• #entity_type ⇒ Symbol, ...

  The type of the request that created this result.

• #per_page ⇒ Integer^?
• #request_id ⇒ String^?

  Unique identifier for the request that created this bulk result.

• #request_type ⇒ Symbol, ...

  The type of the request that created this result.

• #status ⇒ Symbol, ...

  One of successful or failed.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see BulkResultListParams 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(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

• after_cursor (String, nil) (defaults to: nil)
• entity_id (String) (defaults to: nil) —

  Unique identifier for the result entity object.

• entity_type (Symbol, ModernTreasury::Models::BulkResultListParams::EntityType) (defaults to: nil) —

  The type of the request that created this result. bulk_request is the only suppo

• per_page (Integer) (defaults to: nil)
• request_id (String) (defaults to: nil) —

  Unique identifier for the request that created this bulk result. This is the ID

• request_type (Symbol, ModernTreasury::Models::BulkResultListParams::RequestType) (defaults to: nil) —

  The type of the request that created this result. bulk_request is the only suppo

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

  One of successful or failed.

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

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 53

Instance Attribute Details

#after_cursor ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 13

optional :after_cursor, String, nil?: true

#entity_id ⇒ String^?

Unique identifier for the result entity object.

Returns:

• (String, nil)

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

optional :entity_id, String

#entity_type ⇒ Symbol, ...

The type of the request that created this result. bulk_request is the only supported ‘request_type`

Returns:

• (Symbol, ModernTreasury::Models::BulkResultListParams::EntityType, nil)

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 26

optional :entity_type, enum: -> { ModernTreasury::BulkResultListParams::EntityType }

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 31

optional :per_page, Integer

#request_id ⇒ String^?

Unique identifier for the request that created this bulk result. This is the ID of the bulk request when ‘request_type` is bulk_request

Returns:

• (String, nil)

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

optional :request_id, String

#request_type ⇒ Symbol, ...

The type of the request that created this result. bulk_request is the only supported ‘request_type`

Returns:

• (Symbol, ModernTreasury::Models::BulkResultListParams::RequestType, nil)

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 45

optional :request_type, enum: -> { ModernTreasury::BulkResultListParams::RequestType }

#status ⇒ Symbol, ...

One of successful or failed.

Returns:

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

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 51

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/bulk_result_list_params.rb', line 87