Class: NgrokAPI::Services::EventDestinationsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::EventDestinationsClient
- Defined in:
- lib/ngrokapi/services/event_destinations_client.rb
Overview
Constant Summary collapse
- PATH =
The API path for the requests
'/event_destinations'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'event_destinations'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination
Create a new Event Destination.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Destination.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Destination.
-
#get(id: "") ⇒ NgrokAPI::Models::EventDestination
Get detailed information about an Event Destination by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::EventDestination
Get detailed information about an Event Destination by ID.
-
#initialize(client:) ⇒ EventDestinationsClient
constructor
A new instance of EventDestinationsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Event Destinations on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Event Destinations on this account.
-
#update(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination
Update attributes of an Event Destination.
-
#update!(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination
Update attributes of an Event Destination.
Constructor Details
#initialize(client:) ⇒ EventDestinationsClient
Returns a new instance of EventDestinationsClient.
15 16 17 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 15 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
13 14 15 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 13 def client @client end |
Instance Method Details
#create(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination
Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.
31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 31 def create(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil) path = '/event_destinations' replacements = { } data = {} data[:metadata] = if data[:description] = description if description data[:format] = format if format data[:target] = target if target result = @client.post(path % replacements, data: data) NgrokAPI::Models::EventDestination.new(client: self, result: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
52 53 54 55 56 57 58 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 52 def delete(id: "") path = '/event_destinations/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription. Throws an exception if API error.
69 70 71 72 73 74 75 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 69 def delete!(id: "") path = '/event_destinations/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::EventDestination
Get detailed information about an Event Destination by ID.
84 85 86 87 88 89 90 91 92 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 84 def get(id: "") path = '/event_destinations/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::EventDestination.new(client: self, result: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::EventDestination
Get detailed information about an Event Destination by ID. Throws an exception if API error.
102 103 104 105 106 107 108 109 110 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 102 def get!(id: "") path = '/event_destinations/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::EventDestination.new(client: self, result: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Event Destinations on this account.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 121 def list(before_id: nil, limit: nil, url: nil) result = @client.list( before_id: before_id, limit: limit, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, result: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::EventDestination ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Event Destinations on this account. Throws an exception if API error.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 148 def list!(before_id: nil, limit: nil, url: nil) result = @client.list( before_id: before_id, limit: limit, danger: true, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, result: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::EventDestination, danger: true ) end |
#update(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination
Update attributes of an Event Destination.
178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 178 def update(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) path = '/event_destinations/%{id}' replacements = { id: id, } data = {} data[:metadata] = if data[:description] = description if description data[:format] = format if format data[:target] = target if target result = @client.patch(path % replacements, data: data) NgrokAPI::Models::EventDestination.new(client: self, result: result) end |
#update!(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination
Update attributes of an Event Destination. Throws an exception if API error.
204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 204 def update!(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) path = '/event_destinations/%{id}' replacements = { id: id, } data = {} data[:metadata] = if data[:description] = description if description data[:format] = format if format data[:target] = target if target result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::EventDestination.new(client: self, result: result) end |