Class: Increase::Models::EventSubscriptionCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: SelectedEventCategory, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(url:, oauth_connection_id: nil, selected_event_category: nil, shared_secret: nil, status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EventSubscriptionCreateParams for more details.

Parameters:

  • url (String) —

    The URL you’d like us to send webhooks to.

  • oauth_connection_id (String) (defaults to: nil) —

    If specified, this subscription will only receive webhooks for Events associated

  • selected_event_category (Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory) (defaults to: nil) —

    If specified, this subscription will only receive webhooks for Events with the s

  • shared_secret (String) (defaults to: nil) —

    The key that will be used to sign webhooks. If no value is passed, a random stri

  • status (Symbol, Increase::Models::EventSubscriptionCreateParams::Status) (defaults to: nil) —

    The status of the event subscription. Defaults to ‘active` if not specified.

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



# File 'lib/increase/models/event_subscription_create_params.rb', line 44

Instance Attribute Details

#oauth_connection_id ⇒ String?

If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection.

Returns:

  • (String, nil) 


21
 
# File 'lib/increase/models/event_subscription_create_params.rb', line 21

optional :oauth_connection_id, String

#selected_event_category ⇒ Symbol, ...

If specified, this subscription will only receive webhooks for Events with the specified ‘category`.

Returns:



28
29
 
# File 'lib/increase/models/event_subscription_create_params.rb', line 28

optional :selected_event_category,
enum: -> { Increase::EventSubscriptionCreateParams::SelectedEventCategory }

#shared_secret ⇒ String?

The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.

Returns:

  • (String, nil) 


36
 
# File 'lib/increase/models/event_subscription_create_params.rb', line 36

optional :shared_secret, String

#status ⇒ Symbol, ...

The status of the event subscription. Defaults to ‘active` if not specified.

Returns:



42
 
# File 'lib/increase/models/event_subscription_create_params.rb', line 42

optional :status, enum: -> { Increase::EventSubscriptionCreateParams::Status }

#url ⇒ String

The URL you’d like us to send webhooks to.

Returns:

  • (String) 


14
 
# File 'lib/increase/models/event_subscription_create_params.rb', line 14

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/event_subscription_create_params.rb', line 370