Class: PostForMe::Models::WebhookListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• PostForMe::Resources::Webhooks#list

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::PostForMe

Instance Attribute Summary

• #event_type ⇒ Array<String>^?

  Filter by event type(s).

• #id ⇒ Array<String>^?

  Filter by id(s).

• #limit ⇒ Float^?

  Number of items to return.

• #offset ⇒ Float^?

  Number of items to skip.

• #url ⇒ Array<String>^?

  Filter by url(s).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id: nil, event_type: nil, limit: nil, offset: nil, url: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebhookListParams 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(id: nil, event_type: nil, limit: nil, offset: nil, url: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Filter by id(s). Multiple values imply OR logic (e.g., ?id=wbh_xxxxxx&id=wbh_yyy

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

  Filter by event type(s). Multiple values imply OR logic (e.g., ?event_type=socia

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

  Number of items to return

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

  Number of items to skip

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

  Filter by url(s). Multiple values imply OR logic (e.g., ?url=https://example.com

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

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

Instance Attribute Details

#event_type ⇒ Array<String>^?

Filter by event type(s). Multiple values imply OR logic (e.g., ?event_type=social.post.created&event_type=social.post.updated).

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/post_for_me/models/webhook_list_params.rb', line 22

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

#id ⇒ Array<String>^?

Filter by id(s). Multiple values imply OR logic (e.g., ?id=wbh_xxxxxx&id=wbh_yyyyyy).

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/post_for_me/models/webhook_list_params.rb', line 15

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

#limit ⇒ Float^?

Number of items to return

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/post_for_me/models/webhook_list_params.rb', line 28

optional :limit, Float

#offset ⇒ Float^?

Number of items to skip

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :offset, Float

#url ⇒ Array<String>^?

Filter by url(s). Multiple values imply OR logic (e.g., ?url=https://example.com&url=https://postforme.dev).

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

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

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {