Class: PostForMe::Models::SocialPostListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• PostForMe::Resources::SocialPosts#list

Defined Under Namespace

Modules: Platform, Status

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::PostForMe

Instance Attribute Summary

• #external_id ⇒ Array<String>^?

  Filter by external ID.

• #limit ⇒ Float^?

  Number of items to return.

• #offset ⇒ Float^?

  Number of items to skip.

• #platform ⇒ Array<Symbol, PostForMe::Models::SocialPostListParams::Platform>^?

  Filter by platforms.

• #social_account_id ⇒ Array<String>^?

  Filter by social account ID.

• #status ⇒ Array<Symbol, PostForMe::Models::SocialPostListParams::Status>^?

  Filter by post status.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #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 ⇒ Object

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

def initialize: (

Instance Attribute Details

#external_id ⇒ Array<String>^?

Filter by external ID. Multiple values imply OR logic.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

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

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

#limit ⇒ Float^?

Number of items to return

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :limit, Float

#offset ⇒ Float^?

Number of items to skip

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/post_for_me/models/social_post_list_params.rb', line 26

optional :offset, Float

#platform ⇒ Array<Symbol, PostForMe::Models::SocialPostListParams::Platform>^?

Filter by platforms. Multiple values imply OR logic.

Returns:

• (Array<Symbol, PostForMe::Models::SocialPostListParams::Platform>, nil)

# File 'lib/post_for_me/models/social_post_list_params.rb', line 32

optional :platform,
-> { PostForMe::Internal::Type::ArrayOf[enum: PostForMe::SocialPostListParams::Platform] }

#social_account_id ⇒ Array<String>^?

Filter by social account ID. Multiple values imply OR logic.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/post_for_me/models/social_post_list_params.rb', line 39

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

#status ⇒ Array<Symbol, PostForMe::Models::SocialPostListParams::Status>^?

Filter by post status. Multiple values imply OR logic.

Returns:

• (Array<Symbol, PostForMe::Models::SocialPostListParams::Status>, nil)

# File 'lib/post_for_me/models/social_post_list_params.rb', line 45

optional :status, -> { PostForMe::Internal::Type::ArrayOf[enum: PostForMe::SocialPostListParams::Status] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/post_for_me/models/social_post_list_params.rb', line 75

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/post_for_me/models/social_post_list_params.rbs', line 56

def to_hash: -> {