Class: ModernTreasury::Models::BulkResult

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/bulk_result.rb

Overview

See Also:

Defined Under Namespace

Modules: Entity, EntityType, RequestType, Status

Instance Attribute Summary collapse

Class Method 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_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(code: nil, message: nil, parameter: nil) ⇒ Object

Parameters:

  • code (String) (defaults to: nil)
  • message (String) (defaults to: nil)
  • parameter (String) (defaults to: nil) 



# File 'lib/modern_treasury/models/bulk_result.rb', line 84

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


15
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 15

required :created_at, Time

#entity ⇒ ModernTreasury::Models::PaymentOrder, ...

An object with type as indicated by ‘entity_type`. This is the result object that is generated by performing the requested action on the provided input `request_params`.

Returns:



23
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 23

required :entity, union: -> { ModernTreasury::BulkResult::Entity }

#entity_id ⇒ String

Unique identifier for the result entity object.

Returns:

  • (String) 


29
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 29

required :entity_id, String

#entity_type ⇒ Symbol, ModernTreasury::Models::BulkResult::EntityType

The type of the result entity object. For a successful bulk result, this is the same as the ‘resource_type` of the bulk request. For a failed bulk result, this is always bulk_error

Returns:



37
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 37

required :entity_type, enum: -> { ModernTreasury::BulkResult::EntityType }

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 10

required :id, String

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean) 


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

required :live_mode, ModernTreasury::Internal::Type::Boolean

#object ⇒ String

Returns:

  • (String) 


49
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 49

required :object, String

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


56
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 56

required :request_id, String

#request_params ⇒ Hash{Symbol=>String}?

An optional object that contains the provided input params for the request that created this result. This is an item in the ‘resources` array for the bulk_request

Returns:

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


64
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 64

required :request_params, ModernTreasury::Internal::Type::HashOf[String], nil?: true

#request_type ⇒ Symbol, ModernTreasury::Models::BulkResult::RequestType

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

Returns:



71
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 71

required :request_type, enum: -> { ModernTreasury::BulkResult::RequestType }

#status ⇒ Symbol, ModernTreasury::Models::BulkResult::Status

One of successful or failed.

Returns:



77
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 77

required :status, enum: -> { ModernTreasury::BulkResult::Status }

#updated_at ⇒ Time

Returns:

  • (Time) 


82
 
# File 'lib/modern_treasury/models/bulk_result.rb', line 82

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/bulk_result.rb', line 226

.variants ⇒ Array(ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::LedgerAccount, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError)

Returns:




# File 'lib/modern_treasury/models/bulk_result.rb', line 205