Class: HubSpotSDK::Models::Crm::PublicImportResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Crm::PublicImportResponse

Defined in:

lib/hubspot_sdk/models/crm/public_import_response.rb

Overview

See Also:

• Resources::Crm::Imports#create

Defined Under Namespace

Modules: ImportSource, State

Instance Attribute Summary

• #created_at ⇒ Time

  The timestamp when the object was created, in ISO 8601 format.

• #id ⇒ String

  The unique identifier for this import.

• #import_name ⇒ String^?

  The user-provided name for this import.

• #import_request_json ⇒ Object^?

  The complete import request configuration as a JSON object.

• #import_source ⇒ Symbol, ...

  Indicates where/how the import was initiated.

• #import_template ⇒ HubSpotSDK::Models::Crm::ImportTemplate^?
• #mapped_object_type_ids ⇒ Array<String>
• #metadata ⇒ HubSpotSDK::Models::Crm::PublicImportMetadata
• #opt_out_import ⇒ Boolean

  Whether or not the import is a list of people disqualified from receiving emails.

• #state ⇒ Symbol, HubSpotSDK::Models::Crm::PublicImportResponse::State

  The status of the import.

• #updated_at ⇒ Time

  The timestamp when the import record was last updated, formatted as an ISO 8601 instant.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, created_at:, mapped_object_type_ids:, metadata:, opt_out_import:, state:, updated_at:, import_name: nil, import_request_json: nil, import_source: nil, import_template: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see PublicImportResponse for more details.

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:, created_at:, mapped_object_type_ids:, metadata:, opt_out_import:, state:, updated_at:, import_name: nil, import_request_json: nil, import_source: nil, import_template: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Crm::PublicImportResponse for more details.

Parameters:

• id (String) —

  The unique identifier for this import.

• created_at (Time) —

  The timestamp when the object was created, in ISO 8601 format.

• mapped_object_type_ids (Array<String>)
• metadata (HubSpotSDK::Models::Crm::PublicImportMetadata)
• opt_out_import (Boolean) —

  Whether or not the import is a list of people disqualified from receiving emails

• state (Symbol, HubSpotSDK::Models::Crm::PublicImportResponse::State) —

  The status of the import.

• updated_at (Time) —

  The timestamp when the import record was last updated, formatted as an ISO 8601

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

  The user-provided name for this import.

• import_request_json (Object) (defaults to: nil) —

  The complete import request configuration as a JSON object.

• import_source (Symbol, HubSpotSDK::Models::Crm::PublicImportResponse::ImportSource) (defaults to: nil) —

  Indicates where/how the import was initiated.

• import_template (HubSpotSDK::Models::Crm::ImportTemplate) (defaults to: nil)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 77

Instance Attribute Details

#created_at ⇒ Time

The timestamp when the object was created, in ISO 8601 format.

Returns:

• (Time)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 18

required :created_at, Time, api_name: :createdAt

#id ⇒ String

The unique identifier for this import.

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 12

required :id, String

#import_name ⇒ String^?

The user-provided name for this import.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 56

optional :import_name, String, api_name: :importName

#import_request_json ⇒ Object^?

The complete import request configuration as a JSON object.

Returns:

• (Object, nil)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 62

optional :import_request_json, HubSpotSDK::Internal::Type::Unknown, api_name: :importRequestJson

#import_source ⇒ Symbol, ...

Indicates where/how the import was initiated.

Returns:

• (Symbol, HubSpotSDK::Models::Crm::PublicImportResponse::ImportSource, nil)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 68

optional :import_source,
enum: -> { HubSpotSDK::Crm::PublicImportResponse::ImportSource },
api_name: :importSource

#import_template ⇒ HubSpotSDK::Models::Crm::ImportTemplate^?

Returns:

• (HubSpotSDK::Models::Crm::ImportTemplate, nil)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 75

optional :import_template, -> { HubSpotSDK::Crm::ImportTemplate }, api_name: :importTemplate

#mapped_object_type_ids ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 23

required :mapped_object_type_ids,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :mappedObjectTypeIds

#metadata ⇒ HubSpotSDK::Models::Crm::PublicImportMetadata

Returns:

• (HubSpotSDK::Models::Crm::PublicImportMetadata)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 30

required :metadata, -> { HubSpotSDK::Crm::PublicImportMetadata }

#opt_out_import ⇒ Boolean

Whether or not the import is a list of people disqualified from receiving emails.

Returns:

• (Boolean)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 37

required :opt_out_import, HubSpotSDK::Internal::Type::Boolean, api_name: :optOutImport

#state ⇒ Symbol, HubSpotSDK::Models::Crm::PublicImportResponse::State

The status of the import.

Returns:

• (Symbol, HubSpotSDK::Models::Crm::PublicImportResponse::State)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 43

required :state, enum: -> { HubSpotSDK::Crm::PublicImportResponse::State }

#updated_at ⇒ Time

The timestamp when the import record was last updated, formatted as an ISO 8601 instant.

Returns:

• (Time)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 50

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/crm/public_import_response.rb', line 117