Class: PolarAccesslinkApiGem::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/polar-accesslink-api-gem/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/polar-accesslink-api-gem/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/polar-accesslink-api-gem/api/webhooks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_webhook(webhook_request, opts = {}) ⇒ CreatedWebhook

Create webhook Create new webhook. When creating webhook the Accesslink sends a ping message to the url in request body. The ping message must be answered with 200 OK or otherwise the webhook is not created. **Note!** Save the signature_secret_key from response since this is the only chance to get it.

Parameters:

  • webhook_request (WebhookRequest) —

    Webhook to create.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 27

def create_webhook(webhook_request, opts = {})
  data, _status_code, _headers = create_webhook_with_http_info(webhook_request, opts)
  data
end

#create_webhook_with_http_info(webhook_request, opts = {}) ⇒ Array<(CreatedWebhook, Integer, Hash)>

Create webhook Create new webhook. When creating webhook the Accesslink sends a ping message to the url in request body. The ping message must be answered with 200 OK or otherwise the webhook is not created. **Note!** Save the signature_secret_key from response since this is the only chance to get it.

Parameters:

  • webhook_request (WebhookRequest) —

    Webhook to create.

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

    the optional parameters

Returns:

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

    CreatedWebhook 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
84
85
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 37

def create_webhook_with_http_info(webhook_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhook ...'
  end
  # verify the required parameter 'webhook_request' is set
  if @api_client.config.client_side_validation && webhook_request.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_request' when calling WebhooksApi.create_webhook"
  end
  # resource path
  local_var_path = '/v3/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[:debug_body] || @api_client.object_to_http_body(webhook_request)

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

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

  new_options = opts.merge(
    :operation => :"WebhooksApi.create_webhook",
    :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: WebhooksApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webhook(webhook_id, opts = {}) ⇒ nil

Delete webhook Delete webhook by id.

Parameters:

  • webhook_id (Integer) —

    Webhook id to delete

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

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 92

def delete_webhook(webhook_id, opts = {})
  delete_webhook_with_http_info(webhook_id, opts)
  nil
end

#delete_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete webhook Delete webhook by id.

Parameters:

  • webhook_id (Integer) —

    Webhook id to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 102

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"WebhooksApi.delete_webhook",
    :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: WebhooksApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook(opts = {}) ⇒ WebhookInfo

Get webhook Returns created webhook if exists.

Parameters:

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

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 154

def get_webhook(opts = {})
  data, _status_code, _headers = get_webhook_with_http_info(opts)
  data
end

#get_webhook_with_http_info(opts = {}) ⇒ Array<(WebhookInfo, Integer, Hash)>

Get webhook Returns created webhook if exists.

Parameters:

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

    the optional parameters

Returns:

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

    WebhookInfo data, response status code and response headers



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 163

def get_webhook_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook ...'
  end
  # resource path
  local_var_path = '/v3/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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhook",
    :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: WebhooksApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_webhook(webhook_id, webhook_patch, opts = {}) ⇒ WebhookInfo

Update webhook Edit webhook event types and/or url. When updating webhook url the Accesslink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.

Parameters:

  • webhook_id (Integer) —

    Webhook id to update

  • webhook_patch (WebhookPatch) —

    New value(s) for events and/or url.

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

    the optional parameters

Returns:



213
214
215
216
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 213

def update_webhook(webhook_id, webhook_patch, opts = {})
  data, _status_code, _headers = update_webhook_with_http_info(webhook_id, webhook_patch, opts)
  data
end

#update_webhook_with_http_info(webhook_id, webhook_patch, opts = {}) ⇒ Array<(WebhookInfo, Integer, Hash)>

Update webhook Edit webhook event types and/or url. When updating webhook url the Accesslink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.

Parameters:

  • webhook_id (Integer) —

    Webhook id to update

  • webhook_patch (WebhookPatch) —

    New value(s) for events and/or url.

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

    the optional parameters

Returns:

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

    WebhookInfo data, response status code and response headers



224
225
226
227
228
229
230
231
232
233
234
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
 
# File 'lib/polar-accesslink-api-gem/api/webhooks_api.rb', line 224

def update_webhook_with_http_info(webhook_id, webhook_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.update_webhook ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.update_webhook"
  end
  # verify the required parameter 'webhook_patch' is set
  if @api_client.config.client_side_validation && webhook_patch.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_patch' when calling WebhooksApi.update_webhook"
  end
  # resource path
  local_var_path = '/v3/webhooks/{webhook-id}'.sub('{' + 'webhook-id' + '}', CGI.escape(webhook_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[:debug_body] || @api_client.object_to_http_body(webhook_patch)

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

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

  new_options = opts.merge(
    :operation => :"WebhooksApi.update_webhook",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end