Class: Emailguard::ChannelsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/emailguard_sdk/api/channels_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ChannelsApi

Returns a new instance of ChannelsApi.



19
20
21
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#api_v1_team_notifications_channels_channel_id_delete(channel_id, opts = {}) ⇒ MessageResponse

Delete notification channel Permanently deletes a channel and removes it from any rules that reference it.

Parameters:

  • channel_id (String) —

    UUID of the notification channel to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 27

def api_v1_team_notifications_channels_channel_id_delete(channel_id, opts = {})
  data, _status_code, _headers = api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id, opts)
  data
end

#api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id, opts = {}) ⇒ Array<(MessageResponse, Integer, Hash)>

Delete notification channel Permanently deletes a channel and removes it from any rules that reference it.

Parameters:

  • channel_id (String) —

    UUID of the notification channel to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessageResponse, Integer, Hash)>) —

    MessageResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 37

def api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_channel_id_delete ...'
  end
  # verify the required parameter 'channel_id' is set
  if @api_client.config.client_side_validation && channel_id.nil?
    fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_delete"
  end
  # resource path
  local_var_path = '/api/v1/team/notifications/channels/{channelId}'.sub('{channelId}', CGI.escape(channel_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MessageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ChannelsApi.api_v1_team_notifications_channels_channel_id_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_channel_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#api_v1_team_notifications_channels_channel_id_put(channel_id, update_notification_channel_input, opts = {}) ⇒ GetNotificationChannelResponse

Update notification channel Updates a channel's display name or configuration. Send only fields you want to change.

Parameters:

  • channel_id (String) —

    UUID of the notification channel to update

  • update_notification_channel_input (UpdateNotificationChannelInput) —

    Updated channel name and/or configuration

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 91

def api_v1_team_notifications_channels_channel_id_put(channel_id, update_notification_channel_input, opts = {})
  data, _status_code, _headers = api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input, opts)
  data
end

#api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input, opts = {}) ⇒ Array<(GetNotificationChannelResponse, Integer, Hash)>

Update notification channel Updates a channel's display name or configuration. Send only fields you want to change.

Parameters:

  • channel_id (String) —

    UUID of the notification channel to update

  • update_notification_channel_input (UpdateNotificationChannelInput) —

    Updated channel name and/or configuration

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 102

def api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_channel_id_put ...'
  end
  # verify the required parameter 'channel_id' is set
  if @api_client.config.client_side_validation && channel_id.nil?
    fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_put"
  end
  # verify the required parameter 'update_notification_channel_input' is set
  if @api_client.config.client_side_validation && update_notification_channel_input.nil?
    fail ArgumentError, "Missing the required parameter 'update_notification_channel_input' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_put"
  end
  # resource path
  local_var_path = '/api/v1/team/notifications/channels/{channelId}'.sub('{channelId}', CGI.escape(channel_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_notification_channel_input)

  # return_type
  return_type = opts[:debug_return_type] || 'GetNotificationChannelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ChannelsApi.api_v1_team_notifications_channels_channel_id_put",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_channel_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#api_v1_team_notifications_channels_channel_id_test_post(channel_id, opts = {}) ⇒ MessageResponse

Test notification channel Sends a sample payload to a webhook channel to confirm the endpoint is reachable. On success the channel is marked verified.

Parameters:

  • channel_id (String) —

    UUID of the webhook channel to test

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 164

def api_v1_team_notifications_channels_channel_id_test_post(channel_id, opts = {})
  data, _status_code, _headers = api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id, opts)
  data
end

#api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id, opts = {}) ⇒ Array<(MessageResponse, Integer, Hash)>

Test notification channel Sends a sample payload to a webhook channel to confirm the endpoint is reachable. On success the channel is marked verified.

Parameters:

  • channel_id (String) —

    UUID of the webhook channel to test

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessageResponse, Integer, Hash)>) —

    MessageResponse data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 174

def api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_channel_id_test_post ...'
  end
  # verify the required parameter 'channel_id' is set
  if @api_client.config.client_side_validation && channel_id.nil?
    fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_test_post"
  end
  # resource path
  local_var_path = '/api/v1/team/notifications/channels/{channelId}/test'.sub('{channelId}', CGI.escape(channel_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MessageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ChannelsApi.api_v1_team_notifications_channels_channel_id_test_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_channel_id_test_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#api_v1_team_notifications_channels_get(opts = {}) ⇒ GetNotificationChannelsResponse

List notification channels Returns every delivery channel configured for the team (email, webhook, and other supported types). Use channel IDs when attaching targets to notification rules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 226

def api_v1_team_notifications_channels_get(opts = {})
  data, _status_code, _headers = api_v1_team_notifications_channels_get_with_http_info(opts)
  data
end

#api_v1_team_notifications_channels_get_with_http_info(opts = {}) ⇒ Array<(GetNotificationChannelsResponse, Integer, Hash)>

List notification channels Returns every delivery channel configured for the team (email, webhook, and other supported types). Use channel IDs when attaching targets to notification rules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 235

def api_v1_team_notifications_channels_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_get ...'
  end
  # resource path
  local_var_path = '/api/v1/team/notifications/channels'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetNotificationChannelsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ChannelsApi.api_v1_team_notifications_channels_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#api_v1_team_notifications_channels_post(create_notification_channel_input, opts = {}) ⇒ GetNotificationChannelResponse

Create notification channel Creates a delivery channel for the team. Email channels require verification; webhook channels can be verified with the test endpoint.

Parameters:

  • create_notification_channel_input (CreateNotificationChannelInput) —

    Channel name, type, and type-specific configuration

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



284
285
286
287
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 284

def api_v1_team_notifications_channels_post(create_notification_channel_input, opts = {})
  data, _status_code, _headers = api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input, opts)
  data
end

#api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input, opts = {}) ⇒ Array<(GetNotificationChannelResponse, Integer, Hash)>

Create notification channel Creates a delivery channel for the team. Email channels require verification; webhook channels can be verified with the test endpoint.

Parameters:

  • create_notification_channel_input (CreateNotificationChannelInput) —

    Channel name, type, and type-specific configuration

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/emailguard_sdk/api/channels_api.rb', line 294

def api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_post ...'
  end
  # verify the required parameter 'create_notification_channel_input' is set
  if @api_client.config.client_side_validation && create_notification_channel_input.nil?
    fail ArgumentError, "Missing the required parameter 'create_notification_channel_input' when calling ChannelsApi.api_v1_team_notifications_channels_post"
  end
  # resource path
  local_var_path = '/api/v1/team/notifications/channels'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_notification_channel_input)

  # return_type
  return_type = opts[:debug_return_type] || 'GetNotificationChannelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ChannelsApi.api_v1_team_notifications_channels_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end