Class: KlaviyoAPI::WebFeedsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/api/web_feeds_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebFeedsApi

Returns a new instance of WebFeedsApi.



18
19
20
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_web_feed(web_feed_create_query, opts = {}) ⇒ Hash<String, Object>

Create Web Feed Create a web feed.
*Rate limits*:
Burst: ‘1/s`
Steady: `15/m` Scopes: `web-feeds:write`

Parameters:

  • web_feed_create_query (WebFeedCreateQuery) —

    Create a web feed

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


26
27
28
29
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 26

def create_web_feed(web_feed_create_query, opts = {})
  data, _status_code, _headers = create_web_feed_with_http_info(web_feed_create_query, opts)
  data
end

#create_web_feed_with_http_info(web_feed_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Create Web Feed Create a web feed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; Scopes: &#x60;web-feeds:write&#x60;

Parameters:

  • web_feed_create_query (WebFeedCreateQuery) —

    Create a web feed

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 36

def create_web_feed_with_http_info(web_feed_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebFeedsApi.create_web_feed ...'
  end
  # verify the required parameter 'web_feed_create_query' is set
  if @api_client.config.client_side_validation && web_feed_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'web_feed_create_query' when calling WebFeedsApi.create_web_feed"
  end
  # resource path
  local_var_path = '/api/web-feeds'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(web_feed_create_query)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

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

#delete_web_feed(id, opts = {}) ⇒ nil

Delete Web Feed Delete the web feed with the given ID.
*Rate limits*:
Burst: ‘1/s`
Steady: `15/m` Scopes: `web-feeds:write`

Parameters:

  • id (String) —

    The ID of the web feed

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

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 96

def delete_web_feed(id, opts = {})
  delete_web_feed_with_http_info(id, opts)
  nil
end

#delete_web_feed_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Web Feed Delete the web feed with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; Scopes: &#x60;web-feeds:write&#x60;

Parameters:

  • id (String) —

    The ID of the web feed

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 106

def delete_web_feed_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebFeedsApi.delete_web_feed ...'
  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 WebFeedsApi.delete_web_feed"
  end
  # resource path
  local_var_path = '/api/web-feeds/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || ['Klaviyo-API-Key', 'OAuth']

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

#get_web_feed(id, opts = {}) ⇒ Hash<String, Object>

Get Web Feed Get the web feed with the given ID.
*Rate limits*:
Burst: ‘1/s`
Steady: `15/m` Scopes: `web-feeds:read`

Parameters:

  • id (String) —

    The ID of the web feed

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


162
163
164
165
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 162

def get_web_feed(id, opts = {})
  data, _status_code, _headers = get_web_feed_with_http_info(id, opts)
  data
end

#get_web_feed_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Web Feed Get the web feed with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; Scopes: &#x60;web-feeds:read&#x60;

Parameters:

  • id (String) —

    The ID of the web feed

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 173

def get_web_feed_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebFeedsApi.get_web_feed ...'
  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 WebFeedsApi.get_web_feed"
  end
  allowable_values = ["name", "url", "request_method", "content_type", "created", "updated", "status"]
  if @api_client.config.client_side_validation && opts[:'fields_web_feed'] && !opts[:'fields_web_feed'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_web_feed\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/web-feeds/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[web-feed]'] = @api_client.build_collection_param(opts[:'fields_web_feed'], :csv) if !opts[:'fields_web_feed'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

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

#get_web_feeds(opts = {}) ⇒ Hash<String, Object>

Get Web Feeds Get all web feeds for an account.
*Rate limits*:
Burst: ‘1/s`
Steady: `15/m` Scopes: `web-feeds:read`

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


237
238
239
240
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 237

def get_web_feeds(opts = {})
  data, _status_code, _headers = get_web_feeds_with_http_info(opts)
  data
end

#get_web_feeds_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Web Feeds Get all web feeds for an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; Scopes: &#x60;web-feeds:read&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 251

def get_web_feeds_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebFeedsApi.get_web_feeds ...'
  end
  allowable_values = ["name", "url", "request_method", "content_type", "created", "updated", "status"]
  if @api_client.config.client_side_validation && opts[:'fields_web_feed'] && !opts[:'fields_web_feed'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_web_feed\", must include one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 20
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WebFeedsApi.get_web_feeds, must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WebFeedsApi.get_web_feeds, must be greater than or equal to 1.'
  end

  allowable_values = ["created", "-created", "name", "-name", "updated", "-updated"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/web-feeds'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[web-feed]'] = @api_client.build_collection_param(opts[:'fields_web_feed'], :csv) if !opts[:'fields_web_feed'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

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

#update_web_feed(id, web_feed_partial_update_query, opts = {}) ⇒ Hash<String, Object>

Update Web Feed Update the web feed with the given ID.
*Rate limits*:
Burst: ‘1/s`
Steady: `15/m` Scopes: `web-feeds:write`

Parameters:

  • id (String) —

    The ID of the web feed

  • web_feed_partial_update_query (WebFeedPartialUpdateQuery) —

    Update a web feed by ID

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


324
325
326
327
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 324

def update_web_feed(id, web_feed_partial_update_query, opts = {})
  data, _status_code, _headers = update_web_feed_with_http_info(id, web_feed_partial_update_query, opts)
  data
end

#update_web_feed_with_http_info(id, web_feed_partial_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Update Web Feed Update the web feed with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; Scopes: &#x60;web-feeds:write&#x60;

Parameters:

  • id (String) —

    The ID of the web feed

  • web_feed_partial_update_query (WebFeedPartialUpdateQuery) —

    Update a web feed by ID

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 335

def update_web_feed_with_http_info(id, web_feed_partial_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebFeedsApi.update_web_feed ...'
  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 WebFeedsApi.update_web_feed"
  end
  # verify the required parameter 'web_feed_partial_update_query' is set
  if @api_client.config.client_side_validation && web_feed_partial_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'web_feed_partial_update_query' when calling WebFeedsApi.update_web_feed"
  end
  # resource path
  local_var_path = '/api/web-feeds/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(web_feed_partial_update_query)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

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