Class: ContextDev::Models::BrandIdentifyFromTransactionParams

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

Overview

See Also:

Defined Under Namespace

Modules: CountryGl, ForceLanguage

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(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::BrandIdentifyFromTransactionParams for more details.

Parameters:

  • transaction_info (String) —

    Transaction information to identify the brand

  • city (String) (defaults to: nil) —

    Optional city name to prioritize when searching for the brand.

  • country_gl (Symbol, ContextDev::Models::BrandIdentifyFromTransactionParams::CountryGl) (defaults to: nil) —

    Optional country code (GL parameter) to specify the country. This affects the ge

  • force_language (Symbol, ContextDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage) (defaults to: nil) —

    Optional parameter to force the language of the retrieved brand data.

  • high_confidence_only (Boolean) (defaults to: nil) —

    When set to true, the API will perform an additional verification steps to ensur

  • max_speed (Boolean) (defaults to: nil) —

    Optional parameter to optimize the API call for maximum speed. When set to true,

  • mcc (String) (defaults to: nil) —

    Optional Merchant Category Code (MCC) to help identify the business category/ind

  • phone (Float) (defaults to: nil) —

    Optional phone number from the transaction to help verify brand match.

  • timeout_ms (Integer) (defaults to: nil) —

    Optional timeout in milliseconds for the request. If the request takes longer th

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



# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 71

Instance Attribute Details

#city ⇒ String?

Optional city name to prioritize when searching for the brand.

Returns:

  • (String, nil) 


20
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 20

optional :city, String

#country_gl ⇒ Symbol, ...

Optional country code (GL parameter) to specify the country. This affects the geographic location used for search queries.

Returns:



27
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 27

optional :country_gl, enum: -> { ContextDev::BrandIdentifyFromTransactionParams::CountryGl }

#force_language ⇒ Symbol, ...

Optional parameter to force the language of the retrieved brand data.

Returns:



33
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 33

optional :force_language, enum: -> { ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage }

#high_confidence_only ⇒ Boolean?

When set to true, the API will perform an additional verification steps to ensure the identified brand matches the transaction with high confidence.

Returns:

  • (Boolean, nil) 


40
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 40

optional :high_confidence_only, ContextDev::Internal::Type::Boolean

#max_speed ⇒ Boolean?

Optional parameter to optimize the API call for maximum speed. When set to true, the API will skip time-consuming operations for faster response at the cost of less comprehensive data.

Returns:

  • (Boolean, nil) 


48
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 48

optional :max_speed, ContextDev::Internal::Type::Boolean

#mcc ⇒ String?

Optional Merchant Category Code (MCC) to help identify the business category/industry.

Returns:

  • (String, nil) 


55
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 55

optional :mcc, String

#phone ⇒ Float?

Optional phone number from the transaction to help verify brand match.

Returns:

  • (Float, nil) 


61
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 61

optional :phone, Float

#timeout_ms ⇒ Integer?

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Returns:

  • (Integer, nil) 


69
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 69

optional :timeout_ms, Integer

#transaction_info ⇒ String

Transaction information to identify the brand

Returns:

  • (String) 


14
 
# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 14

required :transaction_info, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/context_dev/models/brand_identify_from_transaction_params.rb', line 340