klaviyo-api-sdk 13.0.1 → 14.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +434 -286
  4. data/klaviyo-api-sdk.gemspec +1 -1
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +87 -87
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +235 -235
  8. data/lib/klaviyo-api-sdk/api/coupons_api.rb +68 -68
  9. data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +384 -0
  10. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
  11. data/lib/klaviyo-api-sdk/api/events_api.rb +35 -35
  12. data/lib/klaviyo-api-sdk/api/flows_api.rb +93 -93
  13. data/lib/klaviyo-api-sdk/api/forms_api.rb +40 -40
  14. data/lib/klaviyo-api-sdk/api/images_api.rb +15 -15
  15. data/lib/klaviyo-api-sdk/api/lists_api.rb +60 -60
  16. data/lib/klaviyo-api-sdk/api/metrics_api.rb +643 -59
  17. data/lib/klaviyo-api-sdk/api/profiles_api.rb +134 -134
  18. data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -13
  19. data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -21
  20. data/lib/klaviyo-api-sdk/api/segments_api.rb +54 -54
  21. data/lib/klaviyo-api-sdk/api/tags_api.rb +58 -58
  22. data/lib/klaviyo-api-sdk/api/templates_api.rb +36 -36
  23. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +15 -15
  24. data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +15 -15
  25. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -15
  26. data/lib/klaviyo-api-sdk/api_client.rb +1 -1
  27. data/lib/klaviyo-api-sdk/models/ab_test_action_data_current_experiment.rb +2 -15
  28. data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +1 -1
  29. data/lib/klaviyo-api-sdk/models/button_block.rb +247 -0
  30. data/lib/klaviyo-api-sdk/models/{custom_object_property_enum.rb → button_enum.rb} +4 -4
  31. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +3 -0
  33. data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
  34. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +16 -5
  35. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +16 -5
  36. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +2 -0
  37. data/lib/klaviyo-api-sdk/models/data_source_create_query.rb +223 -0
  38. data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object.rb +237 -0
  39. data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object_attributes.rb +284 -0
  40. data/lib/klaviyo-api-sdk/models/data_source_enum.rb +35 -0
  41. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query.rb +223 -0
  42. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +246 -0
  43. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +219 -0
  44. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +218 -0
  45. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships_data_source.rb +218 -0
  46. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_enum.rb +35 -0
  47. data/lib/klaviyo-api-sdk/models/data_source_record_enum.rb +35 -0
  48. data/lib/klaviyo-api-sdk/models/data_source_record_resource_object.rb +237 -0
  49. data/lib/klaviyo-api-sdk/models/data_source_record_resource_object_attributes.rb +223 -0
  50. data/lib/klaviyo-api-sdk/models/drop_shadow_block.rb +247 -0
  51. data/lib/klaviyo-api-sdk/models/drop_shadow_enum.rb +35 -0
  52. data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter.rb → dsr_bulk_create_attrs_data_source_records.rb} +15 -14
  53. data/lib/klaviyo-api-sdk/models/dsr_bulk_create_rels_data_source_data.rb +238 -0
  54. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
  56. data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
  57. data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
  58. data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
  59. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +2 -1
  60. data/lib/klaviyo-api-sdk/models/horizontal_rule_block.rb +247 -0
  61. data/lib/klaviyo-api-sdk/models/horizontal_rule_enum.rb +35 -0
  62. data/lib/klaviyo-api-sdk/models/image_block.rb +247 -0
  63. data/lib/klaviyo-api-sdk/models/is_rcs_capable_enum.rb +35 -0
  64. data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
  65. data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter2.rb +117 -0
  66. data/lib/klaviyo-api-sdk/models/mapped_metric_enum.rb +35 -0
  67. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query.rb +223 -0
  68. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object.rb +281 -0
  69. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships.rb +227 -0
  70. data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter_condition_groups_inner.rb → mapped_metric_partial_update_query_resource_object_relationships_custom_metric.rb} +10 -17
  71. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_custom_metric_data.rb +238 -0
  72. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric.rb +218 -0
  73. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric_data.rb +238 -0
  74. data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +195 -87
  76. data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +117 -0
  77. data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
  78. data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter_condition_groups_inner_conditions_inner.rb → price_drop_condition_filter2.rb} +16 -5
  79. data/lib/klaviyo-api-sdk/models/priority_enum.rb +35 -0
  80. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +327 -0
  81. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_filter.rb +251 -0
  82. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +327 -0
  83. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_filter.rb +286 -0
  84. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_date_condition.rb +286 -0
  85. data/lib/klaviyo-api-sdk/models/rank_enum.rb +35 -0
  86. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/spacer_block.rb +247 -0
  88. data/lib/klaviyo-api-sdk/models/spacer_enum.rb +35 -0
  89. data/lib/klaviyo-api-sdk/models/{custom_object_property_condition.rb → subscribed_smsis_rcs_capable_filter.rb} +6 -34
  90. data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +6 -2
  91. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +5 -0
  92. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +5 -0
  93. data/lib/klaviyo-api-sdk.rb +46 -6
  94. data/lib/klaviyo-api-sdk.rb.bak +979 -0
  95. metadata +48 -7
@@ -16,7 +16,7 @@ require "klaviyo-api-sdk/version"
16
16
 
17
17
  Gem::Specification.new do |s|
18
18
  s.name = "klaviyo-api-sdk"
19
- s.version = "13.0.1"
19
+ s.version = "14.0.1"
20
20
  s.authors = ['Klaviyo Team']
21
21
  s.email = ['libraries@klaviyo.com']
22
22
  s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
@@ -22,7 +22,7 @@ module KlaviyoAPI
22
22
  # 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`
23
23
  # @param id [String] The ID of the account
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
25
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
26
26
  # @return [Hash<String, Object>]
27
27
  def get_account(id, opts = {})
28
28
  data, _status_code, _headers = get_account_with_http_info(id, opts)
@@ -33,7 +33,7 @@ module KlaviyoAPI
33
33
  # 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;
34
34
  # @param id [String] The ID of the account
35
35
  # @param [Hash] opts the optional parameters
36
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
36
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
37
37
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
38
38
  def get_account_with_http_info(id, opts = {})
39
39
  if @api_client.config.debugging
@@ -57,7 +57,7 @@ module KlaviyoAPI
57
57
  # header parameters
58
58
  header_params = opts[:header_params] || {}
59
59
  # klaviyo api revision
60
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
60
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
61
61
  # HTTP header 'Accept' (if needed)
62
62
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
63
63
 
@@ -93,7 +93,7 @@ module KlaviyoAPI
93
93
  # Get Accounts
94
94
  # 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`
95
95
  # @param [Hash] opts the optional parameters
96
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
96
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
97
97
  # @return [Hash<String, Object>]
98
98
  def get_accounts(opts = {})
99
99
  data, _status_code, _headers = get_accounts_with_http_info(opts)
@@ -103,7 +103,7 @@ module KlaviyoAPI
103
103
  # Get Accounts
104
104
  # 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;
105
105
  # @param [Hash] opts the optional parameters
106
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
106
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
107
107
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
108
108
  def get_accounts_with_http_info(opts = {})
109
109
  if @api_client.config.debugging
@@ -123,7 +123,7 @@ module KlaviyoAPI
123
123
  # header parameters
124
124
  header_params = opts[:header_params] || {}
125
125
  # klaviyo api revision
126
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
126
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
127
127
  # HTTP header 'Accept' (if needed)
128
128
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
129
129