Class: ModernTreasury::Models::BulkRequest

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

Overview

See Also:

Defined Under Namespace

Modules: ActionType, ResourceType, 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(id:, action_type:, created_at:, failed_result_count:, live_mode:, metadata:, object:, resource_type:, status:, success_result_count:, total_resource_count:, updated_at:) ⇒ Object

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

Parameters:

  • id (String)
  • action_type (Symbol, ModernTreasury::Models::BulkRequest::ActionType) —

    One of create, or update.

  • created_at (Time)
  • failed_result_count (Integer) —

    Total number of failed bulk results so far for this request

  • live_mode (Boolean) —

    This field will be true if this object exists in the live environment or false i

  • metadata (Hash{Symbol=>String}) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • object (String)
  • resource_type (Symbol, ModernTreasury::Models::BulkRequest::ResourceType) —

    One of payment_order, expected_payment, or ledger_transaction.

  • status (Symbol, ModernTreasury::Models::BulkRequest::Status) —

    One of pending, processing, or completed.

  • success_result_count (Integer) —

    Total number of successful bulk results so far for this request

  • total_resource_count (Integer) —

    Total number of items in the ‘resources` array. Once a bulk request is completed

  • updated_at (Time) 



# File 'lib/modern_treasury/models/bulk_request.rb', line 79

Instance Attribute Details

#action_type ⇒ Symbol, ModernTreasury::Models::BulkRequest::ActionType

One of create, or update.

Returns:



16
 
# File 'lib/modern_treasury/models/bulk_request.rb', line 16

required :action_type, enum: -> { ModernTreasury::BulkRequest::ActionType }

#created_at ⇒ Time

Returns:

  • (Time) 


21
 
# File 'lib/modern_treasury/models/bulk_request.rb', line 21

required :created_at, Time

#failed_result_count ⇒ Integer

Total number of failed bulk results so far for this request

Returns:

  • (Integer) 


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

required :failed_result_count, Integer

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/bulk_request.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) 


34
 
# File 'lib/modern_treasury/models/bulk_request.rb', line 34

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

#metadata ⇒ Hash{Symbol=>String}

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}) 


41
 
# File 'lib/modern_treasury/models/bulk_request.rb', line 41

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

#object ⇒ String

Returns:

  • (String) 


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

required :object, String

#resource_type ⇒ Symbol, ModernTreasury::Models::BulkRequest::ResourceType

One of payment_order, expected_payment, or ledger_transaction.

Returns:



52
 
# File 'lib/modern_treasury/models/bulk_request.rb', line 52

required :resource_type, enum: -> { ModernTreasury::BulkRequest::ResourceType }

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

One of pending, processing, or completed.

Returns:



58
 
# File 'lib/modern_treasury/models/bulk_request.rb', line 58

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

#success_result_count ⇒ Integer

Total number of successful bulk results so far for this request

Returns:

  • (Integer) 


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

required :success_result_count, Integer

#total_resource_count ⇒ Integer

Total number of items in the ‘resources` array. Once a bulk request is completed, `success_result_count` + `failed_result_count` will be equal to `total_result_count`.

Returns:

  • (Integer) 


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

required :total_resource_count, Integer

#updated_at ⇒ Time

Returns:

  • (Time) 


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

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/bulk_request.rb', line 117