Class: KlaviyoAPI::ClientApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ClientApi

Returns a new instance of ClientApi.



18
19
20
 
# File 'lib/klaviyo-api-sdk/api/client_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/client_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

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

Get Client IP Allowlist Return the current integration-egress IP allow list. This is a singleton resource addressed at the fixed id integration-egress: call GET /client/ip-allowlists/integration-egress (not GET /client/ip-allowlists). Any other id returns 404.

Rate limits:
Burst: 75/s<br>Steady: 750/m OpenAPI Spec

Parameters:

  • id (String)
  • company_id (String) —

    Your Public API Key / Site ID. See this article for more details.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


28
29
30
31
 
# File 'lib/klaviyo-api-sdk/api/client_api.rb', line 28

def get_client_ip_allowlist(id, company_id, opts = {})
  data, _status_code, _headers = get_client_ip_allowlist_with_http_info(id, company_id, opts)
  data
end

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

Get Client IP Allowlist Return the current integration-egress IP allow list. This is a singleton resource addressed at the fixed id ``integration-egress``: call ``GET /client/ip-allowlists/integration-egress`` (not ``GET /client/ip-allowlists``). Any other id returns 404.<br><br>Rate limits:<br>Burst: `75/s`<br>Steady: `750/m` OpenAPI Spec

Parameters:

  • id (String)
  • company_id (String) —

    Your Public API Key / Site ID. See this article for more details.

  • 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



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
90
91
92
93
94
95
96
97
98
 
# File 'lib/klaviyo-api-sdk/api/client_api.rb', line 40

def get_client_ip_allowlist_with_http_info(id, company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_ip_allowlist ...'
  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 ClientApi.get_client_ip_allowlist"
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling ClientApi.get_client_ip_allowlist"
  end
  allowable_values = ["created", "id", "prefixes", "sync_token"]
  if @api_client.config.client_side_validation && opts[:'fields_ip_allowlist'] && !opts[:'fields_ip_allowlist'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_ip_allowlist\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/client/ip-allowlists/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'company_id'] = company_id
  query_params[:'fields[ip-allowlist]'] = @api_client.build_collection_param(opts[:'fields_ip_allowlist'], :csv) if !opts[:'fields_ip_allowlist'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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] || []

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