Class: PostForMe::Models::AccountConfiguration::Configuration

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

Overview

See Also:

  • PostForMe::Models::AccountConfiguration#configuration

Defined Under Namespace

Modules: License, Placement, PrivacyStatus, ReplySettings, TrialReelType Classes: Localization

Instance Attribute Summary collapse

Class Method 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(description: nil, title: nil) ⇒ Object

Parameters:

  • description (String, nil) (defaults to: nil)
  • title (String, nil) (defaults to: nil) 



# File 'lib/post_for_me/models/account_configuration.rb', line 375

Instance Attribute Details

#allow_comment ⇒ Boolean?

Allow comments on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


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

optional :allow_comment, PostForMe::Internal::Type::Boolean, nil?: true

#allow_duet ⇒ Boolean?

Allow duets on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


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

optional :allow_duet, PostForMe::Internal::Type::Boolean, nil?: true

#allow_stitch ⇒ Boolean?

Allow stitch on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


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

optional :allow_stitch, PostForMe::Internal::Type::Boolean, nil?: true

#audio_name ⇒ String?

Display name for the audio track on Instagram Reels. Only honored on Reels uploads, and only when the audio is original (Meta silently ignores it on licensed/fingerprinted tracks).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/post_for_me/models/account_configuration.rb', line 61

optional :audio_name, String, nil?: true

#auto_add_music ⇒ Boolean?

Will automatically add music to photo posts on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


67
 
# File 'lib/post_for_me/models/account_configuration.rb', line 67

optional :auto_add_music, PostForMe::Internal::Type::Boolean, nil?: true

#board_ids ⇒ Array<String>?

Pinterest board IDs

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


73
 
# File 'lib/post_for_me/models/account_configuration.rb', line 73

optional :board_ids, PostForMe::Internal::Type::ArrayOf[String], nil?: true

#caption ⇒ Object?

Overrides the caption from the post

Parameters:

  • value (top, nil)

Returns:

  • (Object, nil) 


79
 
# File 'lib/post_for_me/models/account_configuration.rb', line 79

optional :caption, PostForMe::Internal::Type::Unknown, nil?: true

#category_id ⇒ String?

YouTube video category id (maps to snippet.categoryId; see YouTube Data API videoCategories.list)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


86
 
# File 'lib/post_for_me/models/account_configuration.rb', line 86

optional :category_id, String, nil?: true

#collaborators ⇒ Array<Array<Object>>?

List of page ids or users to invite as collaborators for a Video Reel (Instagram and Facebook)

Parameters:

  • value (::Array[::Array[top]], nil)

Returns:

  • (Array<Array<Object>>, nil) 


93
94
95
 
# File 'lib/post_for_me/models/account_configuration.rb', line 93

optional :collaborators,
PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]],
nil?: true

#community_id ⇒ String?

Id of the twitter community to post to

Parameters:

  • (String)

Returns:

  • (String, nil) 


101
 
# File 'lib/post_for_me/models/account_configuration.rb', line 101

optional :community_id, String

#contains_synthetic_media ⇒ Boolean?

If true, marks the YouTube video as containing altered or synthetic content per YouTube's disclosure policy. Sets status.containsSyntheticMedia on the videos.insert call; YouTube adds a "How this content was made" label to the description automatically.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


110
 
# File 'lib/post_for_me/models/account_configuration.rb', line 110

optional :contains_synthetic_media, PostForMe::Internal::Type::Boolean, nil?: true

#default_language ⇒ String?

Default language of the video (BCP-47 language tag, e.g. "en"). Maps to snippet.defaultLanguage.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


117
 
# File 'lib/post_for_me/models/account_configuration.rb', line 117

optional :default_language, String, nil?: true

#disclose_branded_content ⇒ Boolean?

Disclose branded content on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


123
 
# File 'lib/post_for_me/models/account_configuration.rb', line 123

