Class: Stripe::V2::Core::EventDestination

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/core/event_destination.rb

Overview

Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints and Amazon EventBridge. Event destinations support receiving thin events and snapshot events.

Defined Under Namespace

Classes: AmazonEventbridge, StatusDetails, WebhookEndpoint

Constant Summary collapse

OBJECT_NAME = 
"v2.core.event_destination"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amazon_eventbridge ⇒ Object (readonly)

Amazon EventBridge configuration.



71
72
73
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 71

def amazon_eventbridge
  @amazon_eventbridge
end

#created ⇒ Object (readonly)

Time at which the object was created.



73
74
75
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 73

def created
  @created
end

#description ⇒ Object (readonly)

An optional description of what the event destination is used for.



75
76
77
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 75

def description
  @description
end

#enabled_events ⇒ Object (readonly)

The list of events to enable for this endpoint.



77
78
79
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 77

def enabled_events
  @enabled_events
end

#event_payload ⇒ Object (readonly)

Payload type of events being subscribed to.



79
80
81
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 79

def event_payload
  @event_payload
end

#events_from ⇒ Object (readonly)

Specifies which accounts' events route to this destination. @self: Receive events from the account that owns the event destination. @accounts: Receive events emitted from other accounts you manage which includes your v1 and v2 accounts. @organization_members: Receive events from accounts directly linked to the organization. @organization_members/@accounts: Receive events from all accounts connected to any platform accounts in the organization.



85
86
87
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 85

def events_from
  @events_from
end

#id ⇒ Object (readonly)

Unique identifier for the object.



87
88
89
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 87

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.



89
90
91
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 89

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Metadata.



91
92
93
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 91

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Event destination name.



93
94
95
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 93

def name
  @name
end

#object ⇒ Object (readonly)

String representing the object's type. Objects of the same type share the same value of the object field.



95
96
97
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 95

def object
  @object
end

#snapshot_api_version ⇒ Object (readonly)

If using the snapshot event payload, the API version events are rendered as.



97
98
99
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 97

def snapshot_api_version
  @snapshot_api_version
end

#status ⇒ Object (readonly)

Status. It can be set to either enabled or disabled.



99
100
101
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 99

def status
  @status
end

#status_details ⇒ Object (readonly)

Additional information about event destination status.



101
102
103
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 101

def status_details
  @status_details
end

#type ⇒ Object (readonly)

Event destination type.



103
104
105
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 103

def type
  @type
end

#updated ⇒ Object (readonly)

Time at which the object was last updated.



105
106
107
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 105

def updated
  @updated
end

#webhook_endpoint ⇒ Object (readonly)

Webhook endpoint configuration.



107
108
109
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 107

def webhook_endpoint
  @webhook_endpoint
end

Class Method Details

.field_remappings ⇒ Object 



117
118
119
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 117

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 109

def self.inner_class_types
  @inner_class_types = {
    amazon_eventbridge: AmazonEventbridge,
    status_details: StatusDetails,
    webhook_endpoint: WebhookEndpoint,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/core/event_destination.rb', line 10

def self.object_name
  "v2.core.event_destination"
end