Class: HubSpotSDK::Models::Crm::Objects::Custom::BatchGetParams

Inherits:

BatchReadInputSimplePublicObjectID

• Object
• Internal::Type::BaseModel
• BatchReadInputSimplePublicObjectID
• HubSpotSDK::Models::Crm::Objects::Custom::BatchGetParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/hubspot_sdk/models/crm/objects/custom/batch_get_params.rb

Overview

See Also:

• Resources::Crm::Objects::Custom::Batch#get

Instance Attribute Summary

• #archived ⇒ Boolean^?

  Whether to return only results that have been archived.

• #object_type ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from BatchReadInputSimplePublicObjectID

#id_property, #inputs, #properties, #properties_with_history

Instance Method Summary

• #initialize(object_type:, archived: nil, request_options: {}) ⇒ Object constructor

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(object_type:, archived: nil, request_options: {}) ⇒ Object

Parameters:

• object_type (String)
• archived (Boolean) (defaults to: nil) —

  Whether to return only results that have been archived.

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

# File 'lib/hubspot_sdk/models/crm/objects/custom/batch_get_params.rb', line 24

Instance Attribute Details

#archived ⇒ Boolean^?

Whether to return only results that have been archived.

Returns:

• (Boolean, nil)

# File 'lib/hubspot_sdk/models/crm/objects/custom/batch_get_params.rb', line 22

optional :archived, HubSpotSDK::Internal::Type::Boolean

#object_type ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/objects/custom/batch_get_params.rb', line 16

required :object_type, String