Class: PostForMe::Models::SocialPostResultListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• PostForMe::Models::SocialPostResultListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/post_for_me/models/social_post_result_list_params.rb,
sig/post_for_me/models/social_post_result_list_params.rbs

Overview

See Also:

• PostForMe::Resources::SocialPostResults#list

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::PostForMe

Instance Attribute Summary

• #limit ⇒ Float^?

  Number of items to return.

• #offset ⇒ Float^?

  Number of items to skip.

• #platform ⇒ Array<String>^?

  Filter by platform(s).

• #post_id ⇒ Array<String>^?

  Filter by post IDs.

• #social_account_id ⇒ Array<String>^?

  Filter by social account ID(s).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(limit: nil, offset: nil, platform: nil, post_id: nil, social_account_id: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(limit: nil, offset: nil, platform: nil, post_id: nil, social_account_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see PostForMe::Models::SocialPostResultListParams for more details.

Parameters:

• limit (Float) (defaults to: nil) —

  Number of items to return

• offset (Float) (defaults to: nil) —

  Number of items to skip

• platform (Array<String>) (defaults to: nil) —

  Filter by platform(s). Multiple values imply OR logic (e.g., ?platform=x&platfor

• post_id (Array<String>) (defaults to: nil) —

  Filter by post IDs. Multiple values imply OR logic (e.g., ?post_id=123&post_id=4

• social_account_id (Array<String>) (defaults to: nil) —

  Filter by social account ID(s). Multiple values imply OR logic (e.g., ?social_ac

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

# File 'lib/post_for_me/models/social_post_result_list_params.rb', line 43

Instance Attribute Details

#limit ⇒ Float^?

Number of items to return

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/post_for_me/models/social_post_result_list_params.rb', line 14

optional :limit, Float

#offset ⇒ Float^?

Number of items to skip

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/post_for_me/models/social_post_result_list_params.rb', line 20

optional :offset, Float

#platform ⇒ Array<String>^?

Filter by platform(s). Multiple values imply OR logic (e.g., ?platform=x&platform=facebook).

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/post_for_me/models/social_post_result_list_params.rb', line 27

optional :platform, PostForMe::Internal::Type::ArrayOf[String]

#post_id ⇒ Array<String>^?

Filter by post IDs. Multiple values imply OR logic (e.g., ?post_id=123&post_id=456).

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/post_for_me/models/social_post_result_list_params.rb', line 34

optional :post_id, PostForMe::Internal::Type::ArrayOf[String]

#social_account_id ⇒ Array<String>^?

Filter by social account ID(s). Multiple values imply OR logic (e.g., ?social_account_id=123&social_account_id=456).

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

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

optional :social_account_id, PostForMe::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/post_for_me/models/social_post_result_list_params.rbs', line 46

def to_hash: -> {