klaviyo-api-sdk 17.0.0 → 18.0.0

data/lib/klaviyo-api-sdk/api/client_api.rb

@@ -0,0 +1,100 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'cgi'
+
+module KlaviyoAPI
+  class ClientApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_ip_allowlist.json)
+    # @param id [String] 
+    # @param company_id [String] Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields_ip_allowlist For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
+    # @return [Hash<String, Object>]
+    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
+    # Return the current integration-egress IP allow list.  This is a singleton resource addressed at the fixed id &#x60;&#x60;integration-egress&#x60;&#x60;: call &#x60;&#x60;GET /client/ip-allowlists/integration-egress&#x60;&#x60; (not &#x60;&#x60;GET /client/ip-allowlists&#x60;&#x60;). Any other id returns 404.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;750/m&#x60;  [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_ip_allowlist.json)
+    # @param id [String] 
+    # @param company_id [String] Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields_ip_allowlist For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+  end
+end

data/lib/klaviyo-api-sdk/api/conversations_api.rb

@@ -19,7 +19,7 @@ module KlaviyoAPI
       @api_client = api_client
     end
     # Create Conversation Message
-    # Send an outbound message to a conversation.  Requires OAuth authentication and account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `conversations:write`
+    # Send an outbound message to a conversation.  Requires account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `conversations:write`  [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_conversation_message.json)
     # @param conversation_message_create_query [ConversationMessageCreateQuery] Create a conversation message
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -29,7 +29,7 @@ module KlaviyoAPI
     end
 
     # Create Conversation Message
-    # Send an outbound message to a conversation.  Requires OAuth authentication and account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60;  **Scopes:** &#x60;conversations:write&#x60;
+    # Send an outbound message to a conversation.  Requires account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60;  **Scopes:** &#x60;conversations:write&#x60;  [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_conversation_message.json)
     # @param conversation_message_create_query [ConversationMessageCreateQuery] Create a conversation message
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -50,7 +50,7 @@ module KlaviyoAPI
       # header parameters
       header_params = opts[:header_params] || {}
       # klaviyo api revision
-      header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
+      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'])
       # HTTP header 'Content-Type'