Class: ModernTreasury::Models::BulkRequestCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/bulk_request_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: ActionType, Resource, ResourceType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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: , resource_type: , resources: , metadata: nil, request_options: {}) ⇒ Object

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

Parameters:




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

Instance Attribute Details

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

One of create, or update.

Returns:



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

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

#metadata ⇒ Hash{Symbol=>String}?

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

Returns:

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


35
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 35

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

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

One of payment_order, expected_payment, or ledger_transaction.

Returns:



20
 
# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 20

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

#resources ⇒ Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::LedgerTransactionCreateRequest, ModernTreasury::Models::LedgerAccountCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>

An array of objects where each object contains the input params for a single ‘action_type` request on a `resource_type` resource

Returns:



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

required :resources,
-> { ModernTreasury::Internal::Type::ArrayOf[union: ModernTreasury::BulkRequestCreateParams::Resource] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/bulk_request_create_params.rb', line 59