Class: HubSpotSDK::Models::Files::FolderActionResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/files/folder_action_response.rb

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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(completed_at:, started_at:, status:, task_id:, errors: nil, links: nil, num_errors: nil, requested_at: nil, result: nil) ⇒ Object

Parameters:

  • completed_at (Time) —

    When the requested changes have been completed.

  • started_at (Time) —

    Timestamp representing when the task was started at.

  • status (Symbol, HubSpotSDK::Models::Files::FolderActionResponse::Status) —

    Current status of the task.

  • task_id (String) —

    ID of the task.

  • errors (Array<HubSpotSDK::Models::StandardError>) (defaults to: nil) —

    Detailed errors resulting from the task.

  • links (Hash{Symbol=>String}) (defaults to: nil) —

    Link to check the status of the task.

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

    Number of errors resulting from the requested changes.

  • requested_at (Time) (defaults to: nil) —

    Timestamp representing when the task was requested.

  • result (HubSpotSDK::Models::Files::Folder) (defaults to: nil) 



# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 60

Instance Attribute Details

#completed_at ⇒ Time

When the requested changes have been completed.

Returns:

  • (Time) 


11
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 11

required :completed_at, Time, api_name: :completedAt

#errors ⇒ Array<HubSpotSDK::Models::StandardError>?

Detailed errors resulting from the task.

Returns:



35
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 35

optional :errors, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::StandardError] }

#links ⇒ Hash{Symbol=>String}?

Link to check the status of the task.

Returns:

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


41
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 41

optional :links, HubSpotSDK::Internal::Type::HashOf[String]

#num_errors ⇒ Integer?

Number of errors resulting from the requested changes.

Returns:

  • (Integer, nil) 


47
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 47

optional :num_errors, Integer, api_name: :numErrors

#requested_at ⇒ Time?

Timestamp representing when the task was requested.

Returns:

  • (Time, nil) 


53
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 53

optional :requested_at, Time, api_name: :requestedAt

#result ⇒ HubSpotSDK::Models::Files::Folder?

Returns:



58
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 58

optional :result, -> { HubSpotSDK::Files::Folder }

#started_at ⇒ Time

Timestamp representing when the task was started at.

Returns:

  • (Time) 


17
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 17

required :started_at, Time, api_name: :startedAt

#status ⇒ Symbol, HubSpotSDK::Models::Files::FolderActionResponse::Status

Current status of the task.

Returns:



23
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 23

required :status, enum: -> { HubSpotSDK::Files::FolderActionResponse::Status }

#task_id ⇒ String

ID of the task.

Returns:

  • (String) 


29
 
# File 'lib/hubspot_sdk/models/files/folder_action_response.rb', line 29

required :task_id, String, api_name: :taskId