Class: ContextDev::Models::IndustryRetrieveSicParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::IndustryRetrieveSicParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/context_dev/models/industry_retrieve_sic_params.rb

Overview

See Also:

• Resources::Industry#retrieve_sic

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #input ⇒ String

  Brand domain or title to retrieve SIC code for.

• #max_results ⇒ Integer^?

  Maximum number of SIC codes to return.

• #min_results ⇒ Integer^?

  Minimum number of SIC codes to return.

• #timeout_ms ⇒ Integer^?

  Optional timeout in milliseconds for the request.

• #type ⇒ Symbol, ...

  Which SIC dataset to classify against.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see IndustryRetrieveSicParams 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(input:, max_results: nil, min_results: nil, timeout_ms: nil, type: nil, request_options: {}) ⇒ Object

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

Parameters:

• input (String) —

  Brand domain or title to retrieve SIC code for. If a valid domain is provided, i

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

  Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.

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

  Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.

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

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

• type (Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type) (defaults to: nil) —

  Which SIC dataset to classify against. ‘original_sic` uses the 1987 Standard Ind

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

# File 'lib/context_dev/models/industry_retrieve_sic_params.rb', line 46

Instance Attribute Details

#input ⇒ String

Brand domain or title to retrieve SIC code for. If a valid domain is provided, it will be used for classification, otherwise, we will search for the brand using the provided title.

Returns:

• (String)

# File 'lib/context_dev/models/industry_retrieve_sic_params.rb', line 16

required :input, String

#max_results ⇒ Integer^?

Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/industry_retrieve_sic_params.rb', line 22

optional :max_results, Integer

#min_results ⇒ Integer^?

Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/industry_retrieve_sic_params.rb', line 28

optional :min_results, Integer

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

# File 'lib/context_dev/models/industry_retrieve_sic_params.rb', line 36

optional :timeout_ms, Integer

#type ⇒ Symbol, ...

Which SIC dataset to classify against. ‘original_sic` uses the 1987 Standard Industrial Classification system; `latest_sec` uses the current SIC list as published by the SEC. Defaults to `original_sic`.

Returns:

• (Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil)

# File 'lib/context_dev/models/industry_retrieve_sic_params.rb', line 44

optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }