Class: CloudsmithApi::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/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.



19
20
21
 
# File 'lib/cloudsmith-api/api/webhooks_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/cloudsmith-api/api/webhooks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#webhooks_create(owner, repo, opts = {}) ⇒ RepositoryWebhook

Create a specific webhook in a repository. Create a specific webhook in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 29

def webhooks_create(owner, repo, opts = {})
  data, _status_code, _headers = webhooks_create_with_http_info(owner, repo, opts)
  data
end

#webhooks_create_with_http_info(owner, repo, opts = {}) ⇒ Array<(RepositoryWebhook, Fixnum, Hash)>

Create a specific webhook in a repository. Create a specific webhook in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(RepositoryWebhook, Fixnum, Hash)>) —

    RepositoryWebhook data, response status code and response headers



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/cloudsmith-api/api/webhooks_api.rb', line 41

def webhooks_create_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_create ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling WebhooksApi.webhooks_create"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling WebhooksApi.webhooks_create"
  end
  # resource path
  local_var_path = '/webhooks/{owner}/{repo}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'RepositoryWebhook')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhooks_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhooks_delete(owner, repo, identifier, opts = {}) ⇒ nil

Delete a specific webhook in a repository. Delete a specific webhook in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 91

def webhooks_delete(owner, repo, identifier, opts = {})
  webhooks_delete_with_http_info(owner, repo, identifier, opts)
  nil
end

#webhooks_delete_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a specific webhook in a repository. Delete a specific webhook in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 103

def webhooks_delete_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_delete ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling WebhooksApi.webhooks_delete"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling WebhooksApi.webhooks_delete"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling WebhooksApi.webhooks_delete"
  end
  # resource path
  local_var_path = '/webhooks/{owner}/{repo}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhooks_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhooks_list(owner, repo, opts = {}) ⇒ Array<RepositoryWebhook>

Get a list of all webhooks in a repository. Get a list of all webhooks in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



157
158
159
160
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 157

def webhooks_list(owner, repo, opts = {})
  data, _status_code, _headers = webhooks_list_with_http_info(owner, repo, opts)
  data
end

#webhooks_list_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<RepositoryWebhook>, Fixnum, Hash)>

Get a list of all webhooks in a repository. Get a list of all webhooks in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

  • (Array<(Array<RepositoryWebhook>, Fixnum, Hash)>) —

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



170
171
172
173
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
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 170

def webhooks_list_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_list ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling WebhooksApi.webhooks_list"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling WebhooksApi.webhooks_list"
  end
  # resource path
  local_var_path = '/webhooks/{owner}/{repo}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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 => 'Array<RepositoryWebhook>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhooks_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhooks_partial_update(owner, repo, identifier, opts = {}) ⇒ RepositoryWebhook

Update a specific webhook in a repository. Update a specific webhook in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



223
224
225
226
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 223

def webhooks_partial_update(owner, repo, identifier, opts = {})
  data, _status_code, _headers = webhooks_partial_update_with_http_info(owner, repo, identifier, opts)
  data
end

#webhooks_partial_update_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(RepositoryWebhook, Fixnum, Hash)>

Update a specific webhook in a repository. Update a specific webhook in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(RepositoryWebhook, Fixnum, Hash)>) —

    RepositoryWebhook data, response status code and response headers



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
278
279
280
281
282
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 236

def webhooks_partial_update_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_partial_update ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling WebhooksApi.webhooks_partial_update"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling WebhooksApi.webhooks_partial_update"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling WebhooksApi.webhooks_partial_update"
  end
  # resource path
  local_var_path = '/webhooks/{owner}/{repo}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'RepositoryWebhook')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhooks_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhooks_read(owner, repo, identifier, opts = {}) ⇒ RepositoryWebhook

Views for working with repository webhooks. Views for working with repository webhooks.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



290
291
292
293
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 290

def webhooks_read(owner, repo, identifier, opts = {})
  data, _status_code, _headers = webhooks_read_with_http_info(owner, repo, identifier, opts)
  data
end

#webhooks_read_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(RepositoryWebhook, Fixnum, Hash)>

Views for working with repository webhooks. Views for working with repository webhooks.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RepositoryWebhook, Fixnum, Hash)>) —

    RepositoryWebhook data, response status code and response headers



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
346
347
348
 
# File 'lib/cloudsmith-api/api/webhooks_api.rb', line 302

def webhooks_read_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_read ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling WebhooksApi.webhooks_read"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling WebhooksApi.webhooks_read"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling WebhooksApi.webhooks_read"
  end
  # resource path
  local_var_path = '/webhooks/{owner}/{repo}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic']
  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 => 'RepositoryWebhook')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#webhooks_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end