Class: XTwitterScraper::Models::IntegrationUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/integration_update_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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:, event_types: nil, filters: nil, is_active: nil, message_template: nil, name: nil, scope_all_monitors: nil, silent_push: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String)
  • event_types (Array<Symbol, XTwitterScraper::Models::EventType>) (defaults to: nil) —

    Array of event types to subscribe to.

  • filters (Hash{Symbol=>Object}) (defaults to: nil) —

    Event filter rules (JSON)

  • is_active (Boolean) (defaults to: nil)
  • message_template (Hash{Symbol=>Object}) (defaults to: nil) —

    Custom message template (JSON)

  • name (String) (defaults to: nil)
  • scope_all_monitors (Boolean) (defaults to: nil)
  • silent_push (Boolean) (defaults to: nil)
  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 57

Instance Attribute Details

#event_types ⇒ Array<Symbol, XTwitterScraper::Models::EventType>?

Array of event types to subscribe to.

Returns:



19
20
21
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 19

optional :event_types,
-> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
api_name: :eventTypes

#filters ⇒ Hash{Symbol=>Object}?

Event filter rules (JSON)

Returns:

  • (Hash{Symbol=>Object}, nil) 


27
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 27

optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 13

required :id, String

#is_active ⇒ Boolean?

Returns:

  • (Boolean, nil) 


32
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 32

optional :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive

#message_template ⇒ Hash{Symbol=>Object}?

Custom message template (JSON)

Returns:

  • (Hash{Symbol=>Object}, nil) 


38
39
40
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 38

optional :message_template,
XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown],
api_name: :messageTemplate

#name ⇒ String?

Returns:

  • (String, nil) 


45
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 45

optional :name, String

#scope_all_monitors ⇒ Boolean?

Returns:

  • (Boolean, nil) 


50
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 50

optional :scope_all_monitors, XTwitterScraper::Internal::Type::Boolean, api_name: :scopeAllMonitors

#silent_push ⇒ Boolean?

Returns:

  • (Boolean, nil) 


55
 
# File 'lib/x_twitter_scraper/models/integration_update_params.rb', line 55

optional :silent_push, XTwitterScraper::Internal::Type::Boolean, api_name: :silentPush