Class: NgrokAPI::Services::EventSubscriptionsClient

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

Overview

ngrok.com/docs/api#api-event-subscriptions

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EventSubscriptionsClient

Returns a new instance of EventSubscriptionsClient.



15
16
17
 
# File 'lib/ngrokapi/services/event_subscriptions_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_subscriptions_client.rb', line 13

def client
  @client
end

Instance Method Details

#create(metadata: "", description: "", sources: [], destination_ids: []) ⇒ NgrokAPI::Models::EventSubscription

Create an Event Subscription.

ngrok.com/docs/api#api-event-subscriptions-create

Parameters:

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

    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

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

    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

  • sources (List<EventSourceReplace>) (defaults to: []) —

    Sources containing the types for which this event subscription will trigger

  • destination_ids (List<string>) (defaults to: []) —

    A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 29

def create(
  metadata: "",
  description: "",
  sources: [],
  destination_ids: []
)
  path = '/event_subscriptions'
  replacements = {
  }
  data = {}
  data[:metadata] = metadata if metadata
  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, result: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an Event Subscription.

ngrok.com/docs/api#api-event-subscriptions-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



54
55
56
57
58
59
60
61
62
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 54

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.

ngrok.com/docs/api#api-event-subscriptions-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



72
73
74
75
76
77
78
79
80
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 72

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.

ngrok.com/docs/api#api-event-subscriptions-get

Parameters:

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

    a resource identifier

Returns:



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 89

def get(
  id: ""
)
  path = '/event_subscriptions/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::EventSubscription.new(client: self, result: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::EventSubscription

Get an Event Subscription by ID. Throws an exception if API error.

ngrok.com/docs/api#api-event-subscriptions-get

Parameters:

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

    a resource identifier

Returns:



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 109

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

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List this Account’s Event Subscriptions.

ngrok.com/docs/api#api-event-subscriptions-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 130

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::EventSubscription
  )
end

#update(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription

Update an Event Subscription.

ngrok.com/docs/api#api-event-subscriptions-update

Parameters:

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

    Unique identifier for this Event Subscription.

  • metadata (string) (defaults to: nil) —

    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

  • description (string) (defaults to: nil) —

    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

  • sources (List<EventSourceReplace>) (defaults to: nil) —

    Sources containing the types for which this event subscription will trigger

  • destination_ids (List<string>) (defaults to: nil) —

    A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.

Returns:



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160

def update(
  id: "",
  metadata: nil,
  description: nil,
  sources: nil,
  destination_ids: nil
)
  path = '/event_subscriptions/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:metadata] = metadata if metadata
  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, result: 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.

ngrok.com/docs/api#api-event-subscriptions-update

Parameters:

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

    Unique identifier for this Event Subscription.

  • metadata (string) (defaults to: nil) —

    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

  • description (string) (defaults to: nil) —

    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

  • sources (List<EventSourceReplace>) (defaults to: nil) —

    Sources containing the types for which this event subscription will trigger

  • destination_ids (List<string>) (defaults to: nil) —

    A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 192

def update!(
  id: "",
  metadata: nil,
  description: nil,
  sources: nil,
  destination_ids: nil
)
  path = '/event_subscriptions/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:metadata] = metadata if metadata
  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, result: result)
end