Class: PostForMe::Models::SocialPostResult

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/post_for_me/models/social_post_result.rb,
sig/post_for_me/models/social_post_result.rbs

Overview

See Also:

  • PostForMe::Resources::SocialPostResults#retrieve

Defined Under Namespace

Classes: PlatformData

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(id:, details:, error:, media:, platform_data:, post_id:, social_account_id:, success:) ⇒ Object

Parameters:

  • id (String) —

    The unique identifier of the post result

  • details (Object) —

    Detailed logs from the post

  • error (Object) —

    Error message if the post failed

  • media (Array<PostForMe::Models::SocialPostMedia>, nil) —

    Array of media URLs associated with the post

  • platform_data (PostForMe::Models::SocialPostResult::PlatformData) —

    Platform-specific data

  • post_id (String) —

    The ID of the associated post

  • social_account_id (String) —

    The ID of the associated social account

  • success (Boolean) —

    Indicates if the post was successful




# File 'lib/post_for_me/models/social_post_result.rb', line 55

Instance Attribute Details

#details ⇒ Object

Detailed logs from the post

Parameters:

  • value (top)

Returns:

  • (Object) 


17
 
# File 'lib/post_for_me/models/social_post_result.rb', line 17

required :details, PostForMe::Internal::Type::Unknown

#error ⇒ Object

Error message if the post failed

Parameters:

  • value (top)

Returns:

  • (Object) 


23
 
# File 'lib/post_for_me/models/social_post_result.rb', line 23

required :error, PostForMe::Internal::Type::Unknown

#id ⇒ String

The unique identifier of the post result

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/post_for_me/models/social_post_result.rb', line 11

required :id, String

#media ⇒ Array<PostForMe::Models::SocialPostMedia>?

Array of media URLs associated with the post

Parameters:

Returns:



29
 
# File 'lib/post_for_me/models/social_post_result.rb', line 29

required :media, -> { PostForMe::Internal::Type::ArrayOf[PostForMe::SocialPostMedia] }, nil?: true

#platform_data ⇒ PostForMe::Models::SocialPostResult::PlatformData

Platform-specific data

Parameters:

  • value (PostForMe::SocialPostResult::PlatformData)

Returns:



35
 
# File 'lib/post_for_me/models/social_post_result.rb', line 35

required :platform_data, -> { PostForMe::SocialPostResult::PlatformData }

#post_id ⇒ String

The ID of the associated post

Parameters:

  • value (String)

Returns:

  • (String) 


41
 
# File 'lib/post_for_me/models/social_post_result.rb', line 41

required :post_id, String

#social_account_id ⇒ String

The ID of the associated social account

Parameters:

  • value (String)

Returns:

  • (String) 


47
 
# File 'lib/post_for_me/models/social_post_result.rb', line 47

required :social_account_id, String

#success ⇒ Boolean

Indicates if the post was successful

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


53
 
# File 'lib/post_for_me/models/social_post_result.rb', line 53

required :success, PostForMe::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


43
 
# File 'sig/post_for_me/models/social_post_result.rbs', line 43

def to_hash: -> {