Method: KlaviyoAPI::WebFeedsApi#get_web_feeds_with_http_info

Defined in:

lib/klaviyo-api-sdk/api/web_feeds_api.rb

#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):

• :fields_web_feed (Array<String>) —

  For more information please visit developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets

• :filter (String) —

  For more information please visit developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;

• :page_cursor (String) —

  For more information please visit developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination

• :page_size (Integer) —

  Default: 5. Min: 1. Max: 20. (default to 5)

• :sort (String) —

  For more information please visit developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting

Returns:

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

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

# File 'lib/klaviyo-api-sdk/api/web_feeds_api.rb', line 252

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