klaviyo-api-sdk 17.0.0 → 19.0.0

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 (549) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +66 -0
  3. data/README.md +2261 -677
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
  6. data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
  7. data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
  8. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3334 -629
  9. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
  10. data/lib/klaviyo-api-sdk/api/client_api.rb +96 -0
  11. data/lib/klaviyo-api-sdk/api/conversations_api.rb +3 -3
  12. data/lib/klaviyo-api-sdk/api/coupons_api.rb +187 -108
  13. data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +2758 -83
  14. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
  15. data/lib/klaviyo-api-sdk/api/events_api.rb +72 -58
  16. data/lib/klaviyo-api-sdk/api/flows_api.rb +315 -152
  17. data/lib/klaviyo-api-sdk/api/forms_api.rb +330 -60
  18. data/lib/klaviyo-api-sdk/api/images_api.rb +48 -27
  19. data/lib/klaviyo-api-sdk/api/lists_api.rb +113 -88
  20. data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -156
  21. data/lib/klaviyo-api-sdk/api/profiles_api.rb +445 -226
  22. data/lib/klaviyo-api-sdk/api/reporting_api.rb +76 -27
  23. data/lib/klaviyo-api-sdk/api/reviews_api.rb +38 -31
  24. data/lib/klaviyo-api-sdk/api/segments_api.rb +107 -82
  25. data/lib/klaviyo-api-sdk/api/tags_api.rb +164 -128
  26. data/lib/klaviyo-api-sdk/api/templates_api.rb +291 -78
  27. data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
  28. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
  29. data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
  30. data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +41 -27
  31. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +73 -31
  32. data/lib/klaviyo-api-sdk/api_client.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/ab_test_action_link_only.rb +271 -0
  34. data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → ab_test_settings.rb} +39 -34
  35. data/lib/klaviyo-api-sdk/models/action_output_condition.rb +1 -1
  36. data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +78 -195
  37. data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +2 -6
  38. data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters.rb → action_output_split_action_data_action_output_filter.rb} +4 -4
  39. data/lib/klaviyo-api-sdk/models/{action_output_condition_condition_group.rb → action_output_split_action_data_action_output_filter_condition_groups_inner.rb} +3 -3
  40. data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → action_output_split_action_link_only.rb} +30 -31
  41. data/lib/klaviyo-api-sdk/models/address.rb +295 -0
  42. data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +20 -1
  43. data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
  44. data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
  45. data/lib/klaviyo-api-sdk/models/{drop_shadow_block_v0.rb → api_schema_property.rb} +42 -34
  46. data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
  47. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
  48. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
  49. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
  50. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
  51. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
  52. data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
  53. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
  54. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
  55. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships.rb +232 -0
  56. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
  57. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
  58. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
  59. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
  60. data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
  61. data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
  62. data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
  63. data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
  64. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
  65. data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
  66. data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +20 -1
  67. data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
  68. data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +15 -2
  69. data/lib/klaviyo-api-sdk/models/base_style_properties.rb +15 -5
  70. data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
  71. data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
  72. data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
  73. data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
  74. data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
  75. data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
  76. data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
  77. data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
  78. data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
  79. data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
  80. data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
  81. data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
  82. data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
  83. data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
  84. data/lib/klaviyo-api-sdk/models/{metric_property_condition_condition_group.rb → brand_color_partial_update_query_resource_object_attributes.rb} +22 -16
  85. data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
  86. data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
  87. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
  88. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
  89. data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +20 -26
  90. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
  91. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
  92. data/lib/klaviyo-api-sdk/models/{content_repeat_v0.rb → brand_email_default_partial_update_query_resource_object_relationships_brand_button_data.rb} +22 -22
  93. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
  94. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
  95. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
  96. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
  97. data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → brand_email_footer_patch_attributes.rb} +43 -35
  98. data/lib/klaviyo-api-sdk/models/brand_email_header_patch_attributes.rb +253 -0
  99. data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
  100. data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
  101. data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → brand_library_text_styles_letter_spacing.rb} +3 -3
  102. data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
  103. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
  104. data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
  105. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
  106. data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
  107. data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
  108. data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
  109. data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
  110. data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
  111. data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
  112. data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
  113. data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
  114. data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
  115. data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes_social_links_inner.rb +104 -0
  116. data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
  117. data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
  118. data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object.rb → brand_social_group_partial_update_query_resource_object.rb} +6 -6
  119. data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
  120. data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
  121. data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
  122. data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
  123. data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
  124. data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
  125. data/lib/klaviyo-api-sdk/models/button_action.rb +2 -0
  126. data/lib/klaviyo-api-sdk/models/button_properties.rb +20 -1
  127. data/lib/klaviyo-api-sdk/models/button_styles.rb +34 -3
  128. data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → button_styles_height.rb} +3 -4
  129. data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
  130. data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
  131. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
  132. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
  133. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
  134. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
  135. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
  136. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
  137. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
  138. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
  139. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
  140. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
  141. data/lib/klaviyo-api-sdk/models/campaign_definition.rb +273 -0
  142. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
  143. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
  144. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
  145. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
  146. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
  147. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
  148. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
  149. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
  150. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
  151. data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
  152. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
  154. data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
  155. data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
  156. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
  157. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
  158. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
  159. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
  160. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
  161. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
  162. data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
  163. data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → cart_content.rb} +23 -25
  164. data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
  165. data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +20 -1
  166. data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
  167. data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_subscription_parameters.rb} +22 -21
  168. data/lib/klaviyo-api-sdk/models/click_tracking_unsubscription_parameters.rb +258 -0
  169. data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
  170. data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → code_action_link_only.rb} +23 -9
  171. data/lib/klaviyo-api-sdk/models/color.rb +237 -0
  172. data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
  173. data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
  174. data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
  175. data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → constant_property_mapping.rb} +25 -26
  176. data/lib/klaviyo-api-sdk/models/constant_property_mapping_value.rb +107 -0
  177. data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/{send_push_notification_action_content_experiment_action_data.rb → content_experiment_action_data.rb} +6 -5
  179. data/lib/klaviyo-api-sdk/models/{send_push_notification_action_current_experiment.rb → content_experiment_action_data_current_experiment.rb} +6 -6
  180. data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → content_experiment_action_data_main_action.rb} +3 -3
  181. data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
  182. data/lib/klaviyo-api-sdk/models/continue_with_shop.rb +286 -0
  183. data/lib/klaviyo-api-sdk/models/continue_with_shop_autofill.rb +264 -0
  184. data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
  185. data/lib/klaviyo-api-sdk/models/continue_with_shop_properties.rb +327 -0
  186. data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
  187. data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
  188. data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
  189. data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +43 -1
  190. data/lib/klaviyo-api-sdk/models/coupon_assigner_configuration.rb +285 -0
  191. data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
  192. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
  193. data/lib/klaviyo-api-sdk/models/coupon_properties.rb +20 -1
  194. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
  195. data/lib/klaviyo-api-sdk/models/{push_send_options.rb → custom_css.rb} +22 -13
  196. data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
  197. data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +272 -0
  198. data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +460 -0
  199. data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter.rb → custom_object_date_trigger_trigger_filter.rb} +4 -4
  200. data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters_condition_groups_inner.rb → custom_object_date_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
  201. data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → custom_object_relationship_source.rb} +69 -34
  203. data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
  204. data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
  205. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
  206. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
  207. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
  208. data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
  209. data/lib/klaviyo-api-sdk/models/date_properties.rb +20 -1
  210. data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
  211. data/lib/klaviyo-api-sdk/models/display_options.rb +24 -4
  212. data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +20 -1
  213. data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
  214. data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
  215. data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
  216. data/lib/klaviyo-api-sdk/models/email_header_link.rb +237 -0
  217. data/lib/klaviyo-api-sdk/models/email_properties.rb +20 -1
  218. data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
  219. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +22 -9
  220. data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +22 -9
  221. data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object.rb +237 -0
  222. data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes.rb +292 -0
  223. data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes_source_mapping.rb +224 -0
  224. data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
  225. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +15 -2
  226. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
  227. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
  228. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +14 -1
  229. data/lib/klaviyo-api-sdk/models/first_party_social_link.rb +271 -0
  230. data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
  231. data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
  232. data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
  233. data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
  234. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
  235. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
  236. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_anchor_action.rb +224 -0
  237. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
  238. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
  239. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
  240. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
  241. data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
  242. data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
  243. data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
  244. data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +1 -0
  245. data/lib/klaviyo-api-sdk/models/flow_email.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
  247. data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +15 -5
  248. data/lib/klaviyo-api-sdk/models/flow_sms.rb +15 -2
  249. data/lib/klaviyo-api-sdk/models/flow_sms_message_hierarchy_inner.rb +104 -0
  250. data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
  251. data/lib/klaviyo-api-sdk/models/flow_whats_app_with_ac.rb +303 -0
  252. data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
  253. data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
  254. data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
  255. data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
  256. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
  257. data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → form_publish_job_create_query_resource_object.rb} +22 -22
  258. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
  259. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
  260. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
  261. data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
  262. data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
  263. data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
  264. data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
  265. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image.rb → form_unpublish_job_create_query_resource_object_relationships_form.rb} +4 -4
  266. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image_data.rb → form_unpublish_job_create_query_resource_object_relationships_form_data.rb} +5 -5
  267. data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
  268. data/lib/klaviyo-api-sdk/models/html_text_properties.rb +20 -1
  269. data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
  270. data/lib/klaviyo-api-sdk/models/{render_options.rb → iaf_deeplink_to_screen_properties.rb} +32 -37
  271. data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → iaf_open_url.rb} +42 -34
  272. data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
  273. data/lib/klaviyo-api-sdk/models/image_action.rb +2 -0
  274. data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
  275. data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +0 -35
  276. data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
  277. data/lib/klaviyo-api-sdk/models/image_properties.rb +20 -1
  278. data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
  279. data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
  280. data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
  281. data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
  282. data/lib/klaviyo-api-sdk/models/link_text_styles_letter_spacing.rb +104 -0
  283. data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
  284. data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +2 -6
  286. data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters.rb → low_inventory_trigger_trigger_filter.rb} +4 -4
  287. data/lib/klaviyo-api-sdk/models/{low_inventory_condition_condition_group.rb → low_inventory_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
  288. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
  289. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
  290. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
  291. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_configuration.rb +272 -0
  292. data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
  293. data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
  294. data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
  295. data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
  296. data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
  297. data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
  298. data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
  299. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
  300. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
  301. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
  302. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
  303. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
  304. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
  305. data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters_condition_groups_inner.rb → message_create_query_resource_object_relationships_campaign_data.rb} +28 -15
  306. data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
  307. data/lib/klaviyo-api-sdk/models/message_hierarchy_rcs_item.rb +296 -0
  308. data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
  309. data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
  310. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
  311. data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
  312. data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
  313. data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
  314. data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
  315. data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
  316. data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → message_tracking_options.rb} +25 -32
  317. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -2
  318. data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +87 -195
  320. data/lib/klaviyo-api-sdk/models/metric_trigger.rb +2 -1
  321. data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters.rb → metric_trigger_trigger_filter.rb} +4 -4
  322. data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters_condition_groups_inner.rb → metric_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
  323. data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → multi_branch_split_action_link_only.rb} +7 -33
  324. data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
  325. data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +9 -0
  326. data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
  327. data/lib/klaviyo-api-sdk/models/object_record_bulk_delete_job_enum.rb +35 -0
  328. data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query.rb +223 -0
  329. data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object.rb +237 -0
  330. data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships.rb +223 -0
  331. data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships_object_records.rb +220 -0
  332. data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → object_record_delete_job_rels_records_data_inner.rb} +27 -31
  333. data/lib/klaviyo-api-sdk/models/object_record_enum.rb +35 -0
  334. data/lib/klaviyo-api-sdk/models/object_schema_create_query.rb +223 -0
  335. data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object.rb +246 -0
  336. data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_attributes.rb +322 -0
  337. data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships.rb +218 -0
  338. data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type.rb +218 -0
  339. data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type_data.rb +238 -0
  340. data/lib/klaviyo-api-sdk/models/object_schema_enum.rb +35 -0
  341. data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query.rb +223 -0
  342. data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object.rb +252 -0
  343. data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object_attributes.rb +302 -0
  344. data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_meta.rb +237 -0
  345. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → object_schema_relationship_create_query.rb} +4 -5
  346. data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_query_data_inner.rb +247 -0
  347. data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_meta.rb +224 -0
  348. data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query.rb +225 -0
  349. data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query_data_inner.rb +247 -0
  350. data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query.rb +223 -0
  351. data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query_data.rb +247 -0
  352. data/lib/klaviyo-api-sdk/models/object_schema_relationship_update_meta.rb +246 -0
  353. data/lib/klaviyo-api-sdk/models/object_type_create_query.rb +223 -0
  354. data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object.rb +237 -0
  355. data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → object_type_create_query_resource_object_attributes.rb} +59 -62
  356. data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes_object_schema.rb +224 -0
  357. data/lib/klaviyo-api-sdk/models/object_type_enum.rb +35 -0
  358. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +13 -4
  360. data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → open_tracking_subscription_parameters.rb} +22 -22
  361. data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
  362. data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +20 -1
  363. data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
  364. data/lib/klaviyo-api-sdk/models/{email_send_options.rb → patch_identifiers.rb} +19 -14
  365. data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +20 -1
  366. data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
  367. data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +2 -6
  369. data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter.rb → price_drop_trigger_trigger_filter.rb} +4 -4
  370. data/lib/klaviyo-api-sdk/models/{price_drop_condition_condition_group.rb → price_drop_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
  371. data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +29 -9
  372. data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
  373. data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/{profile_has_not_received_push_message_condition_timeframe_filter.rb → profile_has_not_received_email_message_condition_timeframe_filter.rb} +1 -1
  375. data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/profile_meta.rb +13 -4
  378. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
  379. data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +1 -1
  380. data/lib/klaviyo-api-sdk/models/profile_object_schema_enum.rb +35 -0
  381. data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query.rb +225 -0
  382. data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query_data_inner.rb +247 -0
  383. data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query.rb +225 -0
  384. data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query_data_inner.rb +247 -0
  385. data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query.rb +223 -0
  386. data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query_data.rb +247 -0
  387. data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
  388. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +2 -2
  389. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +2 -2
  390. data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
  391. data/lib/klaviyo-api-sdk/models/profile_relationship_source.rb +330 -0
  392. data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → property_filter.rb} +29 -14
  393. data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → property_source.rb} +34 -31
  394. data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
  395. data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +29 -13
  396. data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
  397. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
  398. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
  399. data/lib/klaviyo-api-sdk/models/quote_style.rb +21 -1
  400. data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +20 -1
  401. data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
  402. data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
  403. data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
  404. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → rcs_card_video.rb} +4 -5
  405. data/lib/klaviyo-api-sdk/models/rcs_rich_content.rb +244 -0
  406. data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → rcs_suggestion.rb} +63 -34
  407. data/lib/klaviyo-api-sdk/models/redirect_properties.rb +2 -5
  408. data/lib/klaviyo-api-sdk/models/related_id_path.rb +273 -0
  409. data/lib/klaviyo-api-sdk/models/review_block_styles.rb +13 -13
  410. data/lib/klaviyo-api-sdk/models/review_properties.rb +20 -1
  411. data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
  412. data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
  413. data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +3 -0
  414. data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
  415. data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
  416. data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
  417. data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
  418. data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
  419. data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
  420. data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
  421. data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
  422. data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
  423. data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
  424. data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +20 -1
  425. data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → simple_property_mapping.rb} +28 -34
  426. data/lib/klaviyo-api-sdk/models/simple_relationship_mapping.rb +287 -0
  427. data/lib/klaviyo-api-sdk/models/simple_relationship_mapping_source.rb +105 -0
  428. data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
  429. data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
  430. data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +20 -1
  431. data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
  432. data/lib/klaviyo-api-sdk/models/sms_disclosure_link_text_style.rb +319 -0
  433. data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +20 -1
  434. data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +1 -1
  435. data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object.rb +237 -0
  436. data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → source_mapping_create_query_resource_object_attributes.rb} +23 -21
  437. data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes_property_mappings_inner.rb +104 -0
  438. data/lib/klaviyo-api-sdk/models/source_mapping_enum.rb +35 -0
  439. data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query.rb +223 -0
  440. data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query_resource_object.rb +252 -0
  441. data/lib/klaviyo-api-sdk/models/spacing_styles.rb +265 -0
  442. data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +20 -1
  443. data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
  444. data/lib/klaviyo-api-sdk/models/string_phone_operator_string_array_filter.rb +1 -1
  445. data/lib/klaviyo-api-sdk/models/table_fallback_image_sub_block.rb +0 -13
  446. data/lib/klaviyo-api-sdk/models/table_image_sub_block.rb +0 -13
  447. data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
  448. data/lib/klaviyo-api-sdk/models/template_definition.rb +1 -0
  449. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
  450. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
  451. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
  452. data/lib/klaviyo-api-sdk/models/{audiences.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +19 -26
  453. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
  454. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
  455. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
  456. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
  457. data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
  458. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
  459. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
  460. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
  461. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
  462. data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
  463. data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
  464. data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
  465. data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
  466. data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
  467. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
  468. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
  469. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
  470. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
  471. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
  472. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
  473. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
  474. data/lib/klaviyo-api-sdk/models/text_properties.rb +20 -1
  475. data/lib/klaviyo-api-sdk/models/text_style_overrides.rb +294 -0
  476. data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
  477. data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
  478. data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → throttled_options.rb} +31 -32
  479. data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
  480. data/lib/klaviyo-api-sdk/models/timezone_options.rb +222 -0
  481. data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
  482. data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
  483. data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
  484. data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
  485. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
  486. data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
  487. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
  488. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
  489. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
  490. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
  491. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
  492. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
  493. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
  494. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
  495. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
  496. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
  497. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
  498. data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
  499. data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
  500. data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
  501. data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object_attributes.rb +257 -0
  502. data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
  503. data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
  504. data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
  505. data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
  506. data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
  507. data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
  508. data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object_attributes.rb → universal_content_create_query_v1_resource_object_attributes.rb} +4 -4
  509. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_strategy.rb → universal_content_create_query_v1_resource_object_attributes_definition.rb} +17 -6
  510. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
  511. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
  512. data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object_attributes.rb → universal_content_partial_update_query_v1_resource_object_attributes.rb} +4 -4
  513. data/lib/klaviyo-api-sdk/models/{action_output_condition_filter2.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -7
  514. data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
  515. data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
  516. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
  517. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
  518. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
  519. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
  520. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
  521. data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
  522. data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → variation_definition_details.rb} +6 -5
  523. data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
  524. data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
  525. data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
  526. data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
  527. data/lib/klaviyo-api-sdk/models/version.rb +39 -4
  528. data/lib/klaviyo-api-sdk/models/version_properties.rb +14 -4
  529. data/lib/klaviyo-api-sdk/models/version_styles.rb +15 -6
  530. data/lib/klaviyo-api-sdk/models/version_triggers_inner.rb +1 -0
  531. data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
  532. data/lib/klaviyo-api-sdk.rb +389 -99
  533. data/lib/klaviyo-api-sdk.rb.bak +390 -100
  534. metadata +399 -103
  535. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_definition.rb +0 -106
  536. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
  537. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
  538. data/lib/klaviyo-api-sdk/models/custom_object_property_condition_filter.rb +0 -117
  539. data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
  540. data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
  541. data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
  542. data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter2.rb +0 -117
  543. data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +0 -117
  544. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
  545. data/lib/klaviyo-api-sdk/models/price_drop_condition_filter2.rb +0 -117
  546. data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
  547. data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
  548. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
  549. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
@@ -0,0 +1,1933 @@
1
+ =begin
2
+ #Klaviyo API
3
+
4
+ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
+
6
+ Contact: developers@klaviyo.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 6.2.1
9
+
10
+ =end
11
+
12
+ require 'cgi'
13
+
14
+ module KlaviyoAPI
15
+ class BrandsApi
16
+ attr_accessor :api_client
17
+
18
+ def initialize(api_client = ApiClient.default)
19
+ @api_client = api_client
20
+ end
21
+ # Create Brand Button
22
+ # Create a new brand button.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_button.json)
23
+ # @param brand_button_create_query [BrandButtonCreateQuery]
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
26
+ # @return [Hash<String, Object>]
27
+ def create_brand_button(brand_button_create_query, opts = {})
28
+ data, _status_code, _headers = create_brand_button_with_http_info(brand_button_create_query, opts)
29
+ data
30
+ end
31
+
32
+ # Create Brand Button
33
+ # Create a new brand button.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_button.json)
34
+ # @param brand_button_create_query [BrandButtonCreateQuery]
35
+ # @param [Hash] opts the optional parameters
36
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
37
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
38
+ def create_brand_button_with_http_info(brand_button_create_query, opts = {})
39
+ if @api_client.config.debugging
40
+ @api_client.config.logger.debug 'Calling API: BrandsApi.create_brand_button ...'
41
+ end
42
+ # verify the required parameter 'brand_button_create_query' is set
43
+ if @api_client.config.client_side_validation && brand_button_create_query.nil?
44
+ fail ArgumentError, "Missing the required parameter 'brand_button_create_query' when calling BrandsApi.create_brand_button"
45
+ end
46
+ allowable_values = ["border", "border.border_color", "border.border_style", "border.border_width", "border.is_border_active", "id", "is_primary", "name", "preview_page_hex", "spacing", "spacing.padding_bottom", "spacing.padding_left", "spacing.padding_right", "spacing.padding_top", "style", "style.background_color", "style.border_radius", "style.box_shadow", "style.is_shadow_active", "text", "text.color", "text.font_family", "text.font_size", "text.font_style", "text.font_weight", "text.letter_spacing", "text.text_decoration"]
47
+ if @api_client.config.client_side_validation && opts[:'fields_brand_button'] && !opts[:'fields_brand_button'].all? { |item| allowable_values.include?(item) }
48
+ fail ArgumentError, "invalid value for \"fields_brand_button\", must include one of #{allowable_values}"
49
+ end
50
+ # resource path
51
+ local_var_path = '/api/brand-buttons'
52
+
53
+ # query parameters
54
+ query_params = opts[:query_params] || {}
55
+ query_params[:'fields[brand-button]'] = @api_client.build_collection_param(opts[:'fields_brand_button'], :csv) if !opts[:'fields_brand_button'].nil?
56
+
57
+ # header parameters
58
+ header_params = opts[:header_params] || {}
59
+ # klaviyo api revision
60
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
61
+ # HTTP header 'Accept' (if needed)
62
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
63
+ # HTTP header 'Content-Type'
64
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
65
+ if !content_type.nil?
66
+ header_params['Content-Type'] = content_type
67
+ end
68
+
69
+ # form parameters
70
+ form_params = opts[:form_params] || {}
71
+
72
+ # http body (model)
73
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_button_create_query)
74
+
75
+ # return_type
76
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
77
+
78
+ # auth_names
79
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
80
+
81
+ new_options = opts.merge(
82
+ :operation => :"BrandsApi.create_brand_button",
83
+ :header_params => header_params,
84
+ :query_params => query_params,
85
+ :form_params => form_params,
86
+ :body => post_body,
87
+ :auth_names => auth_names,
88
+ :return_type => return_type
89
+ )
90
+
91
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug "API called: BrandsApi#create_brand_button\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
94
+ end
95
+ return data, status_code, headers
96
+ end
97
+
98
+ # Create Brand Color
99
+ # Create a new brand color group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_color.json)
100
+ # @param brand_color_create_query [BrandColorCreateQuery]
101
+ # @param [Hash] opts the optional parameters
102
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
103
+ # @return [Hash<String, Object>]
104
+ def create_brand_color(brand_color_create_query, opts = {})
105
+ data, _status_code, _headers = create_brand_color_with_http_info(brand_color_create_query, opts)
106
+ data
107
+ end
108
+
109
+ # Create Brand Color
110
+ # Create a new brand color group.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_color.json)
111
+ # @param brand_color_create_query [BrandColorCreateQuery]
112
+ # @param [Hash] opts the optional parameters
113
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
114
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
115
+ def create_brand_color_with_http_info(brand_color_create_query, opts = {})
116
+ if @api_client.config.debugging
117
+ @api_client.config.logger.debug 'Calling API: BrandsApi.create_brand_color ...'
118
+ end
119
+ # verify the required parameter 'brand_color_create_query' is set
120
+ if @api_client.config.client_side_validation && brand_color_create_query.nil?
121
+ fail ArgumentError, "Missing the required parameter 'brand_color_create_query' when calling BrandsApi.create_brand_color"
122
+ end
123
+ allowable_values = ["colors", "id", "name"]
124
+ if @api_client.config.client_side_validation && opts[:'fields_brand_color'] && !opts[:'fields_brand_color'].all? { |item| allowable_values.include?(item) }
125
+ fail ArgumentError, "invalid value for \"fields_brand_color\", must include one of #{allowable_values}"
126
+ end
127
+ # resource path
128
+ local_var_path = '/api/brand-colors'
129
+
130
+ # query parameters
131
+ query_params = opts[:query_params] || {}
132
+ query_params[:'fields[brand-color]'] = @api_client.build_collection_param(opts[:'fields_brand_color'], :csv) if !opts[:'fields_brand_color'].nil?
133
+
134
+ # header parameters
135
+ header_params = opts[:header_params] || {}
136
+ # klaviyo api revision
137
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
138
+ # HTTP header 'Accept' (if needed)
139
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
140
+ # HTTP header 'Content-Type'
141
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
142
+ if !content_type.nil?
143
+ header_params['Content-Type'] = content_type
144
+ end
145
+
146
+ # form parameters
147
+ form_params = opts[:form_params] || {}
148
+
149
+ # http body (model)
150
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_color_create_query)
151
+
152
+ # return_type
153
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
154
+
155
+ # auth_names
156
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
157
+
158
+ new_options = opts.merge(
159
+ :operation => :"BrandsApi.create_brand_color",
160
+ :header_params => header_params,
161
+ :query_params => query_params,
162
+ :form_params => form_params,
163
+ :body => post_body,
164
+ :auth_names => auth_names,
165
+ :return_type => return_type
166
+ )
167
+
168
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug "API called: BrandsApi#create_brand_color\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
171
+ end
172
+ return data, status_code, headers
173
+ end
174
+
175
+ # Create Brand Logo
176
+ # Create a new brand logo.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_logo.json)
177
+ # @param brand_logo_create_query [BrandLogoCreateQuery] POST /api/brand-logos — link a new logo to an existing image asset. The &#x60;image&#x60; relationship (required) references the image the logo renders — manage image assets via the v3 Images API.
178
+ # @param [Hash] opts the optional parameters
179
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
180
+ # @return [Hash<String, Object>]
181
+ def create_brand_logo(brand_logo_create_query, opts = {})
182
+ data, _status_code, _headers = create_brand_logo_with_http_info(brand_logo_create_query, opts)
183
+ data
184
+ end
185
+
186
+ # Create Brand Logo
187
+ # Create a new brand logo.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_logo.json)
188
+ # @param brand_logo_create_query [BrandLogoCreateQuery] POST /api/brand-logos — link a new logo to an existing image asset. The &#x60;image&#x60; relationship (required) references the image the logo renders — manage image assets via the v3 Images API.
189
+ # @param [Hash] opts the optional parameters
190
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
191
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
192
+ def create_brand_logo_with_http_info(brand_logo_create_query, opts = {})
193
+ if @api_client.config.debugging
194
+ @api_client.config.logger.debug 'Calling API: BrandsApi.create_brand_logo ...'
195
+ end
196
+ # verify the required parameter 'brand_logo_create_query' is set
197
+ if @api_client.config.client_side_validation && brand_logo_create_query.nil?
198
+ fail ArgumentError, "Missing the required parameter 'brand_logo_create_query' when calling BrandsApi.create_brand_logo"
199
+ end
200
+ allowable_values = ["alt_text", "height", "id", "link_url", "name", "width"]
201
+ if @api_client.config.client_side_validation && opts[:'fields_brand_logo'] && !opts[:'fields_brand_logo'].all? { |item| allowable_values.include?(item) }
202
+ fail ArgumentError, "invalid value for \"fields_brand_logo\", must include one of #{allowable_values}"
203
+ end
204
+ # resource path
205
+ local_var_path = '/api/brand-logos'
206
+
207
+ # query parameters
208
+ query_params = opts[:query_params] || {}
209
+ query_params[:'fields[brand-logo]'] = @api_client.build_collection_param(opts[:'fields_brand_logo'], :csv) if !opts[:'fields_brand_logo'].nil?
210
+
211
+ # header parameters
212
+ header_params = opts[:header_params] || {}
213
+ # klaviyo api revision
214
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
215
+ # HTTP header 'Accept' (if needed)
216
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
217
+ # HTTP header 'Content-Type'
218
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
219
+ if !content_type.nil?
220
+ header_params['Content-Type'] = content_type
221
+ end
222
+
223
+ # form parameters
224
+ form_params = opts[:form_params] || {}
225
+
226
+ # http body (model)
227
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_logo_create_query)
228
+
229
+ # return_type
230
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
231
+
232
+ # auth_names
233
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
234
+
235
+ new_options = opts.merge(
236
+ :operation => :"BrandsApi.create_brand_logo",
237
+ :header_params => header_params,
238
+ :query_params => query_params,
239
+ :form_params => form_params,
240
+ :body => post_body,
241
+ :auth_names => auth_names,
242
+ :return_type => return_type
243
+ )
244
+
245
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
246
+ if @api_client.config.debugging
247
+ @api_client.config.logger.debug "API called: BrandsApi#create_brand_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
248
+ end
249
+ return data, status_code, headers
250
+ end
251
+
252
+ # Create Brand Social Group
253
+ # Create a new brand social group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_social_group.json)
254
+ # @param brand_social_group_create_query [BrandSocialGroupCreateQuery]
255
+ # @param [Hash] opts the optional parameters
256
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
257
+ # @return [Hash<String, Object>]
258
+ def create_brand_social_group(brand_social_group_create_query, opts = {})
259
+ data, _status_code, _headers = create_brand_social_group_with_http_info(brand_social_group_create_query, opts)
260
+ data
261
+ end
262
+
263
+ # Create Brand Social Group
264
+ # Create a new brand social group.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_brand_social_group.json)
265
+ # @param brand_social_group_create_query [BrandSocialGroupCreateQuery]
266
+ # @param [Hash] opts the optional parameters
267
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
268
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
269
+ def create_brand_social_group_with_http_info(brand_social_group_create_query, opts = {})
270
+ if @api_client.config.debugging
271
+ @api_client.config.logger.debug 'Calling API: BrandsApi.create_brand_social_group ...'
272
+ end
273
+ # verify the required parameter 'brand_social_group_create_query' is set
274
+ if @api_client.config.client_side_validation && brand_social_group_create_query.nil?
275
+ fail ArgumentError, "Missing the required parameter 'brand_social_group_create_query' when calling BrandsApi.create_brand_social_group"
276
+ end
277
+ allowable_values = ["id", "name", "social_links"]
278
+ if @api_client.config.client_side_validation && opts[:'fields_brand_social_group'] && !opts[:'fields_brand_social_group'].all? { |item| allowable_values.include?(item) }
279
+ fail ArgumentError, "invalid value for \"fields_brand_social_group\", must include one of #{allowable_values}"
280
+ end
281
+ # resource path
282
+ local_var_path = '/api/brand-social-groups'
283
+
284
+ # query parameters
285
+ query_params = opts[:query_params] || {}
286
+ query_params[:'fields[brand-social-group]'] = @api_client.build_collection_param(opts[:'fields_brand_social_group'], :csv) if !opts[:'fields_brand_social_group'].nil?
287
+
288
+ # header parameters
289
+ header_params = opts[:header_params] || {}
290
+ # klaviyo api revision
291
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
292
+ # HTTP header 'Accept' (if needed)
293
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
294
+ # HTTP header 'Content-Type'
295
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
296
+ if !content_type.nil?
297
+ header_params['Content-Type'] = content_type
298
+ end
299
+
300
+ # form parameters
301
+ form_params = opts[:form_params] || {}
302
+
303
+ # http body (model)
304
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_social_group_create_query)
305
+
306
+ # return_type
307
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
308
+
309
+ # auth_names
310
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
311
+
312
+ new_options = opts.merge(
313
+ :operation => :"BrandsApi.create_brand_social_group",
314
+ :header_params => header_params,
315
+ :query_params => query_params,
316
+ :form_params => form_params,
317
+ :body => post_body,
318
+ :auth_names => auth_names,
319
+ :return_type => return_type
320
+ )
321
+
322
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug "API called: BrandsApi#create_brand_social_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
325
+ end
326
+ return data, status_code, headers
327
+ end
328
+
329
+ # Delete Brand Button
330
+ # Delete the brand button with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_button.json)
331
+ # @param id [String] The ID of the brand button.
332
+ # @param [Hash] opts the optional parameters
333
+ # @return [nil]
334
+ def delete_brand_button(id, opts = {})
335
+ delete_brand_button_with_http_info(id, opts)
336
+ nil
337
+ end
338
+
339
+ # Delete Brand Button
340
+ # Delete the brand button with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_button.json)
341
+ # @param id [String] The ID of the brand button.
342
+ # @param [Hash] opts the optional parameters
343
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
344
+ def delete_brand_button_with_http_info(id, opts = {})
345
+ if @api_client.config.debugging
346
+ @api_client.config.logger.debug 'Calling API: BrandsApi.delete_brand_button ...'
347
+ end
348
+ # verify the required parameter 'id' is set
349
+ if @api_client.config.client_side_validation && id.nil?
350
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.delete_brand_button"
351
+ end
352
+ # resource path
353
+ local_var_path = '/api/brand-buttons/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
354
+
355
+ # query parameters
356
+ query_params = opts[:query_params] || {}
357
+
358
+ # header parameters
359
+ header_params = opts[:header_params] || {}
360
+ # klaviyo api revision
361
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
362
+ # HTTP header 'Accept' (if needed)
363
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
364
+
365
+ # form parameters
366
+ form_params = opts[:form_params] || {}
367
+
368
+ # http body (model)
369
+ post_body = opts[:debug_body]
370
+
371
+ # return_type
372
+ return_type = opts[:debug_return_type]
373
+
374
+ # auth_names
375
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
376
+
377
+ new_options = opts.merge(
378
+ :operation => :"BrandsApi.delete_brand_button",
379
+ :header_params => header_params,
380
+ :query_params => query_params,
381
+ :form_params => form_params,
382
+ :body => post_body,
383
+ :auth_names => auth_names,
384
+ :return_type => return_type
385
+ )
386
+
387
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
388
+ if @api_client.config.debugging
389
+ @api_client.config.logger.debug "API called: BrandsApi#delete_brand_button\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
390
+ end
391
+ return data, status_code, headers
392
+ end
393
+
394
+ # Delete Brand Color
395
+ # Delete the brand color group with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_color.json)
396
+ # @param id [String] The ID of the brand color group.
397
+ # @param [Hash] opts the optional parameters
398
+ # @return [nil]
399
+ def delete_brand_color(id, opts = {})
400
+ delete_brand_color_with_http_info(id, opts)
401
+ nil
402
+ end
403
+
404
+ # Delete Brand Color
405
+ # Delete the brand color group with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_color.json)
406
+ # @param id [String] The ID of the brand color group.
407
+ # @param [Hash] opts the optional parameters
408
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
409
+ def delete_brand_color_with_http_info(id, opts = {})
410
+ if @api_client.config.debugging
411
+ @api_client.config.logger.debug 'Calling API: BrandsApi.delete_brand_color ...'
412
+ end
413
+ # verify the required parameter 'id' is set
414
+ if @api_client.config.client_side_validation && id.nil?
415
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.delete_brand_color"
416
+ end
417
+ # resource path
418
+ local_var_path = '/api/brand-colors/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
419
+
420
+ # query parameters
421
+ query_params = opts[:query_params] || {}
422
+
423
+ # header parameters
424
+ header_params = opts[:header_params] || {}
425
+ # klaviyo api revision
426
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
427
+ # HTTP header 'Accept' (if needed)
428
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
429
+
430
+ # form parameters
431
+ form_params = opts[:form_params] || {}
432
+
433
+ # http body (model)
434
+ post_body = opts[:debug_body]
435
+
436
+ # return_type
437
+ return_type = opts[:debug_return_type]
438
+
439
+ # auth_names
440
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
441
+
442
+ new_options = opts.merge(
443
+ :operation => :"BrandsApi.delete_brand_color",
444
+ :header_params => header_params,
445
+ :query_params => query_params,
446
+ :form_params => form_params,
447
+ :body => post_body,
448
+ :auth_names => auth_names,
449
+ :return_type => return_type
450
+ )
451
+
452
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
453
+ if @api_client.config.debugging
454
+ @api_client.config.logger.debug "API called: BrandsApi#delete_brand_color\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
455
+ end
456
+ return data, status_code, headers
457
+ end
458
+
459
+ # Delete Brand Logo
460
+ # Delete the brand logo with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_logo.json)
461
+ # @param id [String] The ID of the brand logo.
462
+ # @param [Hash] opts the optional parameters
463
+ # @return [nil]
464
+ def delete_brand_logo(id, opts = {})
465
+ delete_brand_logo_with_http_info(id, opts)
466
+ nil
467
+ end
468
+
469
+ # Delete Brand Logo
470
+ # Delete the brand logo with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_logo.json)
471
+ # @param id [String] The ID of the brand logo.
472
+ # @param [Hash] opts the optional parameters
473
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
474
+ def delete_brand_logo_with_http_info(id, opts = {})
475
+ if @api_client.config.debugging
476
+ @api_client.config.logger.debug 'Calling API: BrandsApi.delete_brand_logo ...'
477
+ end
478
+ # verify the required parameter 'id' is set
479
+ if @api_client.config.client_side_validation && id.nil?
480
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.delete_brand_logo"
481
+ end
482
+ # resource path
483
+ local_var_path = '/api/brand-logos/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
484
+
485
+ # query parameters
486
+ query_params = opts[:query_params] || {}
487
+
488
+ # header parameters
489
+ header_params = opts[:header_params] || {}
490
+ # klaviyo api revision
491
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
492
+ # HTTP header 'Accept' (if needed)
493
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
494
+
495
+ # form parameters
496
+ form_params = opts[:form_params] || {}
497
+
498
+ # http body (model)
499
+ post_body = opts[:debug_body]
500
+
501
+ # return_type
502
+ return_type = opts[:debug_return_type]
503
+
504
+ # auth_names
505
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
506
+
507
+ new_options = opts.merge(
508
+ :operation => :"BrandsApi.delete_brand_logo",
509
+ :header_params => header_params,
510
+ :query_params => query_params,
511
+ :form_params => form_params,
512
+ :body => post_body,
513
+ :auth_names => auth_names,
514
+ :return_type => return_type
515
+ )
516
+
517
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
518
+ if @api_client.config.debugging
519
+ @api_client.config.logger.debug "API called: BrandsApi#delete_brand_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
520
+ end
521
+ return data, status_code, headers
522
+ end
523
+
524
+ # Delete Brand Social Group
525
+ # Delete the brand social group with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_social_group.json)
526
+ # @param id [String] The ID of the brand social group.
527
+ # @param [Hash] opts the optional parameters
528
+ # @return [nil]
529
+ def delete_brand_social_group(id, opts = {})
530
+ delete_brand_social_group_with_http_info(id, opts)
531
+ nil
532
+ end
533
+
534
+ # Delete Brand Social Group
535
+ # Delete the brand social group with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_brand_social_group.json)
536
+ # @param id [String] The ID of the brand social group.
537
+ # @param [Hash] opts the optional parameters
538
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
539
+ def delete_brand_social_group_with_http_info(id, opts = {})
540
+ if @api_client.config.debugging
541
+ @api_client.config.logger.debug 'Calling API: BrandsApi.delete_brand_social_group ...'
542
+ end
543
+ # verify the required parameter 'id' is set
544
+ if @api_client.config.client_side_validation && id.nil?
545
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.delete_brand_social_group"
546
+ end
547
+ # resource path
548
+ local_var_path = '/api/brand-social-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
549
+
550
+ # query parameters
551
+ query_params = opts[:query_params] || {}
552
+
553
+ # header parameters
554
+ header_params = opts[:header_params] || {}
555
+ # klaviyo api revision
556
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
557
+ # HTTP header 'Accept' (if needed)
558
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
559
+
560
+ # form parameters
561
+ form_params = opts[:form_params] || {}
562
+
563
+ # http body (model)
564
+ post_body = opts[:debug_body]
565
+
566
+ # return_type
567
+ return_type = opts[:debug_return_type]
568
+
569
+ # auth_names
570
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
571
+
572
+ new_options = opts.merge(
573
+ :operation => :"BrandsApi.delete_brand_social_group",
574
+ :header_params => header_params,
575
+ :query_params => query_params,
576
+ :form_params => form_params,
577
+ :body => post_body,
578
+ :auth_names => auth_names,
579
+ :return_type => return_type
580
+ )
581
+
582
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
583
+ if @api_client.config.debugging
584
+ @api_client.config.logger.debug "API called: BrandsApi#delete_brand_social_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
585
+ end
586
+ return data, status_code, headers
587
+ end
588
+
589
+ # Get Brand Button
590
+ # Get the brand button with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_button.json)
591
+ # @param id [String] The ID of the brand button.
592
+ # @param [Hash] opts the optional parameters
593
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
594
+ # @return [Hash<String, Object>]
595
+ def get_brand_button(id, opts = {})
596
+ data, _status_code, _headers = get_brand_button_with_http_info(id, opts)
597
+ data
598
+ end
599
+
600
+ # Get Brand Button
601
+ # Get the brand button with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_button.json)
602
+ # @param id [String] The ID of the brand button.
603
+ # @param [Hash] opts the optional parameters
604
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
605
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
606
+ def get_brand_button_with_http_info(id, opts = {})
607
+ if @api_client.config.debugging
608
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_button ...'
609
+ end
610
+ # verify the required parameter 'id' is set
611
+ if @api_client.config.client_side_validation && id.nil?
612
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.get_brand_button"
613
+ end
614
+ allowable_values = ["border", "border.border_color", "border.border_style", "border.border_width", "border.is_border_active", "id", "is_primary", "name", "preview_page_hex", "spacing", "spacing.padding_bottom", "spacing.padding_left", "spacing.padding_right", "spacing.padding_top", "style", "style.background_color", "style.border_radius", "style.box_shadow", "style.is_shadow_active", "text", "text.color", "text.font_family", "text.font_size", "text.font_style", "text.font_weight", "text.letter_spacing", "text.text_decoration"]
615
+ if @api_client.config.client_side_validation && opts[:'fields_brand_button'] && !opts[:'fields_brand_button'].all? { |item| allowable_values.include?(item) }
616
+ fail ArgumentError, "invalid value for \"fields_brand_button\", must include one of #{allowable_values}"
617
+ end
618
+ # resource path
619
+ local_var_path = '/api/brand-buttons/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
620
+
621
+ # query parameters
622
+ query_params = opts[:query_params] || {}
623
+ query_params[:'fields[brand-button]'] = @api_client.build_collection_param(opts[:'fields_brand_button'], :csv) if !opts[:'fields_brand_button'].nil?
624
+
625
+ # header parameters
626
+ header_params = opts[:header_params] || {}
627
+ # klaviyo api revision
628
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
629
+ # HTTP header 'Accept' (if needed)
630
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
631
+
632
+ # form parameters
633
+ form_params = opts[:form_params] || {}
634
+
635
+ # http body (model)
636
+ post_body = opts[:debug_body]
637
+
638
+ # return_type
639
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
640
+
641
+ # auth_names
642
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
643
+
644
+ new_options = opts.merge(
645
+ :operation => :"BrandsApi.get_brand_button",
646
+ :header_params => header_params,
647
+ :query_params => query_params,
648
+ :form_params => form_params,
649
+ :body => post_body,
650
+ :auth_names => auth_names,
651
+ :return_type => return_type
652
+ )
653
+
654
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
655
+ if @api_client.config.debugging
656
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_button\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
657
+ end
658
+ return data, status_code, headers
659
+ end
660
+
661
+ # Get Brand Buttons
662
+ # Get all brand buttons for the authenticated account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_buttons.json)
663
+ # @param [Hash] opts the optional parameters
664
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
665
+ # @return [Hash<String, Object>]
666
+ def get_brand_buttons(opts = {})
667
+ data, _status_code, _headers = get_brand_buttons_with_http_info(opts)
668
+ data
669
+ end
670
+
671
+ # Get Brand Buttons
672
+ # Get all brand buttons for the authenticated account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_buttons.json)
673
+ # @param [Hash] opts the optional parameters
674
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
675
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
676
+ def get_brand_buttons_with_http_info(opts = {})
677
+ if @api_client.config.debugging
678
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_buttons ...'
679
+ end
680
+ allowable_values = ["border", "border.border_color", "border.border_style", "border.border_width", "border.is_border_active", "id", "is_primary", "name", "preview_page_hex", "spacing", "spacing.padding_bottom", "spacing.padding_left", "spacing.padding_right", "spacing.padding_top", "style", "style.background_color", "style.border_radius", "style.box_shadow", "style.is_shadow_active", "text", "text.color", "text.font_family", "text.font_size", "text.font_style", "text.font_weight", "text.letter_spacing", "text.text_decoration"]
681
+ if @api_client.config.client_side_validation && opts[:'fields_brand_button'] && !opts[:'fields_brand_button'].all? { |item| allowable_values.include?(item) }
682
+ fail ArgumentError, "invalid value for \"fields_brand_button\", must include one of #{allowable_values}"
683
+ end
684
+ # resource path
685
+ local_var_path = '/api/brand-buttons'
686
+
687
+ # query parameters
688
+ query_params = opts[:query_params] || {}
689
+ query_params[:'fields[brand-button]'] = @api_client.build_collection_param(opts[:'fields_brand_button'], :csv) if !opts[:'fields_brand_button'].nil?
690
+
691
+ # header parameters
692
+ header_params = opts[:header_params] || {}
693
+ # klaviyo api revision
694
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
695
+ # HTTP header 'Accept' (if needed)
696
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
697
+
698
+ # form parameters
699
+ form_params = opts[:form_params] || {}
700
+
701
+ # http body (model)
702
+ post_body = opts[:debug_body]
703
+
704
+ # return_type
705
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
706
+
707
+ # auth_names
708
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
709
+
710
+ new_options = opts.merge(
711
+ :operation => :"BrandsApi.get_brand_buttons",
712
+ :header_params => header_params,
713
+ :query_params => query_params,
714
+ :form_params => form_params,
715
+ :body => post_body,
716
+ :auth_names => auth_names,
717
+ :return_type => return_type
718
+ )
719
+
720
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
721
+ if @api_client.config.debugging
722
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_buttons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
723
+ end
724
+ return data, status_code, headers
725
+ end
726
+
727
+ # Get Brand Color
728
+ # Get the brand color group with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_color.json)
729
+ # @param id [String] The ID of the brand color group.
730
+ # @param [Hash] opts the optional parameters
731
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
732
+ # @return [Hash<String, Object>]
733
+ def get_brand_color(id, opts = {})
734
+ data, _status_code, _headers = get_brand_color_with_http_info(id, opts)
735
+ data
736
+ end
737
+
738
+ # Get Brand Color
739
+ # Get the brand color group with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_color.json)
740
+ # @param id [String] The ID of the brand color group.
741
+ # @param [Hash] opts the optional parameters
742
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
743
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
744
+ def get_brand_color_with_http_info(id, opts = {})
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_color ...'
747
+ end
748
+ # verify the required parameter 'id' is set
749
+ if @api_client.config.client_side_validation && id.nil?
750
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.get_brand_color"
751
+ end
752
+ allowable_values = ["colors", "id", "name"]
753
+ if @api_client.config.client_side_validation && opts[:'fields_brand_color'] && !opts[:'fields_brand_color'].all? { |item| allowable_values.include?(item) }
754
+ fail ArgumentError, "invalid value for \"fields_brand_color\", must include one of #{allowable_values}"
755
+ end
756
+ # resource path
757
+ local_var_path = '/api/brand-colors/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
758
+
759
+ # query parameters
760
+ query_params = opts[:query_params] || {}
761
+ query_params[:'fields[brand-color]'] = @api_client.build_collection_param(opts[:'fields_brand_color'], :csv) if !opts[:'fields_brand_color'].nil?
762
+
763
+ # header parameters
764
+ header_params = opts[:header_params] || {}
765
+ # klaviyo api revision
766
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
767
+ # HTTP header 'Accept' (if needed)
768
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
769
+
770
+ # form parameters
771
+ form_params = opts[:form_params] || {}
772
+
773
+ # http body (model)
774
+ post_body = opts[:debug_body]
775
+
776
+ # return_type
777
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
778
+
779
+ # auth_names
780
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
781
+
782
+ new_options = opts.merge(
783
+ :operation => :"BrandsApi.get_brand_color",
784
+ :header_params => header_params,
785
+ :query_params => query_params,
786
+ :form_params => form_params,
787
+ :body => post_body,
788
+ :auth_names => auth_names,
789
+ :return_type => return_type
790
+ )
791
+
792
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
793
+ if @api_client.config.debugging
794
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_color\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
795
+ end
796
+ return data, status_code, headers
797
+ end
798
+
799
+ # Get Brand Colors
800
+ # Get all brand color groups for the authenticated account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_colors.json)
801
+ # @param [Hash] opts the optional parameters
802
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
803
+ # @return [Hash<String, Object>]
804
+ def get_brand_colors(opts = {})
805
+ data, _status_code, _headers = get_brand_colors_with_http_info(opts)
806
+ data
807
+ end
808
+
809
+ # Get Brand Colors
810
+ # Get all brand color groups for the authenticated account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_colors.json)
811
+ # @param [Hash] opts the optional parameters
812
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
813
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
814
+ def get_brand_colors_with_http_info(opts = {})
815
+ if @api_client.config.debugging
816
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_colors ...'
817
+ end
818
+ allowable_values = ["colors", "id", "name"]
819
+ if @api_client.config.client_side_validation && opts[:'fields_brand_color'] && !opts[:'fields_brand_color'].all? { |item| allowable_values.include?(item) }
820
+ fail ArgumentError, "invalid value for \"fields_brand_color\", must include one of #{allowable_values}"
821
+ end
822
+ # resource path
823
+ local_var_path = '/api/brand-colors'
824
+
825
+ # query parameters
826
+ query_params = opts[:query_params] || {}
827
+ query_params[:'fields[brand-color]'] = @api_client.build_collection_param(opts[:'fields_brand_color'], :csv) if !opts[:'fields_brand_color'].nil?
828
+
829
+ # header parameters
830
+ header_params = opts[:header_params] || {}
831
+ # klaviyo api revision
832
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
833
+ # HTTP header 'Accept' (if needed)
834
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
835
+
836
+ # form parameters
837
+ form_params = opts[:form_params] || {}
838
+
839
+ # http body (model)
840
+ post_body = opts[:debug_body]
841
+
842
+ # return_type
843
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
844
+
845
+ # auth_names
846
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
847
+
848
+ new_options = opts.merge(
849
+ :operation => :"BrandsApi.get_brand_colors",
850
+ :header_params => header_params,
851
+ :query_params => query_params,
852
+ :form_params => form_params,
853
+ :body => post_body,
854
+ :auth_names => auth_names,
855
+ :return_type => return_type
856
+ )
857
+
858
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
859
+ if @api_client.config.debugging
860
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_colors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
861
+ end
862
+ return data, status_code, headers
863
+ end
864
+
865
+ # Get Brand Email Default
866
+ # Get the brand email defaults for the authenticated account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_email_default.json)
867
+ # @param id [String] The ID of the brand email defaults (must equal the account ID).
868
+ # @param [Hash] opts the optional parameters
869
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
870
+ # @option opts [Array<String>] :fields_brand_email_default For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
871
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
872
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
873
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
874
+ # @return [Hash<String, Object>]
875
+ def get_brand_email_default(id, opts = {})
876
+ data, _status_code, _headers = get_brand_email_default_with_http_info(id, opts)
877
+ data
878
+ end
879
+
880
+ # Get Brand Email Default
881
+ # Get the brand email defaults for the authenticated account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_email_default.json)
882
+ # @param id [String] The ID of the brand email defaults (must equal the account ID).
883
+ # @param [Hash] opts the optional parameters
884
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
885
+ # @option opts [Array<String>] :fields_brand_email_default For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
886
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
887
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
888
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
889
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
890
+ def get_brand_email_default_with_http_info(id, opts = {})
891
+ if @api_client.config.debugging
892
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_email_default ...'
893
+ end
894
+ # verify the required parameter 'id' is set
895
+ if @api_client.config.client_side_validation && id.nil?
896
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.get_brand_email_default"
897
+ end
898
+ allowable_values = ["border", "border.border_color", "border.border_style", "border.border_width", "border.is_border_active", "id", "is_primary", "name", "preview_page_hex", "spacing", "spacing.padding_bottom", "spacing.padding_left", "spacing.padding_right", "spacing.padding_top", "style", "style.background_color", "style.border_radius", "style.box_shadow", "style.is_shadow_active", "text", "text.color", "text.font_family", "text.font_size", "text.font_style", "text.font_weight", "text.letter_spacing", "text.text_decoration"]
899
+ if @api_client.config.client_side_validation && opts[:'fields_brand_button'] && !opts[:'fields_brand_button'].all? { |item| allowable_values.include?(item) }
900
+ fail ArgumentError, "invalid value for \"fields_brand_button\", must include one of #{allowable_values}"
901
+ end
902
+ allowable_values = ["body", "body.background_color", "body.body_background_color", "body.h1_text", "body.h1_text.color", "body.h1_text.font_family", "body.h1_text.font_size", "body.h1_text.font_style", "body.h1_text.font_weight", "body.h1_text.letter_spacing", "body.h1_text.text_decoration", "body.h2_text", "body.h2_text.color", "body.h2_text.font_family", "body.h2_text.font_size", "body.h2_text.font_style", "body.h2_text.font_weight", "body.h2_text.letter_spacing", "body.h2_text.text_decoration", "body.h3_text", "body.h3_text.color", "body.h3_text.font_family", "body.h3_text.font_size", "body.h3_text.font_style", "body.h3_text.font_weight", "body.h3_text.letter_spacing", "body.h3_text.text_decoration", "body.h4_text", "body.h4_text.color", "body.h4_text.font_family", "body.h4_text.font_size", "body.h4_text.font_style", "body.h4_text.font_weight", "body.h4_text.letter_spacing", "body.h4_text.text_decoration", "body.link_text", "body.link_text.color", "body.link_text.font_family", "body.link_text.font_size", "body.link_text.font_style", "body.link_text.font_weight", "body.link_text.letter_spacing", "body.link_text.text_decoration", "body.text", "body.text.color", "body.text.font_family", "body.text.font_size", "body.text.font_style", "body.text.font_weight", "body.text.letter_spacing", "body.text.text_decoration", "footer", "footer.background_color", "footer.link_text", "footer.link_text.color", "footer.link_text.font_family", "footer.link_text.font_size", "footer.link_text.font_style", "footer.link_text.font_weight", "footer.link_text.letter_spacing", "footer.link_text.text_decoration", "footer.social_group_color", "footer.text", "footer.text.color", "footer.text.font_family", "footer.text.font_size", "footer.text.font_style", "footer.text.font_weight", "footer.text.letter_spacing", "footer.text.text_decoration", "header", "header.background_color", "header.link_text", "header.link_text.color", "header.link_text.font_family", "header.link_text.font_size", "header.link_text.font_style", "header.link_text.font_weight", "header.link_text.letter_spacing", "header.link_text.text_decoration", "header.links", "header.logo_max_width", "id"]
903
+ if @api_client.config.client_side_validation && opts[:'fields_brand_email_default'] && !opts[:'fields_brand_email_default'].all? { |item| allowable_values.include?(item) }
904
+ fail ArgumentError, "invalid value for \"fields_brand_email_default\", must include one of #{allowable_values}"
905
+ end
906
+ allowable_values = ["alt_text", "height", "id", "link_url", "name", "width"]
907
+ if @api_client.config.client_side_validation && opts[:'fields_brand_logo'] && !opts[:'fields_brand_logo'].all? { |item| allowable_values.include?(item) }
908
+ fail ArgumentError, "invalid value for \"fields_brand_logo\", must include one of #{allowable_values}"
909
+ end
910
+ allowable_values = ["id", "name", "social_links"]
911
+ if @api_client.config.client_side_validation && opts[:'fields_brand_social_group'] && !opts[:'fields_brand_social_group'].all? { |item| allowable_values.include?(item) }
912
+ fail ArgumentError, "invalid value for \"fields_brand_social_group\", must include one of #{allowable_values}"
913
+ end
914
+ allowable_values = ["brand-button", "brand-logo", "brand-social-group"]
915
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
916
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
917
+ end
918
+ # resource path
919
+ local_var_path = '/api/brand-email-defaults/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
920
+
921
+ # query parameters
922
+ query_params = opts[:query_params] || {}
923
+ query_params[:'fields[brand-button]'] = @api_client.build_collection_param(opts[:'fields_brand_button'], :csv) if !opts[:'fields_brand_button'].nil?
924
+ query_params[:'fields[brand-email-default]'] = @api_client.build_collection_param(opts[:'fields_brand_email_default'], :csv) if !opts[:'fields_brand_email_default'].nil?
925
+ query_params[:'fields[brand-logo]'] = @api_client.build_collection_param(opts[:'fields_brand_logo'], :csv) if !opts[:'fields_brand_logo'].nil?
926
+ query_params[:'fields[brand-social-group]'] = @api_client.build_collection_param(opts[:'fields_brand_social_group'], :csv) if !opts[:'fields_brand_social_group'].nil?
927
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
928
+
929
+ # header parameters
930
+ header_params = opts[:header_params] || {}
931
+ # klaviyo api revision
932
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
933
+ # HTTP header 'Accept' (if needed)
934
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
935
+
936
+ # form parameters
937
+ form_params = opts[:form_params] || {}
938
+
939
+ # http body (model)
940
+ post_body = opts[:debug_body]
941
+
942
+ # return_type
943
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
944
+
945
+ # auth_names
946
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
947
+
948
+ new_options = opts.merge(
949
+ :operation => :"BrandsApi.get_brand_email_default",
950
+ :header_params => header_params,
951
+ :query_params => query_params,
952
+ :form_params => form_params,
953
+ :body => post_body,
954
+ :auth_names => auth_names,
955
+ :return_type => return_type
956
+ )
957
+
958
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
959
+ if @api_client.config.debugging
960
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_email_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
961
+ end
962
+ return data, status_code, headers
963
+ end
964
+
965
+ # Get Brand Email Defaults
966
+ # List the brand email defaults for the authenticated account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_email_defaults.json)
967
+ # @param [Hash] opts the optional parameters
968
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
969
+ # @option opts [Array<String>] :fields_brand_email_default For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
970
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
971
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
972
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
973
+ # @return [Hash<String, Object>]
974
+ def get_brand_email_defaults(opts = {})
975
+ data, _status_code, _headers = get_brand_email_defaults_with_http_info(opts)
976
+ data
977
+ end
978
+
979
+ # Get Brand Email Defaults
980
+ # List the brand email defaults for the authenticated account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_email_defaults.json)
981
+ # @param [Hash] opts the optional parameters
982
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
983
+ # @option opts [Array<String>] :fields_brand_email_default For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
984
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
985
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
986
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
987
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
988
+ def get_brand_email_defaults_with_http_info(opts = {})
989
+ if @api_client.config.debugging
990
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_email_defaults ...'
991
+ end
992
+ allowable_values = ["border", "border.border_color", "border.border_style", "border.border_width", "border.is_border_active", "id", "is_primary", "name", "preview_page_hex", "spacing", "spacing.padding_bottom", "spacing.padding_left", "spacing.padding_right", "spacing.padding_top", "style", "style.background_color", "style.border_radius", "style.box_shadow", "style.is_shadow_active", "text", "text.color", "text.font_family", "text.font_size", "text.font_style", "text.font_weight", "text.letter_spacing", "text.text_decoration"]
993
+ if @api_client.config.client_side_validation && opts[:'fields_brand_button'] && !opts[:'fields_brand_button'].all? { |item| allowable_values.include?(item) }
994
+ fail ArgumentError, "invalid value for \"fields_brand_button\", must include one of #{allowable_values}"
995
+ end
996
+ allowable_values = ["body", "body.background_color", "body.body_background_color", "body.h1_text", "body.h1_text.color", "body.h1_text.font_family", "body.h1_text.font_size", "body.h1_text.font_style", "body.h1_text.font_weight", "body.h1_text.letter_spacing", "body.h1_text.text_decoration", "body.h2_text", "body.h2_text.color", "body.h2_text.font_family", "body.h2_text.font_size", "body.h2_text.font_style", "body.h2_text.font_weight", "body.h2_text.letter_spacing", "body.h2_text.text_decoration", "body.h3_text", "body.h3_text.color", "body.h3_text.font_family", "body.h3_text.font_size", "body.h3_text.font_style", "body.h3_text.font_weight", "body.h3_text.letter_spacing", "body.h3_text.text_decoration", "body.h4_text", "body.h4_text.color", "body.h4_text.font_family", "body.h4_text.font_size", "body.h4_text.font_style", "body.h4_text.font_weight", "body.h4_text.letter_spacing", "body.h4_text.text_decoration", "body.link_text", "body.link_text.color", "body.link_text.font_family", "body.link_text.font_size", "body.link_text.font_style", "body.link_text.font_weight", "body.link_text.letter_spacing", "body.link_text.text_decoration", "body.text", "body.text.color", "body.text.font_family", "body.text.font_size", "body.text.font_style", "body.text.font_weight", "body.text.letter_spacing", "body.text.text_decoration", "footer", "footer.background_color", "footer.link_text", "footer.link_text.color", "footer.link_text.font_family", "footer.link_text.font_size", "footer.link_text.font_style", "footer.link_text.font_weight", "footer.link_text.letter_spacing", "footer.link_text.text_decoration", "footer.social_group_color", "footer.text", "footer.text.color", "footer.text.font_family", "footer.text.font_size", "footer.text.font_style", "footer.text.font_weight", "footer.text.letter_spacing", "footer.text.text_decoration", "header", "header.background_color", "header.link_text", "header.link_text.color", "header.link_text.font_family", "header.link_text.font_size", "header.link_text.font_style", "header.link_text.font_weight", "header.link_text.letter_spacing", "header.link_text.text_decoration", "header.links", "header.logo_max_width", "id"]
997
+ if @api_client.config.client_side_validation && opts[:'fields_brand_email_default'] && !opts[:'fields_brand_email_default'].all? { |item| allowable_values.include?(item) }
998
+ fail ArgumentError, "invalid value for \"fields_brand_email_default\", must include one of #{allowable_values}"
999
+ end
1000
+ allowable_values = ["alt_text", "height", "id", "link_url", "name", "width"]
1001
+ if @api_client.config.client_side_validation && opts[:'fields_brand_logo'] && !opts[:'fields_brand_logo'].all? { |item| allowable_values.include?(item) }
1002
+ fail ArgumentError, "invalid value for \"fields_brand_logo\", must include one of #{allowable_values}"
1003
+ end
1004
+ allowable_values = ["id", "name", "social_links"]
1005
+ if @api_client.config.client_side_validation && opts[:'fields_brand_social_group'] && !opts[:'fields_brand_social_group'].all? { |item| allowable_values.include?(item) }
1006
+ fail ArgumentError, "invalid value for \"fields_brand_social_group\", must include one of #{allowable_values}"
1007
+ end
1008
+ allowable_values = ["brand-button", "brand-logo", "brand-social-group"]
1009
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1010
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1011
+ end
1012
+ # resource path
1013
+ local_var_path = '/api/brand-email-defaults'
1014
+
1015
+ # query parameters
1016
+ query_params = opts[:query_params] || {}
1017
+ query_params[:'fields[brand-button]'] = @api_client.build_collection_param(opts[:'fields_brand_button'], :csv) if !opts[:'fields_brand_button'].nil?
1018
+ query_params[:'fields[brand-email-default]'] = @api_client.build_collection_param(opts[:'fields_brand_email_default'], :csv) if !opts[:'fields_brand_email_default'].nil?
1019
+ query_params[:'fields[brand-logo]'] = @api_client.build_collection_param(opts[:'fields_brand_logo'], :csv) if !opts[:'fields_brand_logo'].nil?
1020
+ query_params[:'fields[brand-social-group]'] = @api_client.build_collection_param(opts[:'fields_brand_social_group'], :csv) if !opts[:'fields_brand_social_group'].nil?
1021
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1022
+
1023
+ # header parameters
1024
+ header_params = opts[:header_params] || {}
1025
+ # klaviyo api revision
1026
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1027
+ # HTTP header 'Accept' (if needed)
1028
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1029
+
1030
+ # form parameters
1031
+ form_params = opts[:form_params] || {}
1032
+
1033
+ # http body (model)
1034
+ post_body = opts[:debug_body]
1035
+
1036
+ # return_type
1037
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1038
+
1039
+ # auth_names
1040
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1041
+
1042
+ new_options = opts.merge(
1043
+ :operation => :"BrandsApi.get_brand_email_defaults",
1044
+ :header_params => header_params,
1045
+ :query_params => query_params,
1046
+ :form_params => form_params,
1047
+ :body => post_body,
1048
+ :auth_names => auth_names,
1049
+ :return_type => return_type
1050
+ )
1051
+
1052
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1053
+ if @api_client.config.debugging
1054
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_email_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1055
+ end
1056
+ return data, status_code, headers
1057
+ end
1058
+
1059
+ # Get Brand Logo
1060
+ # Get the brand logo with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_logo.json)
1061
+ # @param id [String] The ID of the brand logo.
1062
+ # @param [Hash] opts the optional parameters
1063
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1064
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1065
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1066
+ # @return [Hash<String, Object>]
1067
+ def get_brand_logo(id, opts = {})
1068
+ data, _status_code, _headers = get_brand_logo_with_http_info(id, opts)
1069
+ data
1070
+ end
1071
+
1072
+ # Get Brand Logo
1073
+ # Get the brand logo with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_logo.json)
1074
+ # @param id [String] The ID of the brand logo.
1075
+ # @param [Hash] opts the optional parameters
1076
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1077
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1078
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1079
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1080
+ def get_brand_logo_with_http_info(id, opts = {})
1081
+ if @api_client.config.debugging
1082
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_logo ...'
1083
+ end
1084
+ # verify the required parameter 'id' is set
1085
+ if @api_client.config.client_side_validation && id.nil?
1086
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.get_brand_logo"
1087
+ end
1088
+ allowable_values = ["alt_text", "height", "id", "link_url", "name", "width"]
1089
+ if @api_client.config.client_side_validation && opts[:'fields_brand_logo'] && !opts[:'fields_brand_logo'].all? { |item| allowable_values.include?(item) }
1090
+ fail ArgumentError, "invalid value for \"fields_brand_logo\", must include one of #{allowable_values}"
1091
+ end
1092
+ allowable_values = ["format", "hidden", "id", "image_url", "name", "size", "updated_at"]
1093
+ if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
1094
+ fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
1095
+ end
1096
+ allowable_values = ["image"]
1097
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1098
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1099
+ end
1100
+ # resource path
1101
+ local_var_path = '/api/brand-logos/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1102
+
1103
+ # query parameters
1104
+ query_params = opts[:query_params] || {}
1105
+ query_params[:'fields[brand-logo]'] = @api_client.build_collection_param(opts[:'fields_brand_logo'], :csv) if !opts[:'fields_brand_logo'].nil?
1106
+ query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
1107
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1108
+
1109
+ # header parameters
1110
+ header_params = opts[:header_params] || {}
1111
+ # klaviyo api revision
1112
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1113
+ # HTTP header 'Accept' (if needed)
1114
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1115
+
1116
+ # form parameters
1117
+ form_params = opts[:form_params] || {}
1118
+
1119
+ # http body (model)
1120
+ post_body = opts[:debug_body]
1121
+
1122
+ # return_type
1123
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1124
+
1125
+ # auth_names
1126
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1127
+
1128
+ new_options = opts.merge(
1129
+ :operation => :"BrandsApi.get_brand_logo",
1130
+ :header_params => header_params,
1131
+ :query_params => query_params,
1132
+ :form_params => form_params,
1133
+ :body => post_body,
1134
+ :auth_names => auth_names,
1135
+ :return_type => return_type
1136
+ )
1137
+
1138
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1139
+ if @api_client.config.debugging
1140
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1141
+ end
1142
+ return data, status_code, headers
1143
+ end
1144
+
1145
+ # Get Brand Logos
1146
+ # Get all brand logos for the authenticated account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_logos.json)
1147
+ # @param [Hash] opts the optional parameters
1148
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1149
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1150
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1151
+ # @return [Hash<String, Object>]
1152
+ def get_brand_logos(opts = {})
1153
+ data, _status_code, _headers = get_brand_logos_with_http_info(opts)
1154
+ data
1155
+ end
1156
+
1157
+ # Get Brand Logos
1158
+ # Get all brand logos for the authenticated account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_logos.json)
1159
+ # @param [Hash] opts the optional parameters
1160
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1161
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1162
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1163
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1164
+ def get_brand_logos_with_http_info(opts = {})
1165
+ if @api_client.config.debugging
1166
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_logos ...'
1167
+ end
1168
+ allowable_values = ["alt_text", "height", "id", "link_url", "name", "width"]
1169
+ if @api_client.config.client_side_validation && opts[:'fields_brand_logo'] && !opts[:'fields_brand_logo'].all? { |item| allowable_values.include?(item) }
1170
+ fail ArgumentError, "invalid value for \"fields_brand_logo\", must include one of #{allowable_values}"
1171
+ end
1172
+ allowable_values = ["format", "hidden", "id", "image_url", "name", "size", "updated_at"]
1173
+ if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
1174
+ fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
1175
+ end
1176
+ allowable_values = ["image"]
1177
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1178
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1179
+ end
1180
+ # resource path
1181
+ local_var_path = '/api/brand-logos'
1182
+
1183
+ # query parameters
1184
+ query_params = opts[:query_params] || {}
1185
+ query_params[:'fields[brand-logo]'] = @api_client.build_collection_param(opts[:'fields_brand_logo'], :csv) if !opts[:'fields_brand_logo'].nil?
1186
+ query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
1187
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1188
+
1189
+ # header parameters
1190
+ header_params = opts[:header_params] || {}
1191
+ # klaviyo api revision
1192
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1193
+ # HTTP header 'Accept' (if needed)
1194
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1195
+
1196
+ # form parameters
1197
+ form_params = opts[:form_params] || {}
1198
+
1199
+ # http body (model)
1200
+ post_body = opts[:debug_body]
1201
+
1202
+ # return_type
1203
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1204
+
1205
+ # auth_names
1206
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1207
+
1208
+ new_options = opts.merge(
1209
+ :operation => :"BrandsApi.get_brand_logos",
1210
+ :header_params => header_params,
1211
+ :query_params => query_params,
1212
+ :form_params => form_params,
1213
+ :body => post_body,
1214
+ :auth_names => auth_names,
1215
+ :return_type => return_type
1216
+ )
1217
+
1218
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1219
+ if @api_client.config.debugging
1220
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_logos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1221
+ end
1222
+ return data, status_code, headers
1223
+ end
1224
+
1225
+ # Get Brand Social Group
1226
+ # Get the brand social group with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_social_group.json)
1227
+ # @param id [String] The ID of the brand social group.
1228
+ # @param [Hash] opts the optional parameters
1229
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1230
+ # @return [Hash<String, Object>]
1231
+ def get_brand_social_group(id, opts = {})
1232
+ data, _status_code, _headers = get_brand_social_group_with_http_info(id, opts)
1233
+ data
1234
+ end
1235
+
1236
+ # Get Brand Social Group
1237
+ # Get the brand social group with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_social_group.json)
1238
+ # @param id [String] The ID of the brand social group.
1239
+ # @param [Hash] opts the optional parameters
1240
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1241
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1242
+ def get_brand_social_group_with_http_info(id, opts = {})
1243
+ if @api_client.config.debugging
1244
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_social_group ...'
1245
+ end
1246
+ # verify the required parameter 'id' is set
1247
+ if @api_client.config.client_side_validation && id.nil?
1248
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.get_brand_social_group"
1249
+ end
1250
+ allowable_values = ["id", "name", "social_links"]
1251
+ if @api_client.config.client_side_validation && opts[:'fields_brand_social_group'] && !opts[:'fields_brand_social_group'].all? { |item| allowable_values.include?(item) }
1252
+ fail ArgumentError, "invalid value for \"fields_brand_social_group\", must include one of #{allowable_values}"
1253
+ end
1254
+ # resource path
1255
+ local_var_path = '/api/brand-social-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1256
+
1257
+ # query parameters
1258
+ query_params = opts[:query_params] || {}
1259
+ query_params[:'fields[brand-social-group]'] = @api_client.build_collection_param(opts[:'fields_brand_social_group'], :csv) if !opts[:'fields_brand_social_group'].nil?
1260
+
1261
+ # header parameters
1262
+ header_params = opts[:header_params] || {}
1263
+ # klaviyo api revision
1264
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1265
+ # HTTP header 'Accept' (if needed)
1266
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1267
+
1268
+ # form parameters
1269
+ form_params = opts[:form_params] || {}
1270
+
1271
+ # http body (model)
1272
+ post_body = opts[:debug_body]
1273
+
1274
+ # return_type
1275
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1276
+
1277
+ # auth_names
1278
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1279
+
1280
+ new_options = opts.merge(
1281
+ :operation => :"BrandsApi.get_brand_social_group",
1282
+ :header_params => header_params,
1283
+ :query_params => query_params,
1284
+ :form_params => form_params,
1285
+ :body => post_body,
1286
+ :auth_names => auth_names,
1287
+ :return_type => return_type
1288
+ )
1289
+
1290
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1291
+ if @api_client.config.debugging
1292
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_social_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1293
+ end
1294
+ return data, status_code, headers
1295
+ end
1296
+
1297
+ # Get Brand Social Groups
1298
+ # Get all brand social groups for the authenticated account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_social_groups.json)
1299
+ # @param [Hash] opts the optional parameters
1300
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1301
+ # @return [Hash<String, Object>]
1302
+ def get_brand_social_groups(opts = {})
1303
+ data, _status_code, _headers = get_brand_social_groups_with_http_info(opts)
1304
+ data
1305
+ end
1306
+
1307
+ # Get Brand Social Groups
1308
+ # Get all brand social groups for the authenticated account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_social_groups.json)
1309
+ # @param [Hash] opts the optional parameters
1310
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1311
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1312
+ def get_brand_social_groups_with_http_info(opts = {})
1313
+ if @api_client.config.debugging
1314
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_social_groups ...'
1315
+ end
1316
+ allowable_values = ["id", "name", "social_links"]
1317
+ if @api_client.config.client_side_validation && opts[:'fields_brand_social_group'] && !opts[:'fields_brand_social_group'].all? { |item| allowable_values.include?(item) }
1318
+ fail ArgumentError, "invalid value for \"fields_brand_social_group\", must include one of #{allowable_values}"
1319
+ end
1320
+ # resource path
1321
+ local_var_path = '/api/brand-social-groups'
1322
+
1323
+ # query parameters
1324
+ query_params = opts[:query_params] || {}
1325
+ query_params[:'fields[brand-social-group]'] = @api_client.build_collection_param(opts[:'fields_brand_social_group'], :csv) if !opts[:'fields_brand_social_group'].nil?
1326
+
1327
+ # header parameters
1328
+ header_params = opts[:header_params] || {}
1329
+ # klaviyo api revision
1330
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1331
+ # HTTP header 'Accept' (if needed)
1332
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1333
+
1334
+ # form parameters
1335
+ form_params = opts[:form_params] || {}
1336
+
1337
+ # http body (model)
1338
+ post_body = opts[:debug_body]
1339
+
1340
+ # return_type
1341
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1342
+
1343
+ # auth_names
1344
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1345
+
1346
+ new_options = opts.merge(
1347
+ :operation => :"BrandsApi.get_brand_social_groups",
1348
+ :header_params => header_params,
1349
+ :query_params => query_params,
1350
+ :form_params => form_params,
1351
+ :body => post_body,
1352
+ :auth_names => auth_names,
1353
+ :return_type => return_type
1354
+ )
1355
+
1356
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1357
+ if @api_client.config.debugging
1358
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_social_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1359
+ end
1360
+ return data, status_code, headers
1361
+ end
1362
+
1363
+ # Get Brand Voice
1364
+ # Get the brand voice for the authenticated company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `brands:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_voice.json)
1365
+ # @param id [String] The company ID. Must match the authenticated account.
1366
+ # @param [Hash] opts the optional parameters
1367
+ # @option opts [Array<String>] :fields_brand_voice For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1368
+ # @return [Hash<String, Object>]
1369
+ def get_brand_voice(id, opts = {})
1370
+ data, _status_code, _headers = get_brand_voice_with_http_info(id, opts)
1371
+ data
1372
+ end
1373
+
1374
+ # Get Brand Voice
1375
+ # Get the brand voice for the authenticated company.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;brands:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_brand_voice.json)
1376
+ # @param id [String] The company ID. Must match the authenticated account.
1377
+ # @param [Hash] opts the optional parameters
1378
+ # @option opts [Array<String>] :fields_brand_voice For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1379
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1380
+ def get_brand_voice_with_http_info(id, opts = {})
1381
+ if @api_client.config.debugging
1382
+ @api_client.config.logger.debug 'Calling API: BrandsApi.get_brand_voice ...'
1383
+ end
1384
+ # verify the required parameter 'id' is set
1385
+ if @api_client.config.client_side_validation && id.nil?
1386
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.get_brand_voice"
1387
+ end
1388
+ allowable_values = ["id", "language_patterns", "tone_descriptors", "version"]
1389
+ if @api_client.config.client_side_validation && opts[:'fields_brand_voice'] && !opts[:'fields_brand_voice'].all? { |item| allowable_values.include?(item) }
1390
+ fail ArgumentError, "invalid value for \"fields_brand_voice\", must include one of #{allowable_values}"
1391
+ end
1392
+ # resource path
1393
+ local_var_path = '/api/brand-voice/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1394
+
1395
+ # query parameters
1396
+ query_params = opts[:query_params] || {}
1397
+ query_params[:'fields[brand-voice]'] = @api_client.build_collection_param(opts[:'fields_brand_voice'], :csv) if !opts[:'fields_brand_voice'].nil?
1398
+
1399
+ # header parameters
1400
+ header_params = opts[:header_params] || {}
1401
+ # klaviyo api revision
1402
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1403
+ # HTTP header 'Accept' (if needed)
1404
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1405
+
1406
+ # form parameters
1407
+ form_params = opts[:form_params] || {}
1408
+
1409
+ # http body (model)
1410
+ post_body = opts[:debug_body]
1411
+
1412
+ # return_type
1413
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1414
+
1415
+ # auth_names
1416
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1417
+
1418
+ new_options = opts.merge(
1419
+ :operation => :"BrandsApi.get_brand_voice",
1420
+ :header_params => header_params,
1421
+ :query_params => query_params,
1422
+ :form_params => form_params,
1423
+ :body => post_body,
1424
+ :auth_names => auth_names,
1425
+ :return_type => return_type
1426
+ )
1427
+
1428
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1429
+ if @api_client.config.debugging
1430
+ @api_client.config.logger.debug "API called: BrandsApi#get_brand_voice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1431
+ end
1432
+ return data, status_code, headers
1433
+ end
1434
+
1435
+ # Update Brand Button
1436
+ # Update the brand button with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_button.json)
1437
+ # @param id [String] The ID of the brand button.
1438
+ # @param brand_button_partial_update_query [BrandButtonPartialUpdateQuery]
1439
+ # @param [Hash] opts the optional parameters
1440
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1441
+ # @return [Hash<String, Object>]
1442
+ def update_brand_button(id, brand_button_partial_update_query, opts = {})
1443
+ data, _status_code, _headers = update_brand_button_with_http_info(id, brand_button_partial_update_query, opts)
1444
+ data
1445
+ end
1446
+
1447
+ # Update Brand Button
1448
+ # Update the brand button with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_button.json)
1449
+ # @param id [String] The ID of the brand button.
1450
+ # @param brand_button_partial_update_query [BrandButtonPartialUpdateQuery]
1451
+ # @param [Hash] opts the optional parameters
1452
+ # @option opts [Array<String>] :fields_brand_button For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1453
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1454
+ def update_brand_button_with_http_info(id, brand_button_partial_update_query, opts = {})
1455
+ if @api_client.config.debugging
1456
+ @api_client.config.logger.debug 'Calling API: BrandsApi.update_brand_button ...'
1457
+ end
1458
+ # verify the required parameter 'id' is set
1459
+ if @api_client.config.client_side_validation && id.nil?
1460
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.update_brand_button"
1461
+ end
1462
+ # verify the required parameter 'brand_button_partial_update_query' is set
1463
+ if @api_client.config.client_side_validation && brand_button_partial_update_query.nil?
1464
+ fail ArgumentError, "Missing the required parameter 'brand_button_partial_update_query' when calling BrandsApi.update_brand_button"
1465
+ end
1466
+ allowable_values = ["border", "border.border_color", "border.border_style", "border.border_width", "border.is_border_active", "id", "is_primary", "name", "preview_page_hex", "spacing", "spacing.padding_bottom", "spacing.padding_left", "spacing.padding_right", "spacing.padding_top", "style", "style.background_color", "style.border_radius", "style.box_shadow", "style.is_shadow_active", "text", "text.color", "text.font_family", "text.font_size", "text.font_style", "text.font_weight", "text.letter_spacing", "text.text_decoration"]
1467
+ if @api_client.config.client_side_validation && opts[:'fields_brand_button'] && !opts[:'fields_brand_button'].all? { |item| allowable_values.include?(item) }
1468
+ fail ArgumentError, "invalid value for \"fields_brand_button\", must include one of #{allowable_values}"
1469
+ end
1470
+ # resource path
1471
+ local_var_path = '/api/brand-buttons/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1472
+
1473
+ # query parameters
1474
+ query_params = opts[:query_params] || {}
1475
+ query_params[:'fields[brand-button]'] = @api_client.build_collection_param(opts[:'fields_brand_button'], :csv) if !opts[:'fields_brand_button'].nil?
1476
+
1477
+ # header parameters
1478
+ header_params = opts[:header_params] || {}
1479
+ # klaviyo api revision
1480
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1481
+ # HTTP header 'Accept' (if needed)
1482
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1483
+ # HTTP header 'Content-Type'
1484
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1485
+ if !content_type.nil?
1486
+ header_params['Content-Type'] = content_type
1487
+ end
1488
+
1489
+ # form parameters
1490
+ form_params = opts[:form_params] || {}
1491
+
1492
+ # http body (model)
1493
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_button_partial_update_query)
1494
+
1495
+ # return_type
1496
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1497
+
1498
+ # auth_names
1499
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1500
+
1501
+ new_options = opts.merge(
1502
+ :operation => :"BrandsApi.update_brand_button",
1503
+ :header_params => header_params,
1504
+ :query_params => query_params,
1505
+ :form_params => form_params,
1506
+ :body => post_body,
1507
+ :auth_names => auth_names,
1508
+ :return_type => return_type
1509
+ )
1510
+
1511
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1512
+ if @api_client.config.debugging
1513
+ @api_client.config.logger.debug "API called: BrandsApi#update_brand_button\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1514
+ end
1515
+ return data, status_code, headers
1516
+ end
1517
+
1518
+ # Update Brand Color
1519
+ # Update the brand color group with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_color.json)
1520
+ # @param id [String] The ID of the brand color group.
1521
+ # @param brand_color_partial_update_query [BrandColorPartialUpdateQuery]
1522
+ # @param [Hash] opts the optional parameters
1523
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1524
+ # @return [Hash<String, Object>]
1525
+ def update_brand_color(id, brand_color_partial_update_query, opts = {})
1526
+ data, _status_code, _headers = update_brand_color_with_http_info(id, brand_color_partial_update_query, opts)
1527
+ data
1528
+ end
1529
+
1530
+ # Update Brand Color
1531
+ # Update the brand color group with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_color.json)
1532
+ # @param id [String] The ID of the brand color group.
1533
+ # @param brand_color_partial_update_query [BrandColorPartialUpdateQuery]
1534
+ # @param [Hash] opts the optional parameters
1535
+ # @option opts [Array<String>] :fields_brand_color For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1536
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1537
+ def update_brand_color_with_http_info(id, brand_color_partial_update_query, opts = {})
1538
+ if @api_client.config.debugging
1539
+ @api_client.config.logger.debug 'Calling API: BrandsApi.update_brand_color ...'
1540
+ end
1541
+ # verify the required parameter 'id' is set
1542
+ if @api_client.config.client_side_validation && id.nil?
1543
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.update_brand_color"
1544
+ end
1545
+ # verify the required parameter 'brand_color_partial_update_query' is set
1546
+ if @api_client.config.client_side_validation && brand_color_partial_update_query.nil?
1547
+ fail ArgumentError, "Missing the required parameter 'brand_color_partial_update_query' when calling BrandsApi.update_brand_color"
1548
+ end
1549
+ allowable_values = ["colors", "id", "name"]
1550
+ if @api_client.config.client_side_validation && opts[:'fields_brand_color'] && !opts[:'fields_brand_color'].all? { |item| allowable_values.include?(item) }
1551
+ fail ArgumentError, "invalid value for \"fields_brand_color\", must include one of #{allowable_values}"
1552
+ end
1553
+ # resource path
1554
+ local_var_path = '/api/brand-colors/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1555
+
1556
+ # query parameters
1557
+ query_params = opts[:query_params] || {}
1558
+ query_params[:'fields[brand-color]'] = @api_client.build_collection_param(opts[:'fields_brand_color'], :csv) if !opts[:'fields_brand_color'].nil?
1559
+
1560
+ # header parameters
1561
+ header_params = opts[:header_params] || {}
1562
+ # klaviyo api revision
1563
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1564
+ # HTTP header 'Accept' (if needed)
1565
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1566
+ # HTTP header 'Content-Type'
1567
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1568
+ if !content_type.nil?
1569
+ header_params['Content-Type'] = content_type
1570
+ end
1571
+
1572
+ # form parameters
1573
+ form_params = opts[:form_params] || {}
1574
+
1575
+ # http body (model)
1576
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_color_partial_update_query)
1577
+
1578
+ # return_type
1579
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1580
+
1581
+ # auth_names
1582
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1583
+
1584
+ new_options = opts.merge(
1585
+ :operation => :"BrandsApi.update_brand_color",
1586
+ :header_params => header_params,
1587
+ :query_params => query_params,
1588
+ :form_params => form_params,
1589
+ :body => post_body,
1590
+ :auth_names => auth_names,
1591
+ :return_type => return_type
1592
+ )
1593
+
1594
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1595
+ if @api_client.config.debugging
1596
+ @api_client.config.logger.debug "API called: BrandsApi#update_brand_color\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1597
+ end
1598
+ return data, status_code, headers
1599
+ end
1600
+
1601
+ # Update Brand Email Default
1602
+ # Partial update of the brand email defaults for the authenticated account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_email_default.json)
1603
+ # @param id [String] The ID of the brand email defaults (must equal the account ID).
1604
+ # @param brand_email_default_partial_update_query [BrandEmailDefaultPartialUpdateQuery] PATCH /api/brand-email-defaults/{id}: JSON:API field-level partial update.
1605
+ # @param [Hash] opts the optional parameters
1606
+ # @option opts [Array<String>] :fields_brand_email_default For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1607
+ # @return [Hash<String, Object>]
1608
+ def update_brand_email_default(id, brand_email_default_partial_update_query, opts = {})
1609
+ data, _status_code, _headers = update_brand_email_default_with_http_info(id, brand_email_default_partial_update_query, opts)
1610
+ data
1611
+ end
1612
+
1613
+ # Update Brand Email Default
1614
+ # Partial update of the brand email defaults for the authenticated account.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_email_default.json)
1615
+ # @param id [String] The ID of the brand email defaults (must equal the account ID).
1616
+ # @param brand_email_default_partial_update_query [BrandEmailDefaultPartialUpdateQuery] PATCH /api/brand-email-defaults/{id}: JSON:API field-level partial update.
1617
+ # @param [Hash] opts the optional parameters
1618
+ # @option opts [Array<String>] :fields_brand_email_default For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1619
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1620
+ def update_brand_email_default_with_http_info(id, brand_email_default_partial_update_query, opts = {})
1621
+ if @api_client.config.debugging
1622
+ @api_client.config.logger.debug 'Calling API: BrandsApi.update_brand_email_default ...'
1623
+ end
1624
+ # verify the required parameter 'id' is set
1625
+ if @api_client.config.client_side_validation && id.nil?
1626
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.update_brand_email_default"
1627
+ end
1628
+ # verify the required parameter 'brand_email_default_partial_update_query' is set
1629
+ if @api_client.config.client_side_validation && brand_email_default_partial_update_query.nil?
1630
+ fail ArgumentError, "Missing the required parameter 'brand_email_default_partial_update_query' when calling BrandsApi.update_brand_email_default"
1631
+ end
1632
+ allowable_values = ["body", "body.background_color", "body.body_background_color", "body.h1_text", "body.h1_text.color", "body.h1_text.font_family", "body.h1_text.font_size", "body.h1_text.font_style", "body.h1_text.font_weight", "body.h1_text.letter_spacing", "body.h1_text.text_decoration", "body.h2_text", "body.h2_text.color", "body.h2_text.font_family", "body.h2_text.font_size", "body.h2_text.font_style", "body.h2_text.font_weight", "body.h2_text.letter_spacing", "body.h2_text.text_decoration", "body.h3_text", "body.h3_text.color", "body.h3_text.font_family", "body.h3_text.font_size", "body.h3_text.font_style", "body.h3_text.font_weight", "body.h3_text.letter_spacing", "body.h3_text.text_decoration", "body.h4_text", "body.h4_text.color", "body.h4_text.font_family", "body.h4_text.font_size", "body.h4_text.font_style", "body.h4_text.font_weight", "body.h4_text.letter_spacing", "body.h4_text.text_decoration", "body.link_text", "body.link_text.color", "body.link_text.font_family", "body.link_text.font_size", "body.link_text.font_style", "body.link_text.font_weight", "body.link_text.letter_spacing", "body.link_text.text_decoration", "body.text", "body.text.color", "body.text.font_family", "body.text.font_size", "body.text.font_style", "body.text.font_weight", "body.text.letter_spacing", "body.text.text_decoration", "footer", "footer.background_color", "footer.link_text", "footer.link_text.color", "footer.link_text.font_family", "footer.link_text.font_size", "footer.link_text.font_style", "footer.link_text.font_weight", "footer.link_text.letter_spacing", "footer.link_text.text_decoration", "footer.social_group_color", "footer.text", "footer.text.color", "footer.text.font_family", "footer.text.font_size", "footer.text.font_style", "footer.text.font_weight", "footer.text.letter_spacing", "footer.text.text_decoration", "header", "header.background_color", "header.link_text", "header.link_text.color", "header.link_text.font_family", "header.link_text.font_size", "header.link_text.font_style", "header.link_text.font_weight", "header.link_text.letter_spacing", "header.link_text.text_decoration", "header.links", "header.logo_max_width", "id"]
1633
+ if @api_client.config.client_side_validation && opts[:'fields_brand_email_default'] && !opts[:'fields_brand_email_default'].all? { |item| allowable_values.include?(item) }
1634
+ fail ArgumentError, "invalid value for \"fields_brand_email_default\", must include one of #{allowable_values}"
1635
+ end
1636
+ # resource path
1637
+ local_var_path = '/api/brand-email-defaults/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1638
+
1639
+ # query parameters
1640
+ query_params = opts[:query_params] || {}
1641
+ query_params[:'fields[brand-email-default]'] = @api_client.build_collection_param(opts[:'fields_brand_email_default'], :csv) if !opts[:'fields_brand_email_default'].nil?
1642
+
1643
+ # header parameters
1644
+ header_params = opts[:header_params] || {}
1645
+ # klaviyo api revision
1646
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1647
+ # HTTP header 'Accept' (if needed)
1648
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1649
+ # HTTP header 'Content-Type'
1650
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1651
+ if !content_type.nil?
1652
+ header_params['Content-Type'] = content_type
1653
+ end
1654
+
1655
+ # form parameters
1656
+ form_params = opts[:form_params] || {}
1657
+
1658
+ # http body (model)
1659
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_email_default_partial_update_query)
1660
+
1661
+ # return_type
1662
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1663
+
1664
+ # auth_names
1665
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1666
+
1667
+ new_options = opts.merge(
1668
+ :operation => :"BrandsApi.update_brand_email_default",
1669
+ :header_params => header_params,
1670
+ :query_params => query_params,
1671
+ :form_params => form_params,
1672
+ :body => post_body,
1673
+ :auth_names => auth_names,
1674
+ :return_type => return_type
1675
+ )
1676
+
1677
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1678
+ if @api_client.config.debugging
1679
+ @api_client.config.logger.debug "API called: BrandsApi#update_brand_email_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1680
+ end
1681
+ return data, status_code, headers
1682
+ end
1683
+
1684
+ # Update Brand Logo
1685
+ # Update the brand logo with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_logo.json)
1686
+ # @param id [String] The ID of the brand logo.
1687
+ # @param brand_logo_partial_update_query [BrandLogoPartialUpdateQuery] PATCH /api/brand-logos/{id} — JSON:API field-level partial update. Per https://jsonapi.org/format/#crud-updating-resource-attributes, only the top-level attributes/relationships present in the request body are replaced; missing top-level fields are preserved. A client can patch just &#x60;name&#x60; without disturbing &#x60;width&#x60;, &#x60;alt_text&#x60;, the &#x60;image&#x60; relationship, etc. A present top-level field is replaced wholesale (no recursive merge into nested structures), so sending &#x60;\&quot;alt_text\&quot;: null&#x60; clears it. The &#x60;image&#x60; relationship is optional on PATCH — omit to keep the existing image; include with a non-null &#x60;data&#x60; to repoint at a different image. A logo *must* have an image, so the JSON:API \&quot;unlink\&quot; form (&#x60;\&quot;image\&quot;: {\&quot;data\&quot;: null}&#x60;) is not supported and is treated the same as omitting the relationship (existing image preserved).
1688
+ # @param [Hash] opts the optional parameters
1689
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1690
+ # @return [Hash<String, Object>]
1691
+ def update_brand_logo(id, brand_logo_partial_update_query, opts = {})
1692
+ data, _status_code, _headers = update_brand_logo_with_http_info(id, brand_logo_partial_update_query, opts)
1693
+ data
1694
+ end
1695
+
1696
+ # Update Brand Logo
1697
+ # Update the brand logo with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_logo.json)
1698
+ # @param id [String] The ID of the brand logo.
1699
+ # @param brand_logo_partial_update_query [BrandLogoPartialUpdateQuery] PATCH /api/brand-logos/{id} — JSON:API field-level partial update. Per https://jsonapi.org/format/#crud-updating-resource-attributes, only the top-level attributes/relationships present in the request body are replaced; missing top-level fields are preserved. A client can patch just &#x60;name&#x60; without disturbing &#x60;width&#x60;, &#x60;alt_text&#x60;, the &#x60;image&#x60; relationship, etc. A present top-level field is replaced wholesale (no recursive merge into nested structures), so sending &#x60;\&quot;alt_text\&quot;: null&#x60; clears it. The &#x60;image&#x60; relationship is optional on PATCH — omit to keep the existing image; include with a non-null &#x60;data&#x60; to repoint at a different image. A logo *must* have an image, so the JSON:API \&quot;unlink\&quot; form (&#x60;\&quot;image\&quot;: {\&quot;data\&quot;: null}&#x60;) is not supported and is treated the same as omitting the relationship (existing image preserved).
1700
+ # @param [Hash] opts the optional parameters
1701
+ # @option opts [Array<String>] :fields_brand_logo For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1702
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1703
+ def update_brand_logo_with_http_info(id, brand_logo_partial_update_query, opts = {})
1704
+ if @api_client.config.debugging
1705
+ @api_client.config.logger.debug 'Calling API: BrandsApi.update_brand_logo ...'
1706
+ end
1707
+ # verify the required parameter 'id' is set
1708
+ if @api_client.config.client_side_validation && id.nil?
1709
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.update_brand_logo"
1710
+ end
1711
+ # verify the required parameter 'brand_logo_partial_update_query' is set
1712
+ if @api_client.config.client_side_validation && brand_logo_partial_update_query.nil?
1713
+ fail ArgumentError, "Missing the required parameter 'brand_logo_partial_update_query' when calling BrandsApi.update_brand_logo"
1714
+ end
1715
+ allowable_values = ["alt_text", "height", "id", "link_url", "name", "width"]
1716
+ if @api_client.config.client_side_validation && opts[:'fields_brand_logo'] && !opts[:'fields_brand_logo'].all? { |item| allowable_values.include?(item) }
1717
+ fail ArgumentError, "invalid value for \"fields_brand_logo\", must include one of #{allowable_values}"
1718
+ end
1719
+ # resource path
1720
+ local_var_path = '/api/brand-logos/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1721
+
1722
+ # query parameters
1723
+ query_params = opts[:query_params] || {}
1724
+ query_params[:'fields[brand-logo]'] = @api_client.build_collection_param(opts[:'fields_brand_logo'], :csv) if !opts[:'fields_brand_logo'].nil?
1725
+
1726
+ # header parameters
1727
+ header_params = opts[:header_params] || {}
1728
+ # klaviyo api revision
1729
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1730
+ # HTTP header 'Accept' (if needed)
1731
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1732
+ # HTTP header 'Content-Type'
1733
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1734
+ if !content_type.nil?
1735
+ header_params['Content-Type'] = content_type
1736
+ end
1737
+
1738
+ # form parameters
1739
+ form_params = opts[:form_params] || {}
1740
+
1741
+ # http body (model)
1742
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_logo_partial_update_query)
1743
+
1744
+ # return_type
1745
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1746
+
1747
+ # auth_names
1748
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1749
+
1750
+ new_options = opts.merge(
1751
+ :operation => :"BrandsApi.update_brand_logo",
1752
+ :header_params => header_params,
1753
+ :query_params => query_params,
1754
+ :form_params => form_params,
1755
+ :body => post_body,
1756
+ :auth_names => auth_names,
1757
+ :return_type => return_type
1758
+ )
1759
+
1760
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1761
+ if @api_client.config.debugging
1762
+ @api_client.config.logger.debug "API called: BrandsApi#update_brand_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1763
+ end
1764
+ return data, status_code, headers
1765
+ end
1766
+
1767
+ # Update Brand Social Group
1768
+ # Update the brand social group with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_social_group.json)
1769
+ # @param id [String] The ID of the brand social group.
1770
+ # @param brand_social_group_partial_update_query [BrandSocialGroupPartialUpdateQuery]
1771
+ # @param [Hash] opts the optional parameters
1772
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1773
+ # @return [Hash<String, Object>]
1774
+ def update_brand_social_group(id, brand_social_group_partial_update_query, opts = {})
1775
+ data, _status_code, _headers = update_brand_social_group_with_http_info(id, brand_social_group_partial_update_query, opts)
1776
+ data
1777
+ end
1778
+
1779
+ # Update Brand Social Group
1780
+ # Update the brand social group with the given ID.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_social_group.json)
1781
+ # @param id [String] The ID of the brand social group.
1782
+ # @param brand_social_group_partial_update_query [BrandSocialGroupPartialUpdateQuery]
1783
+ # @param [Hash] opts the optional parameters
1784
+ # @option opts [Array<String>] :fields_brand_social_group For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1785
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1786
+ def update_brand_social_group_with_http_info(id, brand_social_group_partial_update_query, opts = {})
1787
+ if @api_client.config.debugging
1788
+ @api_client.config.logger.debug 'Calling API: BrandsApi.update_brand_social_group ...'
1789
+ end
1790
+ # verify the required parameter 'id' is set
1791
+ if @api_client.config.client_side_validation && id.nil?
1792
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.update_brand_social_group"
1793
+ end
1794
+ # verify the required parameter 'brand_social_group_partial_update_query' is set
1795
+ if @api_client.config.client_side_validation && brand_social_group_partial_update_query.nil?
1796
+ fail ArgumentError, "Missing the required parameter 'brand_social_group_partial_update_query' when calling BrandsApi.update_brand_social_group"
1797
+ end
1798
+ allowable_values = ["id", "name", "social_links"]
1799
+ if @api_client.config.client_side_validation && opts[:'fields_brand_social_group'] && !opts[:'fields_brand_social_group'].all? { |item| allowable_values.include?(item) }
1800
+ fail ArgumentError, "invalid value for \"fields_brand_social_group\", must include one of #{allowable_values}"
1801
+ end
1802
+ # resource path
1803
+ local_var_path = '/api/brand-social-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1804
+
1805
+ # query parameters
1806
+ query_params = opts[:query_params] || {}
1807
+ query_params[:'fields[brand-social-group]'] = @api_client.build_collection_param(opts[:'fields_brand_social_group'], :csv) if !opts[:'fields_brand_social_group'].nil?
1808
+
1809
+ # header parameters
1810
+ header_params = opts[:header_params] || {}
1811
+ # klaviyo api revision
1812
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1813
+ # HTTP header 'Accept' (if needed)
1814
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1815
+ # HTTP header 'Content-Type'
1816
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1817
+ if !content_type.nil?
1818
+ header_params['Content-Type'] = content_type
1819
+ end
1820
+
1821
+ # form parameters
1822
+ form_params = opts[:form_params] || {}
1823
+
1824
+ # http body (model)
1825
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_social_group_partial_update_query)
1826
+
1827
+ # return_type
1828
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1829
+
1830
+ # auth_names
1831
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1832
+
1833
+ new_options = opts.merge(
1834
+ :operation => :"BrandsApi.update_brand_social_group",
1835
+ :header_params => header_params,
1836
+ :query_params => query_params,
1837
+ :form_params => form_params,
1838
+ :body => post_body,
1839
+ :auth_names => auth_names,
1840
+ :return_type => return_type
1841
+ )
1842
+
1843
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1844
+ if @api_client.config.debugging
1845
+ @api_client.config.logger.debug "API called: BrandsApi#update_brand_social_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1846
+ end
1847
+ return data, status_code, headers
1848
+ end
1849
+
1850
+ # Update Brand Voice
1851
+ # Update the brand voice for the authenticated company.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `brands:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_voice.json)
1852
+ # @param id [String] The company ID. Must match the authenticated account.
1853
+ # @param brand_voice_partial_update_query [BrandVoicePartialUpdateQuery] PATCH /api/brand-voice/{company_id} — JSON:API field-level partial update. Per https://jsonapi.org/format/#crud-updating-resource-attributes, only the top-level attributes present in the request body are replaced; missing top-level fields are preserved. A client can patch just &#x60;tone_descriptors&#x60; without disturbing &#x60;language_patterns&#x60;, and vice versa. A present top-level field is replaced wholesale (no recursive merge into the list contents) — the underlying service treats &#x60;tone_descriptors&#x60; and &#x60;language_patterns&#x60; as full-list replacements, so partial-list edits must be done client-side by reading, modifying, and writing the full list. The path &#x60;id&#x60; must equal the auth context&#39;s company id; mismatches return 404.
1854
+ # @param [Hash] opts the optional parameters
1855
+ # @option opts [Array<String>] :fields_brand_voice For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1856
+ # @return [Hash<String, Object>]
1857
+ def update_brand_voice(id, brand_voice_partial_update_query, opts = {})
1858
+ data, _status_code, _headers = update_brand_voice_with_http_info(id, brand_voice_partial_update_query, opts)
1859
+ data
1860
+ end
1861
+
1862
+ # Update Brand Voice
1863
+ # Update the brand voice for the authenticated company.&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;brands:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_brand_voice.json)
1864
+ # @param id [String] The company ID. Must match the authenticated account.
1865
+ # @param brand_voice_partial_update_query [BrandVoicePartialUpdateQuery] PATCH /api/brand-voice/{company_id} — JSON:API field-level partial update. Per https://jsonapi.org/format/#crud-updating-resource-attributes, only the top-level attributes present in the request body are replaced; missing top-level fields are preserved. A client can patch just &#x60;tone_descriptors&#x60; without disturbing &#x60;language_patterns&#x60;, and vice versa. A present top-level field is replaced wholesale (no recursive merge into the list contents) — the underlying service treats &#x60;tone_descriptors&#x60; and &#x60;language_patterns&#x60; as full-list replacements, so partial-list edits must be done client-side by reading, modifying, and writing the full list. The path &#x60;id&#x60; must equal the auth context&#39;s company id; mismatches return 404.
1866
+ # @param [Hash] opts the optional parameters
1867
+ # @option opts [Array<String>] :fields_brand_voice For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1868
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1869
+ def update_brand_voice_with_http_info(id, brand_voice_partial_update_query, opts = {})
1870
+ if @api_client.config.debugging
1871
+ @api_client.config.logger.debug 'Calling API: BrandsApi.update_brand_voice ...'
1872
+ end
1873
+ # verify the required parameter 'id' is set
1874
+ if @api_client.config.client_side_validation && id.nil?
1875
+ fail ArgumentError, "Missing the required parameter 'id' when calling BrandsApi.update_brand_voice"
1876
+ end
1877
+ # verify the required parameter 'brand_voice_partial_update_query' is set
1878
+ if @api_client.config.client_side_validation && brand_voice_partial_update_query.nil?
1879
+ fail ArgumentError, "Missing the required parameter 'brand_voice_partial_update_query' when calling BrandsApi.update_brand_voice"
1880
+ end
1881
+ allowable_values = ["id", "language_patterns", "tone_descriptors", "version"]
1882
+ if @api_client.config.client_side_validation && opts[:'fields_brand_voice'] && !opts[:'fields_brand_voice'].all? { |item| allowable_values.include?(item) }
1883
+ fail ArgumentError, "invalid value for \"fields_brand_voice\", must include one of #{allowable_values}"
1884
+ end
1885
+ # resource path
1886
+ local_var_path = '/api/brand-voice/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1887
+
1888
+ # query parameters
1889
+ query_params = opts[:query_params] || {}
1890
+ query_params[:'fields[brand-voice]'] = @api_client.build_collection_param(opts[:'fields_brand_voice'], :csv) if !opts[:'fields_brand_voice'].nil?
1891
+
1892
+ # header parameters
1893
+ header_params = opts[:header_params] || {}
1894
+ # klaviyo api revision
1895
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1896
+ # HTTP header 'Accept' (if needed)
1897
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1898
+ # HTTP header 'Content-Type'
1899
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1900
+ if !content_type.nil?
1901
+ header_params['Content-Type'] = content_type
1902
+ end
1903
+
1904
+ # form parameters
1905
+ form_params = opts[:form_params] || {}
1906
+
1907
+ # http body (model)
1908
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(brand_voice_partial_update_query)
1909
+
1910
+ # return_type
1911
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1912
+
1913
+ # auth_names
1914
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1915
+
1916
+ new_options = opts.merge(
1917
+ :operation => :"BrandsApi.update_brand_voice",
1918
+ :header_params => header_params,
1919
+ :query_params => query_params,
1920
+ :form_params => form_params,
1921
+ :body => post_body,
1922
+ :auth_names => auth_names,
1923
+ :return_type => return_type
1924
+ )
1925
+
1926
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1927
+ if @api_client.config.debugging
1928
+ @api_client.config.logger.debug "API called: BrandsApi#update_brand_voice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1929
+ end
1930
+ return data, status_code, headers
1931
+ end
1932
+ end
1933
+ end