Class: DevDraftAI::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/devdraft/api/webhooks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhooksApi

Returns a new instance of WebhooksApi.



16
17
18
 
# File 'lib/devdraft/api/webhooks_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/devdraft/api/webhooks_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#webhook_controller_create(body, opts = {}) ⇒ WebhookResponseDto

Create a new webhook Creates a new webhook endpoint for receiving event notifications. Requires webhook:create scope.

Parameters:

  • body —

    Webhook configuration details

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/devdraft/api/webhooks_api.rb', line 24

def webhook_controller_create(body, opts = {})
  data, _status_code, _headers = webhook_controller_create_with_http_info(body, opts)
  data
end

#webhook_controller_create_with_http_info(body, opts = {}) ⇒ Array<(WebhookResponseDto, Integer, Hash)>

Create a new webhook Creates a new webhook endpoint for receiving event notifications. Requires webhook:create scope.

Parameters:

  • body —

    Webhook configuration details

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

    the optional parameters

Returns:

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

    WebhookResponseDto data, response status code and response headers



34
35
36
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
 
# File 'lib/devdraft/api/webhooks_api.rb', line 34

def webhook_controller_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_controller_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebhooksApi.webhook_controller_create"
  end
  # resource path
  local_var_path = '/api/v0/webhooks'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'WebhookResponseDto' 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhook_controller_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhook_controller_find_all(opts = {}) ⇒ Array<WebhookResponseDto>

Get all webhooks Retrieves a list of all webhooks for your application. Requires webhook:read scope.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (BigDecimal) —

    Number of records to skip (default: 0)

  • :take (BigDecimal) —

    Number of records to return (default: 10)

Returns:



83
84
85
86
 
# File 'lib/devdraft/api/webhooks_api.rb', line 83

def webhook_controller_find_all(opts = {})
  data, _status_code, _headers = webhook_controller_find_all_with_http_info(opts)
  data
end

#webhook_controller_find_all_with_http_info(opts = {}) ⇒ Array<(Array<WebhookResponseDto>, Integer, Hash)>

Get all webhooks Retrieves a list of all webhooks for your application. Requires webhook:read scope.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (BigDecimal) —

    Number of records to skip (default: 0)

  • :take (BigDecimal) —

    Number of records to return (default: 10)

Returns:

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

    Array<WebhookResponseDto> data, response status code and response headers



94
95
96
97
98
99
100
101
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
 
# File 'lib/devdraft/api/webhooks_api.rb', line 94

def webhook_controller_find_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_controller_find_all ...'
  end
  # resource path
  local_var_path = '/api/v0/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?

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

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

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

  return_type = opts[:return_type] || 'Array<WebhookResponseDto>' 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhook_controller_find_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhook_controller_find_one(id, opts = {}) ⇒ WebhookResponseDto

Get a webhook by id Retrieves details for a specific webhook. Requires webhook:read scope.

Parameters:

  • id —

    Webhook ID

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/devdraft/api/webhooks_api.rb', line 138

def webhook_controller_find_one(id, opts = {})
  data, _status_code, _headers = webhook_controller_find_one_with_http_info(id, opts)
  data
end

#webhook_controller_find_one_with_http_info(id, opts = {}) ⇒ Array<(WebhookResponseDto, Integer, Hash)>

Get a webhook by id Retrieves details for a specific webhook. Requires webhook:read scope.

Parameters:

  • id —

    Webhook ID

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

    the optional parameters

Returns:

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

    WebhookResponseDto data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/devdraft/api/webhooks_api.rb', line 148

def webhook_controller_find_one_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_controller_find_one ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_controller_find_one"
  end
  # resource path
  local_var_path = '/api/v0/webhooks/{id}'.sub('{' + 'id' + '}', 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'])

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

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

  return_type = opts[:return_type] || 'WebhookResponseDto' 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhook_controller_find_one\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhook_controller_remove(id, opts = {}) ⇒ WebhookResponseDto

Delete a webhook Deletes a webhook configuration. Requires webhook:delete scope.

Parameters:

  • id —

    Webhook ID

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

    the optional parameters

Returns:



194
195
196
197
 
# File 'lib/devdraft/api/webhooks_api.rb', line 194

def webhook_controller_remove(id, opts = {})
  data, _status_code, _headers = webhook_controller_remove_with_http_info(id, opts)
  data
end

#webhook_controller_remove_with_http_info(id, opts = {}) ⇒ Array<(WebhookResponseDto, Integer, Hash)>

Delete a webhook Deletes a webhook configuration. Requires webhook:delete scope.

Parameters:

  • id —

    Webhook ID

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

    the optional parameters

Returns:

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

    WebhookResponseDto data, response status code and response headers



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/devdraft/api/webhooks_api.rb', line 204

def webhook_controller_remove_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_controller_remove ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_controller_remove"
  end
  # resource path
  local_var_path = '/api/v0/webhooks/{id}'.sub('{' + 'id' + '}', 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'])

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

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

  return_type = opts[:return_type] || 'WebhookResponseDto' 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhook_controller_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhook_controller_update(body, id, opts = {}) ⇒ WebhookResponseDto

Update a webhook Updates an existing webhook configuration. Requires webhook:update scope.

Parameters:

  • body —

    Webhook update details

  • id —

    Webhook ID

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

    the optional parameters

Returns:



251
252
253
254
 
# File 'lib/devdraft/api/webhooks_api.rb', line 251

def webhook_controller_update(body, id, opts = {})
  data, _status_code, _headers = webhook_controller_update_with_http_info(body, id, opts)
  data
end

#webhook_controller_update_with_http_info(body, id, opts = {}) ⇒ Array<(WebhookResponseDto, Integer, Hash)>

Update a webhook Updates an existing webhook configuration. Requires webhook:update scope.

Parameters:

  • body —

    Webhook update details

  • id —

    Webhook ID

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

    the optional parameters

Returns:

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

    WebhookResponseDto data, response status code and response headers



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/devdraft/api/webhooks_api.rb', line 262

def webhook_controller_update_with_http_info(body, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_controller_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebhooksApi.webhook_controller_update"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_controller_update"
  end
  # resource path
  local_var_path = '/api/v0/webhooks/{id}'.sub('{' + 'id' + '}', 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'WebhookResponseDto' 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhook_controller_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end