Class: NgrokAPI::Services::EventSourcesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::EventSourcesClient
- Defined in:
- lib/ngrokapi/services/event_sources_client.rb
Overview
Constant Summary collapse
- PATH =
The API path for the requests
'/event_subscriptions/%{subscription_id}/sources'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(subscription_id: "", type: "", filter: "", fields: []) ⇒ NgrokAPI::Models::EventSource
Add an additional type for which this event subscription will trigger.
-
#create!(subscription_id: "", type: "", filter: "", fields: []) ⇒ NgrokAPI::Models::EventSource
Add an additional type for which this event subscription will trigger Throws an exception if API error.
-
#delete(subscription_id: "", type: "") ⇒ NgrokAPI::Models::Empty
Remove a type for which this event subscription will trigger.
-
#delete!(subscription_id: "", type: "") ⇒ NgrokAPI::Models::Empty
Remove a type for which this event subscription will trigger Throws an exception if API error.
-
#get(subscription_id: "", type: "") ⇒ NgrokAPI::Models::EventSource
Get the details for a given type that triggers for the given event subscription.
-
#get!(subscription_id: "", type: "") ⇒ NgrokAPI::Models::EventSource
Get the details for a given type that triggers for the given event subscription Throws an exception if API error.
-
#initialize(client:) ⇒ EventSourcesClient
constructor
A new instance of EventSourcesClient.
-
#list(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList
List the types for which this event subscription will trigger.
-
#list!(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList
List the types for which this event subscription will trigger Throws an exception if API error.
-
#update(subscription_id: "", type: "", filter: nil, fields: nil) ⇒ NgrokAPI::Models::EventSource
Update the type for which this event subscription will trigger.
-
#update!(subscription_id: "", type: "", filter: nil, fields: nil) ⇒ NgrokAPI::Models::EventSource
Update the type for which this event subscription will trigger Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ EventSourcesClient
Returns a new instance of EventSourcesClient.
13 14 15 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 13 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
11 12 13 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 11 def client @client end |
Instance Method Details
#create(subscription_id: "", type: "", filter: "", fields: []) ⇒ NgrokAPI::Models::EventSource
Add an additional type for which this event subscription will trigger
25 26 27 28 29 30 31 32 33 34 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 25 def create(subscription_id: "", type: "", filter: "", fields: []) path = '/event_subscriptions/%{subscription_id}/sources' replacements = { subscription_id: subscription_id, } data = {} data[:type] = type if type result = @client.post(path % replacements, data: data) NgrokAPI::Models::EventSource.new(client: self, attrs: result) end |
#create!(subscription_id: "", type: "", filter: "", fields: []) ⇒ NgrokAPI::Models::EventSource
Add an additional type for which this event subscription will trigger Throws an exception if API error.
45 46 47 48 49 50 51 52 53 54 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 45 def create!(subscription_id: "", type: "", filter: "", fields: []) path = '/event_subscriptions/%{subscription_id}/sources' replacements = { subscription_id: subscription_id, } data = {} data[:type] = type if type result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSource.new(client: self, attrs: result) end |
#delete(subscription_id: "", type: "") ⇒ NgrokAPI::Models::Empty
Remove a type for which this event subscription will trigger
64 65 66 67 68 69 70 71 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 64 def delete(subscription_id: "", type: "") path = '/event_subscriptions/%{subscription_id}/sources/%{type}' replacements = { subscription_id: subscription_id, type: type, } @client.delete(path % replacements) end |
#delete!(subscription_id: "", type: "") ⇒ NgrokAPI::Models::Empty
Remove a type for which this event subscription will trigger Throws an exception if API error.
82 83 84 85 86 87 88 89 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 82 def delete!(subscription_id: "", type: "") path = '/event_subscriptions/%{subscription_id}/sources/%{type}' replacements = { subscription_id: subscription_id, type: type, } @client.delete(path % replacements, danger: true) end |
#get(subscription_id: "", type: "") ⇒ NgrokAPI::Models::EventSource
Get the details for a given type that triggers for the given event subscription
99 100 101 102 103 104 105 106 107 108 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 99 def get(subscription_id: "", type: "") path = '/event_subscriptions/%{subscription_id}/sources/%{type}' replacements = { subscription_id: subscription_id, type: type, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::EventSource.new(client: self, attrs: result) end |
#get!(subscription_id: "", type: "") ⇒ NgrokAPI::Models::EventSource
Get the details for a given type that triggers for the given event subscription Throws an exception if API error.
119 120 121 122 123 124 125 126 127 128 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 119 def get!(subscription_id: "", type: "") path = '/event_subscriptions/%{subscription_id}/sources/%{type}' replacements = { subscription_id: subscription_id, type: type, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSource.new(client: self, attrs: result) end |
#list(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList
List the types for which this event subscription will trigger
137 138 139 140 141 142 143 144 145 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 137 def list(subscription_id: "") path = '/event_subscriptions/%{subscription_id}/sources' replacements = { subscription_id: subscription_id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::EventSourceList.new(client: self, attrs: result) end |
#list!(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList
List the types for which this event subscription will trigger Throws an exception if API error.
155 156 157 158 159 160 161 162 163 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 155 def list!(subscription_id: "") path = '/event_subscriptions/%{subscription_id}/sources' replacements = { subscription_id: subscription_id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSourceList.new(client: self, attrs: result) end |
#update(subscription_id: "", type: "", filter: nil, fields: nil) ⇒ NgrokAPI::Models::EventSource
Update the type for which this event subscription will trigger
173 174 175 176 177 178 179 180 181 182 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 173 def update(subscription_id: "", type: "", filter: nil, fields: nil) path = '/event_subscriptions/%{subscription_id}/sources/%{type}' replacements = { subscription_id: subscription_id, type: type, } data = {} result = @client.patch(path % replacements, data: data) NgrokAPI::Models::EventSource.new(client: self, attrs: result) end |
#update!(subscription_id: "", type: "", filter: nil, fields: nil) ⇒ NgrokAPI::Models::EventSource
Update the type for which this event subscription will trigger Throws an exception if API error.
193 194 195 196 197 198 199 200 201 202 |
# File 'lib/ngrokapi/services/event_sources_client.rb', line 193 def update!(subscription_id: "", type: "", filter: nil, fields: nil) path = '/event_subscriptions/%{subscription_id}/sources/%{type}' replacements = { subscription_id: subscription_id, type: type, } data = {} result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSource.new(client: self, attrs: result) end |