version 5.1.0

CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.1.0] - revision 2023-12-15
+### Added
+- New Endpoints: Bulk Profile Imports:
+    - `Profiles.spawn_bulk_profile_import_job`
+    - `Profiles.get_bulk_profile_import_job`
+    - `Profiles.get_bulk_profile_import_jobs`
+    - `Profiles.get_bulk_profile_import_job_lists`
+    - `Profiles.get_bulk_profile_import_job_profiles`
+    - `Profiles.get_bulk_profile_import_job_import_errors`
+    - `Profiles.get_bulk_profile_import_job_relationships_profiles`
+    - `Profiles.get_bulk_profile_import_job_relationships_lists`
+### Changed
+- The `relationships` field of Profiles.subscribe_profiles payload is now optional. (see [subscribe_profiles reference](https://developers.klaviyo.com/en/reference/subscribe_profiles) for details).
+
 ## [5.0.0] - revision 2023-10-15
 
 ### Added

klaviyo-api-sdk.gemspec

@@ -5,7 +5,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-10-15
+The version of the OpenAPI document: 2023-12-15
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
 
 Gem::Specification.new do |s|
   s.name        = "klaviyo-api-sdk"
-  s.version     = "5.0.0"
+  s.version     = "5.1.0"
   s.authors     = ['Klaviyo Team']
   s.email       = ['[email protected]']
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'

lib/klaviyo-api-sdk.rb

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-10-15
+The version of the OpenAPI document: 2023-12-15
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -207,12 +207,20 @@
 require 'klaviyo-api-sdk/models/onsite_profile_create_query_resource_object'
 require 'klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes'
 require 'klaviyo-api-sdk/models/onsite_profile_meta'
+require 'klaviyo-api-sdk/models/profile_bulk_import_job_enum'
 require 'klaviyo-api-sdk/models/profile_create_query'
 require 'klaviyo-api-sdk/models/profile_create_query_resource_object'
 require 'klaviyo-api-sdk/models/profile_create_query_resource_object_attributes'
 require 'klaviyo-api-sdk/models/profile_enum'
 require 'klaviyo-api-sdk/models/profile_identifier_dto_resource_object'
 require 'klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query_resource_object'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists'
+require 'klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner'
 require 'klaviyo-api-sdk/models/profile_location'
 require 'klaviyo-api-sdk/models/profile_location_latitude'
 require 'klaviyo-api-sdk/models/profile_location_longitude'

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-10-15
+The version of the OpenAPI document: 2023-12-15
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default)
     # Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`
     # @param id [String] The ID of the account
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
     # @return [Hash<String, Object>]
     def get_account(id, opts = {})
       data, _status_code, _headers = get_account_with_http_info(id, opts)
@@ -34,7 +34,7 @@ def get_account(id, opts = {})
     # Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.&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;accounts:read&#x60;
     # @param id [String] The ID of the account
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-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_account_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -58,7 +58,7 @@ def get_account_with_http_info(id, opts = {})
       # header parameters
       header_params = opts[:header_params] || {}
       # klaviyo api revision
-      header_params['revision'] =  ENV['API_REVISION'] || "2023-10-15"
+      header_params['revision'] =  ENV['API_REVISION'] || "2023-12-15"
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
@@ -94,7 +94,7 @@ def get_account_with_http_info(id, opts = {})
     # Get Accounts
     # Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.  You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
     # @return [Hash<String, Object>]
     def get_accounts(opts = {})
       data, _status_code, _headers = get_accounts_with_http_info(opts)
@@ -104,7 +104,7 @@ def get_accounts(opts = {})
     # Get Accounts
     # Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.  You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.&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;accounts:read&#x60;
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+    # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-12-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_accounts_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -124,7 +124,7 @@ def get_accounts_with_http_info(opts = {})
       # header parameters
       header_params = opts[:header_params] || {}
       # klaviyo api revision
-      header_params['revision'] =  ENV['API_REVISION'] || "2023-10-15"
+      header_params['revision'] =  ENV['API_REVISION'] || "2023-12-15"
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])