Class: SibApiV3Sdk::WebhooksApi

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

def api_client
  @api_client
end

Instance Method Details

#create_webhook(create_webhook, opts = {}) ⇒ CreateModel

Create a webhook

Parameters:

  • create_webhook —

    Values to create a webhook

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 26

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

#create_webhook_with_http_info(create_webhook, opts = {}) ⇒ Array<(CreateModel, Fixnum, Hash)>

Create a webhook

Parameters:

  • create_webhook —

    Values to create a webhook

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

    the optional parameters

Returns:

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

    CreateModel data, response status code and response headers



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
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 35

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

  # 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(create_webhook)
  auth_names = ['api-key', 'partner-key']
  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 => 'CreateModel')
  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 a webhook

Parameters:

  • webhook_id —

    Id of the webhook

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

    the optional parameters

Returns:

  • (nil) 


78
79
80
81
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 78

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, Fixnum, Hash)>

Delete a webhook

Parameters:

  • webhook_id —

    Id of the webhook

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



87
88
89
90
91
92
93
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
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 87

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 = '/webhooks/{webhookId}'.sub('{' + 'webhookId' + '}', webhook_id.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 = ['api-key', 'partner-key']
  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#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook(webhook_id, opts = {}) ⇒ GetWebhook

Get a webhook details

Parameters:

  • webhook_id —

    Id of the webhook

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

    the optional parameters

Returns:



129
130
131
132
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 129

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

#get_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(GetWebhook, Fixnum, Hash)>

Get a webhook details

Parameters:

  • webhook_id —

    Id of the webhook

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

    the optional parameters

Returns:

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

    GetWebhook data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
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
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 138

def get_webhook_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_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.get_webhook"
  end
  # resource path
  local_var_path = '/webhooks/{webhookId}'.sub('{' + 'webhookId' + '}', webhook_id.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 = ['api-key', 'partner-key']
  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 => 'GetWebhook')
  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

#get_webhooks(opts = {}) ⇒ GetWebhooks

Get all webhooks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Filter on webhook type (default to transactional)

Returns:



181
182
183
184
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 181

def get_webhooks(opts = {})
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
  data
end

#get_webhooks_with_http_info(opts = {}) ⇒ Array<(GetWebhooks, Fixnum, Hash)>

Get all webhooks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Filter on webhook type

Returns:

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

    GetWebhooks data, response status code and response headers



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
221
222
223
224
225
226
227
228
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 190

def get_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhooks ...'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['marketing', 'transactional'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of marketing, transactional'
  end
  # resource path
  local_var_path = '/webhooks'

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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 = ['api-key', 'partner-key']
  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 => 'GetWebhooks')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a webhook

Parameters:

  • webhook_id —

    Id of the webhook

  • update_webhook —

    Values to update a webhook

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

    the optional parameters

Returns:

  • (nil) 


234
235
236
237
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 234

def update_webhook(webhook_id, update_webhook, opts = {})
  update_webhook_with_http_info(webhook_id, update_webhook, opts)
  nil
end

#update_webhook_with_http_info(webhook_id, update_webhook, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a webhook

Parameters:

  • webhook_id —

    Id of the webhook

  • update_webhook —

    Values to update a webhook

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
283
284
285
 
# File 'lib/sib-api-v3-sdk/api/webhooks_api.rb', line 244

def update_webhook_with_http_info(webhook_id, update_webhook, 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 'update_webhook' is set
  if @api_client.config.client_side_validation && update_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'update_webhook' when calling WebhooksApi.update_webhook"
  end
  # resource path
  local_var_path = '/webhooks/{webhookId}'.sub('{' + 'webhookId' + '}', webhook_id.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(update_webhook)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end