Class: Increase::Models::EventSubscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/event_subscription.rb

Overview

See Also:

Defined Under Namespace

Modules: SelectedEventCategory, Status, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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: , created_at: , idempotency_key: , oauth_connection_id: , selected_event_category: , status: , type: , url: ) ⇒ Object

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

Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](increase.com/documentation/webhooks).

Parameters:

  • id (String) (defaults to: ) —

    The event subscription identifier.

  • created_at (Time) (defaults to: ) —

    The time the event subscription was created.

  • idempotency_key (String, nil) (defaults to: ) —

    The idempotency key you chose for this object. This value is unique across Incre

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

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

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

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

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

    This indicates if we’ll send notifications to this subscription.

  • type (Symbol, Increase::Models::EventSubscription::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘

  • url (String) (defaults to: ) —

    The webhook url where we’ll send notifications.




# File 'lib/increase/models/event_subscription.rb', line 62

Instance Attribute Details

#created_at ⇒ Time

The time the event subscription was created.

Returns:

  • (Time) 


17
 
# File 'lib/increase/models/event_subscription.rb', line 17

required :created_at, Time

#id ⇒ String

The event subscription identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/event_subscription.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


25
 
# File 'lib/increase/models/event_subscription.rb', line 25

required :idempotency_key, String, nil?: true

#oauth_connection_id ⇒ String?

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

Returns:

  • (String, nil) 


32
 
# File 'lib/increase/models/event_subscription.rb', line 32

required :oauth_connection_id, String, nil?: true

#selected_event_category ⇒ Symbol, ...

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

Returns:



39
40
41
 
# File 'lib/increase/models/event_subscription.rb', line 39

required :selected_event_category,
enum: -> { Increase::EventSubscription::SelectedEventCategory },
nil?: true

#status ⇒ Symbol, Increase::Models::EventSubscription::Status

This indicates if we’ll send notifications to this subscription.

Returns:



47
 
# File 'lib/increase/models/event_subscription.rb', line 47

required :status, enum: -> { Increase::EventSubscription::Status }

#type ⇒ Symbol, Increase::Models::EventSubscription::Type

A constant representing the object’s type. For this resource it will always be ‘event_subscription`.

Returns:



54
 
# File 'lib/increase/models/event_subscription.rb', line 54

required :type, enum: -> { Increase::EventSubscription::Type }

#url ⇒ String

The webhook url where we’ll send notifications.

Returns:

  • (String) 


60
 
# File 'lib/increase/models/event_subscription.rb', line 60

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/event_subscription.rb', line 398