Class: NgrokAPI::Services::EventSubscriptionsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::EventSubscriptionsClient
- Defined in:
- lib/ngrokapi/services/event_subscriptions_client.rb
Overview
Constant Summary collapse
- PATH =
The API path for the requests
'/event_subscriptions'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'event_subscriptions'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(metadata: "", description: "", sources: [], destination_ids: []) ⇒ NgrokAPI::Models::EventSubscription
Create an Event Subscription.
-
#create!(metadata: "", description: "", sources: [], destination_ids: []) ⇒ NgrokAPI::Models::EventSubscription
Create an Event Subscription.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Subscription.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Subscription.
-
#get(id: "") ⇒ NgrokAPI::Models::EventSubscription
Get an Event Subscription by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::EventSubscription
Get an Event Subscription by ID.
-
#initialize(client:) ⇒ EventSubscriptionsClient
constructor
A new instance of EventSubscriptionsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List this Account’s Event Subscriptions.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List this Account’s Event Subscriptions.
-
#update(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription
Update an Event Subscription.
-
#update!(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription
Update an Event Subscription.
Constructor Details
#initialize(client:) ⇒ EventSubscriptionsClient
Returns a new instance of EventSubscriptionsClient.
17 18 19 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 17 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
15 16 17 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 15 def client @client end |
Instance Method Details
#create(metadata: "", description: "", sources: [], destination_ids: []) ⇒ NgrokAPI::Models::EventSubscription
Create an Event Subscription.
31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 31 def create(metadata: "", description: "", sources: [], destination_ids: []) path = '/event_subscriptions' replacements = { } data = {} data[:metadata] = if data[:description] = description if description data[:sources] = sources if sources data[:destination_ids] = destination_ids if destination_ids result = @client.post(path % replacements, data: data) NgrokAPI::Models::EventSubscription.new(client: self, attrs: result) end |
#create!(metadata: "", description: "", sources: [], destination_ids: []) ⇒ NgrokAPI::Models::EventSubscription
Create an Event Subscription. Throws an exception if API error.
55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 55 def create!(metadata: "", description: "", sources: [], destination_ids: []) path = '/event_subscriptions' replacements = { } data = {} data[:metadata] = if data[:description] = description if description data[:sources] = sources if sources data[:destination_ids] = destination_ids if destination_ids result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSubscription.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Subscription.
75 76 77 78 79 80 81 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 75 def delete(id: "") path = '/event_subscriptions/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an Event Subscription. Throws an exception if API error.
91 92 93 94 95 96 97 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 91 def delete!(id: "") path = '/event_subscriptions/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::EventSubscription
Get an Event Subscription by ID.
106 107 108 109 110 111 112 113 114 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 106 def get(id: "") path = '/event_subscriptions/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::EventSubscription.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::EventSubscription
Get an Event Subscription by ID. Throws an exception if API error.
124 125 126 127 128 129 130 131 132 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 124 def get!(id: "") path = '/event_subscriptions/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSubscription.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List this Account’s Event Subscriptions.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 143 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, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::EventSubscription ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List this Account’s Event Subscriptions. Throws an exception if API error.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 173 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, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::EventSubscription, danger: true ) end |
#update(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription
Update an Event Subscription.
206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 206 def update(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) path = '/event_subscriptions/%{id}' replacements = { id: id, } data = {} data[:metadata] = if data[:description] = description if description data[:sources] = sources if sources data[:destination_ids] = destination_ids if destination_ids result = @client.patch(path % replacements, data: data) NgrokAPI::Models::EventSubscription.new(client: self, attrs: result) end |
#update!(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription
Update an Event Subscription. Throws an exception if API error.
232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 232 def update!(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) path = '/event_subscriptions/%{id}' replacements = { id: id, } data = {} data[:metadata] = if data[:description] = description if description data[:sources] = sources if sources data[:destination_ids] = destination_ids if destination_ids result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::EventSubscription.new(client: self, attrs: result) end |