Class: NgrokAPI::Services::EventSourcesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/event_sources_client.rb

Overview

https://ngrok.com/docs/api#api-event-sources

Constant Summary collapse

PATH =

The API path for the requests

'/event_subscriptions/%{subscription_id}/sources'

Instance Attribute Summary collapse

Instance Method Summary collapse

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

https://ngrok.com/docs/api#api-event-sources-create

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:



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, result: result)
end

#delete(subscription_id: "", type: "") ⇒ NgrokAPI::Models::Empty

Remove a type for which this event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-delete

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



44
45
46
47
48
49
50
51
 
# File 'lib/ngrokapi/services/event_sources_client.rb', line 44

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.

https://ngrok.com/docs/api#api-event-sources-delete

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



62
63
64
65
66
67
68
69
 
# File 'lib/ngrokapi/services/event_sources_client.rb', line 62

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

https://ngrok.com/docs/api#api-event-sources-get

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ngrokapi/services/event_sources_client.rb', line 79

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, result: 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.

https://ngrok.com/docs/api#api-event-sources-get

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:



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, danger: true)
  NgrokAPI::Models::EventSource.new(client: self, result: result)
end

#list(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList

List the types for which this event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-list

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

Returns:



117
118
119
120
121
122
123
124
125
 
# File 'lib/ngrokapi/services/event_sources_client.rb', line 117

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, result: result)
end

#list!(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList

List the types for which this event subscription will trigger Throws an exception if API error.

https://ngrok.com/docs/api#api-event-sources-list

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

Returns:



135
136
137
138
139
140
141
142
143
 
# File 'lib/ngrokapi/services/event_sources_client.rb', line 135

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, result: result)
end

#update(subscription_id: "", type: "", filter: nil, fields: nil) ⇒ NgrokAPI::Models::EventSource

Update the type for which this event subscription will trigger

https://ngrok.com/docs/api#api-event-sources-update

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/ngrokapi/services/event_sources_client.rb', line 153

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, result: 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.

https://ngrok.com/docs/api#api-event-sources-update

Parameters:

  • subscription_id (string) (defaults to: "") —

    The unique identifier for the Event Subscription that this Event Source is attached to.

  • type (string) (defaults to: "") —

    Type of event for which an event subscription will trigger

Returns:



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, danger: true)
  NgrokAPI::Models::EventSource.new(client: self, result: result)
end