optional :disclose_branded_content, PostForMe::Internal::Type::Boolean, nil?: true

#disclose_your_brand ⇒ Boolean?

Disclose your brand on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


129
 
# File 'lib/post_for_me/models/account_configuration.rb', line 129

optional :disclose_your_brand, PostForMe::Internal::Type::Boolean, nil?: true

#embeddable ⇒ Boolean?

If true the video can be embedded on other websites (maps to status.embeddable). Defaults to true.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


136
 
# File 'lib/post_for_me/models/account_configuration.rb', line 136

optional :embeddable, PostForMe::Internal::Type::Boolean, nil?: true

#is_ai_generated ⇒ Boolean?

Flag content as AI generated on TikTok

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


142
 
# File 'lib/post_for_me/models/account_configuration.rb', line 142

optional :is_ai_generated, PostForMe::Internal::Type::Boolean, nil?: true

#is_draft ⇒ Boolean?

Will create a draft upload to TikTok, posting will need to be completed from within the app

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


149
 
# File 'lib/post_for_me/models/account_configuration.rb', line 149

optional :is_draft, PostForMe::Internal::Type::Boolean, nil?: true

#license ⇒ Symbol, ...

The video's license (maps to status.license). "youtube" is the standard YouTube license; "creativeCommon" is Creative Commons.

Parameters:

  • value (PostForMe::Models::AccountConfiguration::Configuration::license, nil)

Returns:



156
 
# File 'lib/post_for_me/models/account_configuration.rb', line 156

optional :license, enum: -> { PostForMe::AccountConfiguration::Configuration::License }, nil?: true

#link ⇒ String?

Pinterest post link

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


162
 
# File 'lib/post_for_me/models/account_configuration.rb', line 162

optional :link, String, nil?: true

#localizations ⇒ Hash{Symbol=>PostForMe::Models::AccountConfiguration::Configuration::Localization}?

Per-language localizations for the video title and description. Keys are BCP-47 language tags (e.g. "fr", "es"). Maps to localizations on the YouTube Data API videos resource.

Parameters:

  • value (::Hash[Symbol, PostForMe::AccountConfiguration::Configuration::Localization], nil)

Returns:



31
32
33
34
35
 
# File 'lib/post_for_me/models/account_configuration.rb', line 31

required :localizations,
-> {
  PostForMe::Internal::Type::HashOf[PostForMe::AccountConfiguration::Configuration::Localization]
},
nil?: true

#location ⇒ String?

Page id with a location that you want to tag the image or video with (Instagram and Facebook)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


169
 
# File 'lib/post_for_me/models/account_configuration.rb', line 169

optional :location, String, nil?: true

#made_for_kids ⇒ Boolean?

If true will notify YouTube the video is intended for kids, defaults to false

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


175
 
# File 'lib/post_for_me/models/account_configuration.rb', line 175

optional :made_for_kids, PostForMe::Internal::Type::Boolean, nil?: true

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

Overrides the media from the post

Parameters:

Returns:



181
 
# File 'lib/post_for_me/models/account_configuration.rb', line 181

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

#placement ⇒ Symbol, ...

Post placement for Facebook/Instagram/Threads

Parameters:

  • value (PostForMe::Models::AccountConfiguration::Configuration::placement, nil)

Returns:



187
188
189
190
191
 
# File 'lib/post_for_me/models/account_configuration.rb', line 187

optional :placement,
enum: -> {
  PostForMe::AccountConfiguration::Configuration::Placement
},
nil?: true

#poll ⇒ PostForMe::Models::TwitterPoll?

Poll options for the twitter

Parameters:

Returns:



197
 
# File 'lib/post_for_me/models/account_configuration.rb', line 197

optional :poll, -> { PostForMe::TwitterPoll }

#privacy_status ⇒ Symbol, ...

Sets the privacy status for TikTok (private, public), or YouTube (private, public, unlisted)

Parameters:

  • value (PostForMe::Models::AccountConfiguration::Configuration::privacy_status, nil)

Returns:



204
205
206
 
# File 'lib/post_for_me/models/account_configuration.rb', line 204

optional :privacy_status,
enum: -> { PostForMe::AccountConfiguration::Configuration::PrivacyStatus },
nil?: true

#public_stats_viewable ⇒ Boolean?

If true, the extended video statistics are publicly viewable (maps to status.publicStatsViewable). Defaults to true.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


213
 
# File 'lib/post_for_me/models/account_configuration.rb', line 213

optional :public_stats_viewable, PostForMe::Internal::Type::Boolean, nil?: true

#publish_at ⇒ String?

ISO 8601 datetime at which the video should be published. Only honoured when privacy_status is "private" (maps to status.publishAt).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


220
 
# File 'lib/post_for_me/models/account_configuration.rb', line 220

optional :publish_at, String, nil?: true

#quote_tweet_id ⇒ String?

Id of the tweet you want to quote

Parameters:

  • (String)

Returns:

  • (String, nil) 


226
 
# File 'lib/post_for_me/models/account_configuration.rb', line 226

optional :quote_tweet_id, String

#recording_date ⇒ String?

ISO 8601 date (YYYY-MM-DD) or datetime when the video was recorded (maps to recordingDetails.recordingDate).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


233
 
# File 'lib/post_for_me/models/account_configuration.rb', line 233

optional :recording_date, String, nil?: true

#reply_settings ⇒ Symbol, ...

Who can reply to the tweet

Parameters:

  • value (PostForMe::Models::AccountConfiguration::Configuration::reply_settings, nil)

Returns:



239
240
241
 
# File 'lib/post_for_me/models/account_configuration.rb', line 239

optional :reply_settings,
enum: -> { PostForMe::AccountConfiguration::Configuration::ReplySettings },
nil?: true

#reshare_post_id ⇒ String?

LinkedIn UGC post id to reshare. The caption is used as the reshare commentary.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


247
 
# File 'lib/post_for_me/models/account_configuration.rb', line 247

optional :reshare_post_id, String, nil?: true

#set_caption_for_each_image ⇒ Boolean?

If true, include the caption on each image in a Facebook carousel upload; if false, only include it on the final carousel post

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


254
 
# File 'lib/post_for_me/models/account_configuration.rb', line 254

optional :set_caption_for_each_image, PostForMe::Internal::Type::Boolean, nil?: true

#share_to_feed ⇒ Boolean?

If false Instagram video posts will only be shown in the Reels tab

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


260
 
# File 'lib/post_for_me/models/account_configuration.rb', line 260

optional :share_to_feed, PostForMe::Internal::Type::Boolean, nil?: true

#tags ⇒ Array<String>?

YouTube video tags

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


266
 
# File 'lib/post_for_me/models/account_configuration.rb', line 266

optional :tags, PostForMe::Internal::Type::ArrayOf[String], nil?: true

#title ⇒ String?

Overrides the title from the post (Pinterest, TikTok, YouTube)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


272
 
# File 'lib/post_for_me/models/account_configuration.rb', line 272

optional :title, String, nil?: true

#trial_reel_type ⇒ Symbol, ...

Instagram trial reel type, when passed will be created as a trial reel. If manual the trial reel can be manually graduated in the native app. If perfomance the trial reel will be automatically graduated if the trial reel performs well.

Parameters:

  • value (PostForMe::Models::AccountConfiguration::Configuration::trial_reel_type, nil)

Returns:



280
281
282
 
# File 'lib/post_for_me/models/account_configuration.rb', line 280

optional :trial_reel_type,
enum: -> { PostForMe::AccountConfiguration::Configuration::TrialReelType },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/post_for_me/models/account_configuration.rb', line 390

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


186
 
# File 'sig/post_for_me/models/account_configuration.rbs', line 186

def to_hash: -> {