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
@@ -19,7 +19,7 @@ module KlaviyoAPI
19
19
  @api_client = api_client
20
20
  end
21
21
  # Bulk Create Data Source Records
22
- # Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m` **Scopes:** `custom-objects:write`
22
+ # Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_data_source_records.json)
23
23
  # @param data_source_record_bulk_create_job_create_query [DataSourceRecordBulkCreateJobCreateQuery] Create a data source record job
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [nil]
@@ -32,7 +32,7 @@ module KlaviyoAPI
32
32
  alias create_data_source_record_bulk_create_job bulk_create_data_source_records
33
33
 
34
34
  # Bulk Create Data Source Records
35
- # Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;custom-objects:write&#x60;
35
+ # Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_data_source_records.json)
36
36
  # @param data_source_record_bulk_create_job_create_query [DataSourceRecordBulkCreateJobCreateQuery] Create a data source record job
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -53,7 +53,7 @@ module KlaviyoAPI
53
53
  # header parameters
54
54
  header_params = opts[:header_params] || {}
55
55
  # klaviyo api revision
56
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
56
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
57
57
  # HTTP header 'Accept' (if needed)
58
58
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
59
59
  # HTTP header 'Content-Type'
@@ -94,10 +94,87 @@ module KlaviyoAPI
94
94
  # alias of `bulk_create_data_source_records_with_http_info`
95
95
  alias create_data_source_record_bulk_create_job_with_http_info bulk_create_data_source_records_with_http_info
96
96
 
97
+ # Bulk Delete Object Records
98
+ # Delete a batch of object records. Accepts up to 500 object record IDs per request. The maximum allowed payload size is 5MB.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_object_records.json)
99
+ # @param object_record_delete_job_create_query [ObjectRecordDeleteJobCreateQuery]
100
+ # @param [Hash] opts the optional parameters
101
+ # @return [nil]
102
+ def bulk_delete_object_records(object_record_delete_job_create_query, opts = {})
103
+ bulk_delete_object_records_with_http_info(object_record_delete_job_create_query, opts)
104
+ nil
105
+ end
106
+
107
+ # alias of `bulk_delete_object_records`
108
+ alias create_object_record_bulk_delete_job bulk_delete_object_records
109
+
110
+ # Bulk Delete Object Records
111
+ # Delete a batch of object records. Accepts up to 500 object record IDs per request. The maximum allowed payload size is 5MB.&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_object_records.json)
112
+ # @param object_record_delete_job_create_query [ObjectRecordDeleteJobCreateQuery]
113
+ # @param [Hash] opts the optional parameters
114
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
115
+ def bulk_delete_object_records_with_http_info(object_record_delete_job_create_query, opts = {})
116
+ if @api_client.config.debugging
117
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.bulk_delete_object_records ...'
118
+ end
119
+ # verify the required parameter 'object_record_delete_job_create_query' is set
120
+ if @api_client.config.client_side_validation && object_record_delete_job_create_query.nil?
121
+ fail ArgumentError, "Missing the required parameter 'object_record_delete_job_create_query' when calling CustomObjectsApi.bulk_delete_object_records"
122
+ end
123
+ # resource path
124
+ local_var_path = '/api/object-record-bulk-delete-jobs'
125
+
126
+ # query parameters
127
+ query_params = opts[:query_params] || {}
128
+
129
+ # header parameters
130
+ header_params = opts[:header_params] || {}
131
+ # klaviyo api revision
132
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
133
+ # HTTP header 'Accept' (if needed)
134
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
135
+ # HTTP header 'Content-Type'
136
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
137
+ if !content_type.nil?
138
+ header_params['Content-Type'] = content_type
139
+ end
140
+
141
+ # form parameters
142
+ form_params = opts[:form_params] || {}
143
+
144
+ # http body (model)
145
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_record_delete_job_create_query)
146
+
147
+ # return_type
148
+ return_type = opts[:debug_return_type]
149
+
150
+ # auth_names
151
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
152
+
153
+ new_options = opts.merge(
154
+ :operation => :"CustomObjectsApi.bulk_delete_object_records",
155
+ :header_params => header_params,
156
+ :query_params => query_params,
157
+ :form_params => form_params,
158
+ :body => post_body,
159
+ :auth_names => auth_names,
160
+ :return_type => return_type
161
+ )
162
+
163
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
164
+ if @api_client.config.debugging
165
+ @api_client.config.logger.debug "API called: CustomObjectsApi#bulk_delete_object_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
166
+ end
167
+ return data, status_code, headers
168
+ end
169
+
170
+ # alias of `bulk_delete_object_records_with_http_info`
171
+ alias create_object_record_bulk_delete_job_with_http_info bulk_delete_object_records_with_http_info
172
+
97
173
  # Create Data Source
98
- # Create a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write`
174
+ # Create a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)
99
175
  # @param data_source_create_query [DataSourceCreateQuery] Create data source
100
176
  # @param [Hash] opts the optional parameters
177
+ # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
101
178
  # @return [Hash<String, Object>]
102
179
  def create_data_source(data_source_create_query, opts = {})
103
180
  data, _status_code, _headers = create_data_source_with_http_info(data_source_create_query, opts)
@@ -105,9 +182,10 @@ module KlaviyoAPI
105
182
  end
106
183
 
107
184
  # Create Data Source
108
- # Create a new data source in an 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;custom-objects:write&#x60;
185
+ # Create a new data source in an 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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)
109
186
  # @param data_source_create_query [DataSourceCreateQuery] Create data source
110
187
  # @param [Hash] opts the optional parameters
188
+ # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
111
189
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
112
190
  def create_data_source_with_http_info(data_source_create_query, opts = {})
113
191
  if @api_client.config.debugging
@@ -117,16 +195,21 @@ module KlaviyoAPI
117
195
  if @api_client.config.client_side_validation && data_source_create_query.nil?
118
196
  fail ArgumentError, "Missing the required parameter 'data_source_create_query' when calling CustomObjectsApi.create_data_source"
119
197
  end
198
+ allowable_values = ["description", "id", "namespace", "title", "visibility"]
199
+ if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
200
+ fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
201
+ end
120
202
  # resource path
121
203
  local_var_path = '/api/data-sources'
122
204
 
123
205
  # query parameters
124
206
  query_params = opts[:query_params] || {}
207
+ query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
125
208
 
126
209
  # header parameters
127
210
  header_params = opts[:header_params] || {}
128
211
  # klaviyo api revision
129
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
212
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
130
213
  # HTTP header 'Accept' (if needed)
131
214
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
132
215
  # HTTP header 'Content-Type'
@@ -165,7 +248,7 @@ module KlaviyoAPI
165
248
  end
166
249
 
167
250
  # Create Data Source Record
168
- # Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `custom-objects:write`
251
+ # Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source_record.json)
169
252
  # @param data_source_record_create_job_create_query [DataSourceRecordCreateJobCreateQuery] Create a data source record job
170
253
  # @param [Hash] opts the optional parameters
171
254
  # @return [nil]
@@ -178,7 +261,7 @@ module KlaviyoAPI
178
261
  alias create_data_source_record_create_job create_data_source_record
179
262
 
180
263
  # Create Data Source Record
181
- # Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;750/m&#x60; **Scopes:** &#x60;custom-objects:write&#x60;
264
+ # Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;750/m&#x60; **Scopes:** &#x60;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source_record.json)
182
265
  # @param data_source_record_create_job_create_query [DataSourceRecordCreateJobCreateQuery] Create a data source record job
183
266
  # @param [Hash] opts the optional parameters
184
267
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -199,7 +282,7 @@ module KlaviyoAPI
199
282
  # header parameters
200
283
  header_params = opts[:header_params] || {}
201
284
  # klaviyo api revision
202
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
285
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
203
286
  # HTTP header 'Accept' (if needed)
204
287
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
205
288
  # HTTP header 'Content-Type'
@@ -240,31 +323,120 @@ module KlaviyoAPI
240
323
  # alias of `create_data_source_record_with_http_info`
241
324
  alias create_data_source_record_create_job_with_http_info create_data_source_record_with_http_info
242
325
 
243
- # Delete Data Source
244
- # Delete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write`
245
- # @param id [String] The ID of the data source to delete
326
+ # Create Object Schema
327
+ # Create an object schema.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_schema.json)
328
+ # @param object_schema_create_query [ObjectSchemaCreateQuery] Create an object schema
329
+ # @param [Hash] opts the optional parameters
330
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
331
+ # @return [Hash<String, Object>]
332
+ def create_object_schema(object_schema_create_query, opts = {})
333
+ data, _status_code, _headers = create_object_schema_with_http_info(object_schema_create_query, opts)
334
+ data
335
+ end
336
+
337
+ # Create Object Schema
338
+ # Create an object schema.&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_schema.json)
339
+ # @param object_schema_create_query [ObjectSchemaCreateQuery] Create an object schema
340
+ # @param [Hash] opts the optional parameters
341
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
342
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
343
+ def create_object_schema_with_http_info(object_schema_create_query, opts = {})
344
+ if @api_client.config.debugging
345
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_object_schema ...'
346
+ end
347
+ # verify the required parameter 'object_schema_create_query' is set
348
+ if @api_client.config.client_side_validation && object_schema_create_query.nil?
349
+ fail ArgumentError, "Missing the required parameter 'object_schema_create_query' when calling CustomObjectsApi.create_object_schema"
350
+ end
351
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
352
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
353
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
354
+ end
355
+ # resource path
356
+ local_var_path = '/api/object-schemas'
357
+
358
+ # query parameters
359
+ query_params = opts[:query_params] || {}
360
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
361
+
362
+ # header parameters
363
+ header_params = opts[:header_params] || {}
364
+ # klaviyo api revision
365
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
366
+ # HTTP header 'Accept' (if needed)
367
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
368
+ # HTTP header 'Content-Type'
369
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
370
+ if !content_type.nil?
371
+ header_params['Content-Type'] = content_type
372
+ end
373
+
374
+ # form parameters
375
+ form_params = opts[:form_params] || {}
376
+
377
+ # http body (model)
378
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_schema_create_query)
379
+
380
+ # return_type
381
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
382
+
383
+ # auth_names
384
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
385
+
386
+ new_options = opts.merge(
387
+ :operation => :"CustomObjectsApi.create_object_schema",
388
+ :header_params => header_params,
389
+ :query_params => query_params,
390
+ :form_params => form_params,
391
+ :body => post_body,
392
+ :auth_names => auth_names,
393
+ :return_type => return_type
394
+ )
395
+
396
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
397
+ if @api_client.config.debugging
398
+ @api_client.config.logger.debug "API called: CustomObjectsApi#create_object_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
399
+ end
400
+ return data, status_code, headers
401
+ end
402
+
403
+ # Create Object Schema Relationship
404
+ # Create a relationship between object schemas. Note that flow filtering and segmentation are currently not supported for object-to-object relationships.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_schema_relationship.json)
405
+ # @param id [String] The ULID ID of the object schema.
406
+ # @param object_schema_relationship_create_query [ObjectSchemaRelationshipCreateQuery] Create a relationship between object schemas
246
407
  # @param [Hash] opts the optional parameters
247
408
  # @return [nil]
248
- def delete_data_source(id, opts = {})
249
- delete_data_source_with_http_info(id, opts)
409
+ def create_object_schema_relationship(id, object_schema_relationship_create_query, opts = {})
410
+ create_object_schema_relationship_with_http_info(id, object_schema_relationship_create_query, opts)
250
411
  nil
251
412
  end
252
413
 
253
- # Delete Data Source
254
- # Delete a data source in an 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;custom-objects:write&#x60;
255
- # @param id [String] The ID of the data source to delete
414
+ # alias of `create_object_schema_relationship`
415
+ alias add_schemas_to_object_schema create_object_schema_relationship
416
+
417
+ # alias of `create_object_schema_relationship`
418
+ alias create_object_schema_relationships_schemas create_object_schema_relationship
419
+
420
+ # Create Object Schema Relationship
421
+ # Create a relationship between object schemas. Note that flow filtering and segmentation are currently not supported for object-to-object relationships.&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_schema_relationship.json)
422
+ # @param id [String] The ULID ID of the object schema.
423
+ # @param object_schema_relationship_create_query [ObjectSchemaRelationshipCreateQuery] Create a relationship between object schemas
256
424
  # @param [Hash] opts the optional parameters
257
425
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
258
- def delete_data_source_with_http_info(id, opts = {})
426
+ def create_object_schema_relationship_with_http_info(id, object_schema_relationship_create_query, opts = {})
259
427
  if @api_client.config.debugging
260
- @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_data_source ...'
428
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_object_schema_relationship ...'
261
429
  end
262
430
  # verify the required parameter 'id' is set
263
431
  if @api_client.config.client_side_validation && id.nil?
264
- fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_data_source"
432
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.create_object_schema_relationship"
433
+ end
434
+ # verify the required parameter 'object_schema_relationship_create_query' is set
435
+ if @api_client.config.client_side_validation && object_schema_relationship_create_query.nil?
436
+ fail ArgumentError, "Missing the required parameter 'object_schema_relationship_create_query' when calling CustomObjectsApi.create_object_schema_relationship"
265
437
  end
266
438
  # resource path
267
- local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
439
+ local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
268
440
 
269
441
  # query parameters
270
442
  query_params = opts[:query_params] || {}
@@ -272,15 +444,20 @@ module KlaviyoAPI
272
444
  # header parameters
273
445
  header_params = opts[:header_params] || {}
274
446
  # klaviyo api revision
275
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
447
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
276
448
  # HTTP header 'Accept' (if needed)
277
449
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
450
+ # HTTP header 'Content-Type'
451
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
452
+ if !content_type.nil?
453
+ header_params['Content-Type'] = content_type
454
+ end
278
455
 
279
456
  # form parameters
280
457
  form_params = opts[:form_params] || {}
281
458
 
282
459
  # http body (model)
283
- post_body = opts[:debug_body]
460
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_schema_relationship_create_query)
284
461
 
285
462
  # return_type
286
463
  return_type = opts[:debug_return_type]
@@ -289,7 +466,7 @@ module KlaviyoAPI
289
466
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
290
467
 
291
468
  new_options = opts.merge(
292
- :operation => :"CustomObjectsApi.delete_data_source",
469
+ :operation => :"CustomObjectsApi.create_object_schema_relationship",
293
470
  :header_params => header_params,
294
471
  :query_params => query_params,
295
472
  :form_params => form_params,
@@ -298,61 +475,72 @@ module KlaviyoAPI
298
475
  :return_type => return_type
299
476
  )
300
477
 
301
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
478
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
302
479
  if @api_client.config.debugging
303
- @api_client.config.logger.debug "API called: CustomObjectsApi#delete_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
480
+ @api_client.config.logger.debug "API called: CustomObjectsApi#create_object_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
304
481
  end
305
482
  return data, status_code, headers
306
483
  end
307
484
 
308
- # Get Data Source
309
- # Retrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read`
310
- # @param id [String] The ID of the data source
485
+ # alias of `create_object_schema_relationship_with_http_info`
486
+ alias add_schemas_to_object_schema_with_http_info create_object_schema_relationship_with_http_info
487
+
488
+ # alias of `create_object_schema_relationship_with_http_info`
489
+ alias create_object_schema_relationships_schemas_with_http_info create_object_schema_relationship_with_http_info
490
+
491
+ # Create Object Type
492
+ # Create an object type.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_type.json)
493
+ # @param object_type_create_query [ObjectTypeCreateQuery] Create an object type
311
494
  # @param [Hash] opts the optional parameters
312
- # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
495
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
313
496
  # @return [Hash<String, Object>]
314
- def get_data_source(id, opts = {})
315
- data, _status_code, _headers = get_data_source_with_http_info(id, opts)
497
+ def create_object_type(object_type_create_query, opts = {})
498
+ data, _status_code, _headers = create_object_type_with_http_info(object_type_create_query, opts)
316
499
  data
317
500
  end
318
501
 
319
- # Get Data Source
320
- # Retrieve a data source in an 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;custom-objects:read&#x60;
321
- # @param id [String] The ID of the data source
502
+ # Create Object Type
503
+ # Create an object type.&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_object_type.json)
504
+ # @param object_type_create_query [ObjectTypeCreateQuery] Create an object type
322
505
  # @param [Hash] opts the optional parameters
323
- # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
506
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
324
507
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
325
- def get_data_source_with_http_info(id, opts = {})
508
+ def create_object_type_with_http_info(object_type_create_query, opts = {})
326
509
  if @api_client.config.debugging
327
- @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_source ...'
510
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_object_type ...'
328
511
  end
329
- # verify the required parameter 'id' is set
330
- if @api_client.config.client_side_validation && id.nil?
331
- fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_data_source"
512
+ # verify the required parameter 'object_type_create_query' is set
513
+ if @api_client.config.client_side_validation && object_type_create_query.nil?
514
+ fail ArgumentError, "Missing the required parameter 'object_type_create_query' when calling CustomObjectsApi.create_object_type"
332
515
  end
333
- allowable_values = ["description", "namespace", "title", "visibility"]
334
- if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
335
- fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
516
+ allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
517
+ if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
518
+ fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
336
519
  end
337
520
  # resource path
338
- local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
521
+ local_var_path = '/api/object-types'
339
522
 
340
523
  # query parameters
341
524
  query_params = opts[:query_params] || {}
342
- query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
525
+ query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
343
526
 
344
527
  # header parameters
345
528
  header_params = opts[:header_params] || {}
346
529
  # klaviyo api revision
347
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
530
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
348
531
  # HTTP header 'Accept' (if needed)
349
532
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
533
+ # HTTP header 'Content-Type'
534
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
535
+ if !content_type.nil?
536
+ header_params['Content-Type'] = content_type
537
+ end
350
538
 
351
539
  # form parameters
352
540
  form_params = opts[:form_params] || {}
353
541
 
354
542
  # http body (model)
355
- post_body = opts[:debug_body]
543
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_type_create_query)
356
544
 
357
545
  # return_type
358
546
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'
@@ -361,7 +549,7 @@ module KlaviyoAPI
361
549
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
362
550
 
363
551
  new_options = opts.merge(
364
- :operation => :"CustomObjectsApi.get_data_source",
552
+ :operation => :"CustomObjectsApi.create_object_type",
365
553
  :header_params => header_params,
366
554
  :query_params => query_params,
367
555
  :form_params => form_params,
@@ -370,61 +558,134 @@ module KlaviyoAPI
370
558
  :return_type => return_type
371
559
  )
372
560
 
373
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
561
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
374
562
  if @api_client.config.debugging
375
- @api_client.config.logger.debug "API called: CustomObjectsApi#get_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
563
+ @api_client.config.logger.debug "API called: CustomObjectsApi#create_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
376
564
  end
377
565
  return data, status_code, headers
378
566
  end
379
567
 
380
- # Get Data Sources
381
- # Get all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read`
568
+ # Create Profile Schema Relationship
569
+ # Create a relationship between an object schema and a profile<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile_schema_relationship.json)
570
+ # @param id [String] The ULID ID of the object schema.
571
+ # @param profile_object_schema_relationship_create_query [ProfileObjectSchemaRelationshipCreateQuery] Create a relationship between an object schema and a profile.
382
572
  # @param [Hash] opts the optional parameters
383
- # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
384
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination
385
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
386
- # @return [Hash<String, Object>]
387
- def get_data_sources(opts = {})
388
- data, _status_code, _headers = get_data_sources_with_http_info(opts)
389
- data
573
+ # @return [nil]
574
+ def create_profile_schema_relationship(id, profile_object_schema_relationship_create_query, opts = {})
575
+ create_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_create_query, opts)
576
+ nil
390
577
  end
391
578
 
392
- # Get Data Sources
393
- # Get all data sources in an 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;custom-objects:read&#x60;
579
+ # alias of `create_profile_schema_relationship`
580
+ alias add_profile_object_schemas_to_object_schema create_profile_schema_relationship
581
+
582
+ # alias of `create_profile_schema_relationship`
583
+ alias create_object_schema_relationships_profile_object_schemas create_profile_schema_relationship
584
+
585
+ # Create Profile Schema Relationship
586
+ # Create a relationship between an object schema and a profile&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile_schema_relationship.json)
587
+ # @param id [String] The ULID ID of the object schema.
588
+ # @param profile_object_schema_relationship_create_query [ProfileObjectSchemaRelationshipCreateQuery] Create a relationship between an object schema and a profile.
394
589
  # @param [Hash] opts the optional parameters
395
- # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets
396
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination
397
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
398
- # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
399
- def get_data_sources_with_http_info(opts = {})
590
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
591
+ def create_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_create_query, opts = {})
400
592
  if @api_client.config.debugging
401
- @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_sources ...'
593
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_profile_schema_relationship ...'
402
594
  end
403
- allowable_values = ["description", "namespace", "title", "visibility"]
404
- if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
405
- fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
595
+ # verify the required parameter 'id' is set
596
+ if @api_client.config.client_side_validation && id.nil?
597
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.create_profile_schema_relationship"
406
598
  end
407
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
408
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be smaller than or equal to 100.'
599
+ # verify the required parameter 'profile_object_schema_relationship_create_query' is set
600
+ if @api_client.config.client_side_validation && profile_object_schema_relationship_create_query.nil?
601
+ fail ArgumentError, "Missing the required parameter 'profile_object_schema_relationship_create_query' when calling CustomObjectsApi.create_profile_schema_relationship"
409
602
  end
603
+ # resource path
604
+ local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
410
605
 
411
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
412
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be greater than or equal to 1.'
606
+ # query parameters
607
+ query_params = opts[:query_params] || {}
608
+
609
+ # header parameters
610
+ header_params = opts[:header_params] || {}
611
+ # klaviyo api revision
612
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
613
+ # HTTP header 'Accept' (if needed)
614
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
615
+ # HTTP header 'Content-Type'
616
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
617
+ if !content_type.nil?
618
+ header_params['Content-Type'] = content_type
619
+ end
620
+
621
+ # form parameters
622
+ form_params = opts[:form_params] || {}
623
+
624
+ # http body (model)
625
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_object_schema_relationship_create_query)
626
+
627
+ # return_type
628
+ return_type = opts[:debug_return_type]
629
+
630
+ # auth_names
631
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
632
+
633
+ new_options = opts.merge(
634
+ :operation => :"CustomObjectsApi.create_profile_schema_relationship",
635
+ :header_params => header_params,
636
+ :query_params => query_params,
637
+ :form_params => form_params,
638
+ :body => post_body,
639
+ :auth_names => auth_names,
640
+ :return_type => return_type
641
+ )
642
+
643
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
644
+ if @api_client.config.debugging
645
+ @api_client.config.logger.debug "API called: CustomObjectsApi#create_profile_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
413
646
  end
647
+ return data, status_code, headers
648
+ end
414
649
 
650
+ # alias of `create_profile_schema_relationship_with_http_info`
651
+ alias add_profile_object_schemas_to_object_schema_with_http_info create_profile_schema_relationship_with_http_info
652
+
653
+ # alias of `create_profile_schema_relationship_with_http_info`
654
+ alias create_object_schema_relationships_profile_object_schemas_with_http_info create_profile_schema_relationship_with_http_info
655
+
656
+ # Delete Data Source
657
+ # Delete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_data_source.json)
658
+ # @param id [String] The ID of the data source to delete
659
+ # @param [Hash] opts the optional parameters
660
+ # @return [nil]
661
+ def delete_data_source(id, opts = {})
662
+ delete_data_source_with_http_info(id, opts)
663
+ nil
664
+ end
665
+
666
+ # Delete Data Source
667
+ # Delete a data source in an 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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_data_source.json)
668
+ # @param id [String] The ID of the data source to delete
669
+ # @param [Hash] opts the optional parameters
670
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
671
+ def delete_data_source_with_http_info(id, opts = {})
672
+ if @api_client.config.debugging
673
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_data_source ...'
674
+ end
675
+ # verify the required parameter 'id' is set
676
+ if @api_client.config.client_side_validation && id.nil?
677
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_data_source"
678
+ end
415
679
  # resource path
416
- local_var_path = '/api/data-sources'
680
+ local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
417
681
 
418
682
  # query parameters
419
683
  query_params = opts[:query_params] || {}
420
- query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
421
- query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
422
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
423
684
 
424
685
  # header parameters
425
686
  header_params = opts[:header_params] || {}
426
687
  # klaviyo api revision
427
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-04-15"
688
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
428
689
  # HTTP header 'Accept' (if needed)
429
690
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
430
691
 
@@ -435,13 +696,2082 @@ module KlaviyoAPI
435
696
  post_body = opts[:debug_body]
436
697
 
437
698
  # return_type
438
- return_type = opts[:debug_return_type] || 'Hash<String, Object>'
699
+ return_type = opts[:debug_return_type]
439
700
 
440
701
  # auth_names
441
702
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
442
703
 
443
704
  new_options = opts.merge(
444
- :operation => :"CustomObjectsApi.get_data_sources",
705
+ :operation => :"CustomObjectsApi.delete_data_source",
706
+ :header_params => header_params,
707
+ :query_params => query_params,
708
+ :form_params => form_params,
709
+ :body => post_body,
710
+ :auth_names => auth_names,
711
+ :return_type => return_type
712
+ )
713
+
714
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
715
+ if @api_client.config.debugging
716
+ @api_client.config.logger.debug "API called: CustomObjectsApi#delete_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
717
+ end
718
+ return data, status_code, headers
719
+ end
720
+
721
+ # Delete Object Schema Relationship
722
+ # Delete a relationship between object schemas<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_object_schema_relationship.json)
723
+ # @param id [String] The ULID ID of the object schema.
724
+ # @param object_schema_relationship_delete_query [ObjectSchemaRelationshipDeleteQuery] Delete a relationship between object schemas
725
+ # @param [Hash] opts the optional parameters
726
+ # @return [nil]
727
+ def delete_object_schema_relationship(id, object_schema_relationship_delete_query, opts = {})
728
+ delete_object_schema_relationship_with_http_info(id, object_schema_relationship_delete_query, opts)
729
+ nil
730
+ end
731
+
732
+ # alias of `delete_object_schema_relationship`
733
+ alias delete_object_schema_relationships_schemas delete_object_schema_relationship
734
+
735
+ # alias of `delete_object_schema_relationship`
736
+ alias remove_schemas_from_object_schema delete_object_schema_relationship
737
+
738
+ # Delete Object Schema Relationship
739
+ # Delete a relationship between object schemas&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_object_schema_relationship.json)
740
+ # @param id [String] The ULID ID of the object schema.
741
+ # @param object_schema_relationship_delete_query [ObjectSchemaRelationshipDeleteQuery] Delete a relationship between object schemas
742
+ # @param [Hash] opts the optional parameters
743
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
744
+ def delete_object_schema_relationship_with_http_info(id, object_schema_relationship_delete_query, opts = {})
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_object_schema_relationship ...'
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 CustomObjectsApi.delete_object_schema_relationship"
751
+ end
752
+ # verify the required parameter 'object_schema_relationship_delete_query' is set
753
+ if @api_client.config.client_side_validation && object_schema_relationship_delete_query.nil?
754
+ fail ArgumentError, "Missing the required parameter 'object_schema_relationship_delete_query' when calling CustomObjectsApi.delete_object_schema_relationship"
755
+ end
756
+ # resource path
757
+ local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
758
+
759
+ # query parameters
760
+ query_params = opts[:query_params] || {}
761
+
762
+ # header parameters
763
+ header_params = opts[:header_params] || {}
764
+ # klaviyo api revision
765
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
766
+ # HTTP header 'Accept' (if needed)
767
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
768
+ # HTTP header 'Content-Type'
769
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
770
+ if !content_type.nil?
771
+ header_params['Content-Type'] = content_type
772
+ end
773
+
774
+ # form parameters
775
+ form_params = opts[:form_params] || {}
776
+
777
+ # http body (model)
778
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_schema_relationship_delete_query)
779
+
780
+ # return_type
781
+ return_type = opts[:debug_return_type]
782
+
783
+ # auth_names
784
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
785
+
786
+ new_options = opts.merge(
787
+ :operation => :"CustomObjectsApi.delete_object_schema_relationship",
788
+ :header_params => header_params,
789
+ :query_params => query_params,
790
+ :form_params => form_params,
791
+ :body => post_body,
792
+ :auth_names => auth_names,
793
+ :return_type => return_type
794
+ )
795
+
796
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
797
+ if @api_client.config.debugging
798
+ @api_client.config.logger.debug "API called: CustomObjectsApi#delete_object_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
799
+ end
800
+ return data, status_code, headers
801
+ end
802
+
803
+ # alias of `delete_object_schema_relationship_with_http_info`
804
+ alias delete_object_schema_relationships_schemas_with_http_info delete_object_schema_relationship_with_http_info
805
+
806
+ # alias of `delete_object_schema_relationship_with_http_info`
807
+ alias remove_schemas_from_object_schema_with_http_info delete_object_schema_relationship_with_http_info
808
+
809
+ # Delete Object Type
810
+ # Delete the object type with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_object_type.json)
811
+ # @param id [String] The ULID ID of the object type.
812
+ # @param [Hash] opts the optional parameters
813
+ # @return [nil]
814
+ def delete_object_type(id, opts = {})
815
+ delete_object_type_with_http_info(id, opts)
816
+ nil
817
+ end
818
+
819
+ # Delete Object Type
820
+ # Delete the object type 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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_object_type.json)
821
+ # @param id [String] The ULID ID of the object type.
822
+ # @param [Hash] opts the optional parameters
823
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
824
+ def delete_object_type_with_http_info(id, opts = {})
825
+ if @api_client.config.debugging
826
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_object_type ...'
827
+ end
828
+ # verify the required parameter 'id' is set
829
+ if @api_client.config.client_side_validation && id.nil?
830
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_object_type"
831
+ end
832
+ # resource path
833
+ local_var_path = '/api/object-types/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
834
+
835
+ # query parameters
836
+ query_params = opts[:query_params] || {}
837
+
838
+ # header parameters
839
+ header_params = opts[:header_params] || {}
840
+ # klaviyo api revision
841
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
842
+ # HTTP header 'Accept' (if needed)
843
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
844
+
845
+ # form parameters
846
+ form_params = opts[:form_params] || {}
847
+
848
+ # http body (model)
849
+ post_body = opts[:debug_body]
850
+
851
+ # return_type
852
+ return_type = opts[:debug_return_type]
853
+
854
+ # auth_names
855
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
856
+
857
+ new_options = opts.merge(
858
+ :operation => :"CustomObjectsApi.delete_object_type",
859
+ :header_params => header_params,
860
+ :query_params => query_params,
861
+ :form_params => form_params,
862
+ :body => post_body,
863
+ :auth_names => auth_names,
864
+ :return_type => return_type
865
+ )
866
+
867
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
868
+ if @api_client.config.debugging
869
+ @api_client.config.logger.debug "API called: CustomObjectsApi#delete_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
870
+ end
871
+ return data, status_code, headers
872
+ end
873
+
874
+ # Delete Profile Schema Relationship
875
+ # Delete a relationship between an object schema and a profile<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_profile_schema_relationship.json)
876
+ # @param id [String] The ULID ID of the object schema.
877
+ # @param profile_object_schema_relationship_delete_query [ProfileObjectSchemaRelationshipDeleteQuery] Delete a relationship between an object schema and a profile
878
+ # @param [Hash] opts the optional parameters
879
+ # @return [nil]
880
+ def delete_profile_schema_relationship(id, profile_object_schema_relationship_delete_query, opts = {})
881
+ delete_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_delete_query, opts)
882
+ nil
883
+ end
884
+
885
+ # alias of `delete_profile_schema_relationship`
886
+ alias delete_object_schema_relationships_profile_object_schemas delete_profile_schema_relationship
887
+
888
+ # alias of `delete_profile_schema_relationship`
889
+ alias remove_profile_object_schemas_from_object_schema delete_profile_schema_relationship
890
+
891
+ # Delete Profile Schema Relationship
892
+ # Delete a relationship between an object schema and a profile&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_profile_schema_relationship.json)
893
+ # @param id [String] The ULID ID of the object schema.
894
+ # @param profile_object_schema_relationship_delete_query [ProfileObjectSchemaRelationshipDeleteQuery] Delete a relationship between an object schema and a profile
895
+ # @param [Hash] opts the optional parameters
896
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
897
+ def delete_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_delete_query, opts = {})
898
+ if @api_client.config.debugging
899
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_profile_schema_relationship ...'
900
+ end
901
+ # verify the required parameter 'id' is set
902
+ if @api_client.config.client_side_validation && id.nil?
903
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_profile_schema_relationship"
904
+ end
905
+ # verify the required parameter 'profile_object_schema_relationship_delete_query' is set
906
+ if @api_client.config.client_side_validation && profile_object_schema_relationship_delete_query.nil?
907
+ fail ArgumentError, "Missing the required parameter 'profile_object_schema_relationship_delete_query' when calling CustomObjectsApi.delete_profile_schema_relationship"
908
+ end
909
+ # resource path
910
+ local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
911
+
912
+ # query parameters
913
+ query_params = opts[:query_params] || {}
914
+
915
+ # header parameters
916
+ header_params = opts[:header_params] || {}
917
+ # klaviyo api revision
918
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
919
+ # HTTP header 'Accept' (if needed)
920
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
921
+ # HTTP header 'Content-Type'
922
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
923
+ if !content_type.nil?
924
+ header_params['Content-Type'] = content_type
925
+ end
926
+
927
+ # form parameters
928
+ form_params = opts[:form_params] || {}
929
+
930
+ # http body (model)
931
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_object_schema_relationship_delete_query)
932
+
933
+ # return_type
934
+ return_type = opts[:debug_return_type]
935
+
936
+ # auth_names
937
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
938
+
939
+ new_options = opts.merge(
940
+ :operation => :"CustomObjectsApi.delete_profile_schema_relationship",
941
+ :header_params => header_params,
942
+ :query_params => query_params,
943
+ :form_params => form_params,
944
+ :body => post_body,
945
+ :auth_names => auth_names,
946
+ :return_type => return_type
947
+ )
948
+
949
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
950
+ if @api_client.config.debugging
951
+ @api_client.config.logger.debug "API called: CustomObjectsApi#delete_profile_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
952
+ end
953
+ return data, status_code, headers
954
+ end
955
+
956
+ # alias of `delete_profile_schema_relationship_with_http_info`
957
+ alias delete_object_schema_relationships_profile_object_schemas_with_http_info delete_profile_schema_relationship_with_http_info
958
+
959
+ # alias of `delete_profile_schema_relationship_with_http_info`
960
+ alias remove_profile_object_schemas_from_object_schema_with_http_info delete_profile_schema_relationship_with_http_info
961
+
962
+ # Get Current Schema for Object Type
963
+ # Get current schema for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_current_schema_for_object_type.json)
964
+ # @param id [String] The ULID ID of the object type.
965
+ # @param [Hash] opts the optional parameters
966
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
967
+ # @return [Hash<String, Object>]
968
+ def get_current_schema_for_object_type(id, opts = {})
969
+ data, _status_code, _headers = get_current_schema_for_object_type_with_http_info(id, opts)
970
+ data
971
+ end
972
+
973
+ # alias of `get_current_schema_for_object_type`
974
+ alias get_object_type_current_schema get_current_schema_for_object_type
975
+
976
+ # Get Current Schema for Object Type
977
+ # Get current schema for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_current_schema_for_object_type.json)
978
+ # @param id [String] The ULID ID of the object type.
979
+ # @param [Hash] opts the optional parameters
980
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
981
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
982
+ def get_current_schema_for_object_type_with_http_info(id, opts = {})
983
+ if @api_client.config.debugging
984
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_current_schema_for_object_type ...'
985
+ end
986
+ # verify the required parameter 'id' is set
987
+ if @api_client.config.client_side_validation && id.nil?
988
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_current_schema_for_object_type"
989
+ end
990
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
991
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
992
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
993
+ end
994
+ # resource path
995
+ local_var_path = '/api/object-types/{id}/current-schema'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
996
+
997
+ # query parameters
998
+ query_params = opts[:query_params] || {}
999
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
1000
+
1001
+ # header parameters
1002
+ header_params = opts[:header_params] || {}
1003
+ # klaviyo api revision
1004
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1005
+ # HTTP header 'Accept' (if needed)
1006
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1007
+
1008
+ # form parameters
1009
+ form_params = opts[:form_params] || {}
1010
+
1011
+ # http body (model)
1012
+ post_body = opts[:debug_body]
1013
+
1014
+ # return_type
1015
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1016
+
1017
+ # auth_names
1018
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1019
+
1020
+ new_options = opts.merge(
1021
+ :operation => :"CustomObjectsApi.get_current_schema_for_object_type",
1022
+ :header_params => header_params,
1023
+ :query_params => query_params,
1024
+ :form_params => form_params,
1025
+ :body => post_body,
1026
+ :auth_names => auth_names,
1027
+ :return_type => return_type
1028
+ )
1029
+
1030
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1031
+ if @api_client.config.debugging
1032
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_current_schema_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1033
+ end
1034
+ return data, status_code, headers
1035
+ end
1036
+
1037
+ # alias of `get_current_schema_for_object_type_with_http_info`
1038
+ alias get_object_type_current_schema_with_http_info get_current_schema_for_object_type_with_http_info
1039
+
1040
+ # Get Current Schema ID for Object Type
1041
+ # Get current schema for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_current_schema_id_for_object_type.json)
1042
+ # @param id [String] The ULID ID of the object type.
1043
+ # @param [Hash] opts the optional parameters
1044
+ # @return [Hash<String, Object>]
1045
+ def get_current_schema_id_for_object_type(id, opts = {})
1046
+ data, _status_code, _headers = get_current_schema_id_for_object_type_with_http_info(id, opts)
1047
+ data
1048
+ end
1049
+
1050
+ # alias of `get_current_schema_id_for_object_type`
1051
+ alias get_object_type_relationships_current_schema get_current_schema_id_for_object_type
1052
+
1053
+ # Get Current Schema ID for Object Type
1054
+ # Get current schema for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_current_schema_id_for_object_type.json)
1055
+ # @param id [String] The ULID ID of the object type.
1056
+ # @param [Hash] opts the optional parameters
1057
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1058
+ def get_current_schema_id_for_object_type_with_http_info(id, opts = {})
1059
+ if @api_client.config.debugging
1060
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_current_schema_id_for_object_type ...'
1061
+ end
1062
+ # verify the required parameter 'id' is set
1063
+ if @api_client.config.client_side_validation && id.nil?
1064
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_current_schema_id_for_object_type"
1065
+ end
1066
+ # resource path
1067
+ local_var_path = '/api/object-types/{id}/relationships/current-schema'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1068
+
1069
+ # query parameters
1070
+ query_params = opts[:query_params] || {}
1071
+
1072
+ # header parameters
1073
+ header_params = opts[:header_params] || {}
1074
+ # klaviyo api revision
1075
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1076
+ # HTTP header 'Accept' (if needed)
1077
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1078
+
1079
+ # form parameters
1080
+ form_params = opts[:form_params] || {}
1081
+
1082
+ # http body (model)
1083
+ post_body = opts[:debug_body]
1084
+
1085
+ # return_type
1086
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1087
+
1088
+ # auth_names
1089
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1090
+
1091
+ new_options = opts.merge(
1092
+ :operation => :"CustomObjectsApi.get_current_schema_id_for_object_type",
1093
+ :header_params => header_params,
1094
+ :query_params => query_params,
1095
+ :form_params => form_params,
1096
+ :body => post_body,
1097
+ :auth_names => auth_names,
1098
+ :return_type => return_type
1099
+ )
1100
+
1101
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1102
+ if @api_client.config.debugging
1103
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_current_schema_id_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1104
+ end
1105
+ return data, status_code, headers
1106
+ end
1107
+
1108
+ # alias of `get_current_schema_id_for_object_type_with_http_info`
1109
+ alias get_object_type_relationships_current_schema_with_http_info get_current_schema_id_for_object_type_with_http_info
1110
+
1111
+ # Get Data Source
1112
+ # Retrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_source.json)
1113
+ # @param id [String] The ID of the data source
1114
+ # @param [Hash] opts the optional parameters
1115
+ # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1116
+ # @return [Hash<String, Object>]
1117
+ def get_data_source(id, opts = {})
1118
+ data, _status_code, _headers = get_data_source_with_http_info(id, opts)
1119
+ data
1120
+ end
1121
+
1122
+ # Get Data Source
1123
+ # Retrieve a data source in an 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_source.json)
1124
+ # @param id [String] The ID of the data source
1125
+ # @param [Hash] opts the optional parameters
1126
+ # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1127
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1128
+ def get_data_source_with_http_info(id, opts = {})
1129
+ if @api_client.config.debugging
1130
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_source ...'
1131
+ end
1132
+ # verify the required parameter 'id' is set
1133
+ if @api_client.config.client_side_validation && id.nil?
1134
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_data_source"
1135
+ end
1136
+ allowable_values = ["description", "id", "namespace", "title", "visibility"]
1137
+ if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
1138
+ fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
1139
+ end
1140
+ # resource path
1141
+ local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1142
+
1143
+ # query parameters
1144
+ query_params = opts[:query_params] || {}
1145
+ query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
1146
+
1147
+ # header parameters
1148
+ header_params = opts[:header_params] || {}
1149
+ # klaviyo api revision
1150
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1151
+ # HTTP header 'Accept' (if needed)
1152
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1153
+
1154
+ # form parameters
1155
+ form_params = opts[:form_params] || {}
1156
+
1157
+ # http body (model)
1158
+ post_body = opts[:debug_body]
1159
+
1160
+ # return_type
1161
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1162
+
1163
+ # auth_names
1164
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1165
+
1166
+ new_options = opts.merge(
1167
+ :operation => :"CustomObjectsApi.get_data_source",
1168
+ :header_params => header_params,
1169
+ :query_params => query_params,
1170
+ :form_params => form_params,
1171
+ :body => post_body,
1172
+ :auth_names => auth_names,
1173
+ :return_type => return_type
1174
+ )
1175
+
1176
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1177
+ if @api_client.config.debugging
1178
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1179
+ end
1180
+ return data, status_code, headers
1181
+ end
1182
+
1183
+ # Get Data Sources
1184
+ # Get all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_sources.json)
1185
+ # @param [Hash] opts the optional parameters
1186
+ # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1187
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;namespace&#x60;: &#x60;equals&#x60; (string)
1188
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1189
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1190
+ # @return [Hash<String, Object>]
1191
+ def get_data_sources(opts = {})
1192
+ data, _status_code, _headers = get_data_sources_with_http_info(opts)
1193
+ data
1194
+ end
1195
+
1196
+ # Get Data Sources
1197
+ # Get all data sources in an 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_sources.json)
1198
+ # @param [Hash] opts the optional parameters
1199
+ # @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1200
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;namespace&#x60;: &#x60;equals&#x60; (string)
1201
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1202
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1203
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1204
+ def get_data_sources_with_http_info(opts = {})
1205
+ if @api_client.config.debugging
1206
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_sources ...'
1207
+ end
1208
+ allowable_values = ["description", "id", "namespace", "title", "visibility"]
1209
+ if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
1210
+ fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
1211
+ end
1212
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
1213
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be smaller than or equal to 100.'
1214
+ end
1215
+
1216
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1217
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be greater than or equal to 1.'
1218
+ end
1219
+
1220
+ # resource path
1221
+ local_var_path = '/api/data-sources'
1222
+
1223
+ # query parameters
1224
+ query_params = opts[:query_params] || {}
1225
+ query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
1226
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1227
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1228
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
1229
+
1230
+ # header parameters
1231
+ header_params = opts[:header_params] || {}
1232
+ # klaviyo api revision
1233
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1234
+ # HTTP header 'Accept' (if needed)
1235
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1236
+
1237
+ # form parameters
1238
+ form_params = opts[:form_params] || {}
1239
+
1240
+ # http body (model)
1241
+ post_body = opts[:debug_body]
1242
+
1243
+ # return_type
1244
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1245
+
1246
+ # auth_names
1247
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1248
+
1249
+ new_options = opts.merge(
1250
+ :operation => :"CustomObjectsApi.get_data_sources",
1251
+ :header_params => header_params,
1252
+ :query_params => query_params,
1253
+ :form_params => form_params,
1254
+ :body => post_body,
1255
+ :auth_names => auth_names,
1256
+ :return_type => return_type
1257
+ )
1258
+
1259
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1260
+ if @api_client.config.debugging
1261
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_data_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1262
+ end
1263
+ return data, status_code, headers
1264
+ end
1265
+
1266
+ # Get Draft Schema for Object Type
1267
+ # Get draft schema for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_draft_schema_for_object_type.json)
1268
+ # @param id [String] The ULID ID of the object type.
1269
+ # @param [Hash] opts the optional parameters
1270
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1271
+ # @return [Hash<String, Object>]
1272
+ def get_draft_schema_for_object_type(id, opts = {})
1273
+ data, _status_code, _headers = get_draft_schema_for_object_type_with_http_info(id, opts)
1274
+ data
1275
+ end
1276
+
1277
+ # alias of `get_draft_schema_for_object_type`
1278
+ alias get_object_type_draft_schema get_draft_schema_for_object_type
1279
+
1280
+ # Get Draft Schema for Object Type
1281
+ # Get draft schema for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_draft_schema_for_object_type.json)
1282
+ # @param id [String] The ULID ID of the object type.
1283
+ # @param [Hash] opts the optional parameters
1284
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1285
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1286
+ def get_draft_schema_for_object_type_with_http_info(id, opts = {})
1287
+ if @api_client.config.debugging
1288
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_draft_schema_for_object_type ...'
1289
+ end
1290
+ # verify the required parameter 'id' is set
1291
+ if @api_client.config.client_side_validation && id.nil?
1292
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_draft_schema_for_object_type"
1293
+ end
1294
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
1295
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
1296
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
1297
+ end
1298
+ # resource path
1299
+ local_var_path = '/api/object-types/{id}/draft-schema'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1300
+
1301
+ # query parameters
1302
+ query_params = opts[:query_params] || {}
1303
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
1304
+
1305
+ # header parameters
1306
+ header_params = opts[:header_params] || {}
1307
+ # klaviyo api revision
1308
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1309
+ # HTTP header 'Accept' (if needed)
1310
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1311
+
1312
+ # form parameters
1313
+ form_params = opts[:form_params] || {}
1314
+
1315
+ # http body (model)
1316
+ post_body = opts[:debug_body]
1317
+
1318
+ # return_type
1319
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1320
+
1321
+ # auth_names
1322
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1323
+
1324
+ new_options = opts.merge(
1325
+ :operation => :"CustomObjectsApi.get_draft_schema_for_object_type",
1326
+ :header_params => header_params,
1327
+ :query_params => query_params,
1328
+ :form_params => form_params,
1329
+ :body => post_body,
1330
+ :auth_names => auth_names,
1331
+ :return_type => return_type
1332
+ )
1333
+
1334
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1335
+ if @api_client.config.debugging
1336
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_draft_schema_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1337
+ end
1338
+ return data, status_code, headers
1339
+ end
1340
+
1341
+ # alias of `get_draft_schema_for_object_type_with_http_info`
1342
+ alias get_object_type_draft_schema_with_http_info get_draft_schema_for_object_type_with_http_info
1343
+
1344
+ # Get Draft Schema ID for Object Type
1345
+ # Get draft schema for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_draft_schema_id_for_object_type.json)
1346
+ # @param id [String] The ULID ID of the object type.
1347
+ # @param [Hash] opts the optional parameters
1348
+ # @return [Hash<String, Object>]
1349
+ def get_draft_schema_id_for_object_type(id, opts = {})
1350
+ data, _status_code, _headers = get_draft_schema_id_for_object_type_with_http_info(id, opts)
1351
+ data
1352
+ end
1353
+
1354
+ # alias of `get_draft_schema_id_for_object_type`
1355
+ alias get_object_type_relationships_draft_schema get_draft_schema_id_for_object_type
1356
+
1357
+ # Get Draft Schema ID for Object Type
1358
+ # Get draft schema for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_draft_schema_id_for_object_type.json)
1359
+ # @param id [String] The ULID ID of the object type.
1360
+ # @param [Hash] opts the optional parameters
1361
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1362
+ def get_draft_schema_id_for_object_type_with_http_info(id, opts = {})
1363
+ if @api_client.config.debugging
1364
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_draft_schema_id_for_object_type ...'
1365
+ end
1366
+ # verify the required parameter 'id' is set
1367
+ if @api_client.config.client_side_validation && id.nil?
1368
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_draft_schema_id_for_object_type"
1369
+ end
1370
+ # resource path
1371
+ local_var_path = '/api/object-types/{id}/relationships/draft-schema'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1372
+
1373
+ # query parameters
1374
+ query_params = opts[:query_params] || {}
1375
+
1376
+ # header parameters
1377
+ header_params = opts[:header_params] || {}
1378
+ # klaviyo api revision
1379
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1380
+ # HTTP header 'Accept' (if needed)
1381
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1382
+
1383
+ # form parameters
1384
+ form_params = opts[:form_params] || {}
1385
+
1386
+ # http body (model)
1387
+ post_body = opts[:debug_body]
1388
+
1389
+ # return_type
1390
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1391
+
1392
+ # auth_names
1393
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1394
+
1395
+ new_options = opts.merge(
1396
+ :operation => :"CustomObjectsApi.get_draft_schema_id_for_object_type",
1397
+ :header_params => header_params,
1398
+ :query_params => query_params,
1399
+ :form_params => form_params,
1400
+ :body => post_body,
1401
+ :auth_names => auth_names,
1402
+ :return_type => return_type
1403
+ )
1404
+
1405
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1406
+ if @api_client.config.debugging
1407
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_draft_schema_id_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1408
+ end
1409
+ return data, status_code, headers
1410
+ end
1411
+
1412
+ # alias of `get_draft_schema_id_for_object_type_with_http_info`
1413
+ alias get_object_type_relationships_draft_schema_with_http_info get_draft_schema_id_for_object_type_with_http_info
1414
+
1415
+ # Get Ingestion Log IDs for Object Type
1416
+ # Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ingestion_log_ids_for_object_type.json)
1417
+ # @param id [String] The ULID ID of the object type.
1418
+ # @param [Hash] opts the optional parameters
1419
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;record_id&#x60;: &#x60;equals&#x60; (string)&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;error&#39;&#x60;, &#x60;&#39;warning&#39;&#x60;, &#x60;&#39;info&#39;&#x60;)&lt;br&gt;&#x60;event_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;validation_error&#39;&#x60;)&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60; (date-time)
1420
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1421
+ # @return [Hash<String, Object>]
1422
+ def get_ingestion_log_ids_for_object_type(id, opts = {})
1423
+ data, _status_code, _headers = get_ingestion_log_ids_for_object_type_with_http_info(id, opts)
1424
+ data
1425
+ end
1426
+
1427
+ # alias of `get_ingestion_log_ids_for_object_type`
1428
+ alias get_object_type_relationships_ingestion_logs get_ingestion_log_ids_for_object_type
1429
+
1430
+ # Get Ingestion Log IDs for Object Type
1431
+ # Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ingestion_log_ids_for_object_type.json)
1432
+ # @param id [String] The ULID ID of the object type.
1433
+ # @param [Hash] opts the optional parameters
1434
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;record_id&#x60;: &#x60;equals&#x60; (string)&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;error&#39;&#x60;, &#x60;&#39;warning&#39;&#x60;, &#x60;&#39;info&#39;&#x60;)&lt;br&gt;&#x60;event_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;validation_error&#39;&#x60;)&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60; (date-time)
1435
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1436
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1437
+ def get_ingestion_log_ids_for_object_type_with_http_info(id, opts = {})
1438
+ if @api_client.config.debugging
1439
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_ingestion_log_ids_for_object_type ...'
1440
+ end
1441
+ # verify the required parameter 'id' is set
1442
+ if @api_client.config.client_side_validation && id.nil?
1443
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_ingestion_log_ids_for_object_type"
1444
+ end
1445
+ # resource path
1446
+ local_var_path = '/api/object-types/{id}/relationships/object-ingestion-logs'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1447
+
1448
+ # query parameters
1449
+ query_params = opts[:query_params] || {}
1450
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1451
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1452
+
1453
+ # header parameters
1454
+ header_params = opts[:header_params] || {}
1455
+ # klaviyo api revision
1456
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1457
+ # HTTP header 'Accept' (if needed)
1458
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1459
+
1460
+ # form parameters
1461
+ form_params = opts[:form_params] || {}
1462
+
1463
+ # http body (model)
1464
+ post_body = opts[:debug_body]
1465
+
1466
+ # return_type
1467
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1468
+
1469
+ # auth_names
1470
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1471
+
1472
+ new_options = opts.merge(
1473
+ :operation => :"CustomObjectsApi.get_ingestion_log_ids_for_object_type",
1474
+ :header_params => header_params,
1475
+ :query_params => query_params,
1476
+ :form_params => form_params,
1477
+ :body => post_body,
1478
+ :auth_names => auth_names,
1479
+ :return_type => return_type
1480
+ )
1481
+
1482
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1483
+ if @api_client.config.debugging
1484
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_ingestion_log_ids_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1485
+ end
1486
+ return data, status_code, headers
1487
+ end
1488
+
1489
+ # alias of `get_ingestion_log_ids_for_object_type_with_http_info`
1490
+ alias get_object_type_relationships_ingestion_logs_with_http_info get_ingestion_log_ids_for_object_type_with_http_info
1491
+
1492
+ # Get Ingestion Logs for Object Type
1493
+ # Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ingestion_logs_for_object_type.json)
1494
+ # @param id [String] The ULID ID of the object type.
1495
+ # @param [Hash] opts the optional parameters
1496
+ # @option opts [Array<String>] :fields_object_ingestion_log For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1497
+ # @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1498
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1499
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;record_id&#x60;: &#x60;equals&#x60; (string)&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;error&#39;&#x60;, &#x60;&#39;warning&#39;&#x60;, &#x60;&#39;info&#39;&#x60;)&lt;br&gt;&#x60;event_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;validation_error&#39;&#x60;)&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60; (date-time)
1500
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1501
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1502
+ # @return [Hash<String, Object>]
1503
+ def get_ingestion_logs_for_object_type(id, opts = {})
1504
+ data, _status_code, _headers = get_ingestion_logs_for_object_type_with_http_info(id, opts)
1505
+ data
1506
+ end
1507
+
1508
+ # alias of `get_ingestion_logs_for_object_type`
1509
+ alias get_object_type_ingestion_logs get_ingestion_logs_for_object_type
1510
+
1511
+ # Get Ingestion Logs for Object Type
1512
+ # Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ingestion_logs_for_object_type.json)
1513
+ # @param id [String] The ULID ID of the object type.
1514
+ # @param [Hash] opts the optional parameters
1515
+ # @option opts [Array<String>] :fields_object_ingestion_log For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1516
+ # @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1517
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1518
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;record_id&#x60;: &#x60;equals&#x60; (string)&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;error&#39;&#x60;, &#x60;&#39;warning&#39;&#x60;, &#x60;&#39;info&#39;&#x60;)&lt;br&gt;&#x60;event_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; (allowed values: &#x60;&#39;validation_error&#39;&#x60;)&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60; (date-time)
1519
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1520
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1521
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1522
+ def get_ingestion_logs_for_object_type_with_http_info(id, opts = {})
1523
+ if @api_client.config.debugging
1524
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_ingestion_logs_for_object_type ...'
1525
+ end
1526
+ # verify the required parameter 'id' is set
1527
+ if @api_client.config.client_side_validation && id.nil?
1528
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_ingestion_logs_for_object_type"
1529
+ end
1530
+ allowable_values = ["errors", "event_type", "id", "status", "summary", "timestamp"]
1531
+ if @api_client.config.client_side_validation && opts[:'fields_object_ingestion_log'] && !opts[:'fields_object_ingestion_log'].all? { |item| allowable_values.include?(item) }
1532
+ fail ArgumentError, "invalid value for \"fields_object_ingestion_log\", must include one of #{allowable_values}"
1533
+ end
1534
+ allowable_values = ["id", "record_properties"]
1535
+ if @api_client.config.client_side_validation && opts[:'fields_object_record'] && !opts[:'fields_object_record'].all? { |item| allowable_values.include?(item) }
1536
+ fail ArgumentError, "invalid value for \"fields_object_record\", must include one of #{allowable_values}"
1537
+ end
1538
+ allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
1539
+ if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
1540
+ fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
1541
+ end
1542
+ allowable_values = ["object-record", "object-type"]
1543
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1544
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1545
+ end
1546
+ # resource path
1547
+ local_var_path = '/api/object-types/{id}/object-ingestion-logs'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1548
+
1549
+ # query parameters
1550
+ query_params = opts[:query_params] || {}
1551
+ query_params[:'fields[object-ingestion-log]'] = @api_client.build_collection_param(opts[:'fields_object_ingestion_log'], :csv) if !opts[:'fields_object_ingestion_log'].nil?
1552
+ query_params[:'fields[object-record]'] = @api_client.build_collection_param(opts[:'fields_object_record'], :csv) if !opts[:'fields_object_record'].nil?
1553
+ query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
1554
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1555
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1556
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1557
+
1558
+ # header parameters
1559
+ header_params = opts[:header_params] || {}
1560
+ # klaviyo api revision
1561
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1562
+ # HTTP header 'Accept' (if needed)
1563
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1564
+
1565
+ # form parameters
1566
+ form_params = opts[:form_params] || {}
1567
+
1568
+ # http body (model)
1569
+ post_body = opts[:debug_body]
1570
+
1571
+ # return_type
1572
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1573
+
1574
+ # auth_names
1575
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1576
+
1577
+ new_options = opts.merge(
1578
+ :operation => :"CustomObjectsApi.get_ingestion_logs_for_object_type",
1579
+ :header_params => header_params,
1580
+ :query_params => query_params,
1581
+ :form_params => form_params,
1582
+ :body => post_body,
1583
+ :auth_names => auth_names,
1584
+ :return_type => return_type
1585
+ )
1586
+
1587
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1588
+ if @api_client.config.debugging
1589
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_ingestion_logs_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1590
+ end
1591
+ return data, status_code, headers
1592
+ end
1593
+
1594
+ # alias of `get_ingestion_logs_for_object_type_with_http_info`
1595
+ alias get_object_type_ingestion_logs_with_http_info get_ingestion_logs_for_object_type_with_http_info
1596
+
1597
+ # Get Object Record
1598
+ # Get the object record with the given compound ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_record.json)
1599
+ # @param id [String] The compound ID of the object record, formatted as object_type_id:::object_record_id
1600
+ # @param [Hash] opts the optional parameters
1601
+ # @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1602
+ # @return [Hash<String, Object>]
1603
+ def get_object_record(id, opts = {})
1604
+ data, _status_code, _headers = get_object_record_with_http_info(id, opts)
1605
+ data
1606
+ end
1607
+
1608
+ # Get Object Record
1609
+ # Get the object record with the given compound 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_record.json)
1610
+ # @param id [String] The compound ID of the object record, formatted as object_type_id:::object_record_id
1611
+ # @param [Hash] opts the optional parameters
1612
+ # @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1613
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1614
+ def get_object_record_with_http_info(id, opts = {})
1615
+ if @api_client.config.debugging
1616
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_record ...'
1617
+ end
1618
+ # verify the required parameter 'id' is set
1619
+ if @api_client.config.client_side_validation && id.nil?
1620
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_record"
1621
+ end
1622
+ allowable_values = ["id", "record_properties"]
1623
+ if @api_client.config.client_side_validation && opts[:'fields_object_record'] && !opts[:'fields_object_record'].all? { |item| allowable_values.include?(item) }
1624
+ fail ArgumentError, "invalid value for \"fields_object_record\", must include one of #{allowable_values}"
1625
+ end
1626
+ # resource path
1627
+ local_var_path = '/api/object-records/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1628
+
1629
+ # query parameters
1630
+ query_params = opts[:query_params] || {}
1631
+ query_params[:'fields[object-record]'] = @api_client.build_collection_param(opts[:'fields_object_record'], :csv) if !opts[:'fields_object_record'].nil?
1632
+
1633
+ # header parameters
1634
+ header_params = opts[:header_params] || {}
1635
+ # klaviyo api revision
1636
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1637
+ # HTTP header 'Accept' (if needed)
1638
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1639
+
1640
+ # form parameters
1641
+ form_params = opts[:form_params] || {}
1642
+
1643
+ # http body (model)
1644
+ post_body = opts[:debug_body]
1645
+
1646
+ # return_type
1647
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1648
+
1649
+ # auth_names
1650
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1651
+
1652
+ new_options = opts.merge(
1653
+ :operation => :"CustomObjectsApi.get_object_record",
1654
+ :header_params => header_params,
1655
+ :query_params => query_params,
1656
+ :form_params => form_params,
1657
+ :body => post_body,
1658
+ :auth_names => auth_names,
1659
+ :return_type => return_type
1660
+ )
1661
+
1662
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1663
+ if @api_client.config.debugging
1664
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1665
+ end
1666
+ return data, status_code, headers
1667
+ end
1668
+
1669
+ # Get Object Schema
1670
+ # Get the object schema with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_schema.json)
1671
+ # @param id [String] The ULID ID of the object schema.
1672
+ # @param [Hash] opts the optional parameters
1673
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1674
+ # @option opts [Array<String>] :fields_profile_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1675
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1676
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1677
+ # @return [Hash<String, Object>]
1678
+ def get_object_schema(id, opts = {})
1679
+ data, _status_code, _headers = get_object_schema_with_http_info(id, opts)
1680
+ data
1681
+ end
1682
+
1683
+ # Get Object Schema
1684
+ # Get the object schema 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_schema.json)
1685
+ # @param id [String] The ULID ID of the object schema.
1686
+ # @param [Hash] opts the optional parameters
1687
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1688
+ # @option opts [Array<String>] :fields_profile_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1689
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1690
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1691
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1692
+ def get_object_schema_with_http_info(id, opts = {})
1693
+ if @api_client.config.debugging
1694
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_schema ...'
1695
+ end
1696
+ # verify the required parameter 'id' is set
1697
+ if @api_client.config.client_side_validation && id.nil?
1698
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_schema"
1699
+ end
1700
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
1701
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
1702
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
1703
+ end
1704
+ allowable_values = ["id"]
1705
+ if @api_client.config.client_side_validation && opts[:'fields_profile_object_schema'] && !opts[:'fields_profile_object_schema'].all? { |item| allowable_values.include?(item) }
1706
+ fail ArgumentError, "invalid value for \"fields_profile_object_schema\", must include one of #{allowable_values}"
1707
+ end
1708
+ allowable_values = ["id", "property_mappings", "relationship_mappings"]
1709
+ if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
1710
+ fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
1711
+ end
1712
+ allowable_values = ["object-schemas", "profile-object-schemas", "source-mapping"]
1713
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1714
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1715
+ end
1716
+ # resource path
1717
+ local_var_path = '/api/object-schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1718
+
1719
+ # query parameters
1720
+ query_params = opts[:query_params] || {}
1721
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
1722
+ query_params[:'fields[profile-object-schema]'] = @api_client.build_collection_param(opts[:'fields_profile_object_schema'], :csv) if !opts[:'fields_profile_object_schema'].nil?
1723
+ query_params[:'fields[source-mapping]'] = @api_client.build_collection_param(opts[:'fields_source_mapping'], :csv) if !opts[:'fields_source_mapping'].nil?
1724
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].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
+
1733
+ # form parameters
1734
+ form_params = opts[:form_params] || {}
1735
+
1736
+ # http body (model)
1737
+ post_body = opts[:debug_body]
1738
+
1739
+ # return_type
1740
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1741
+
1742
+ # auth_names
1743
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1744
+
1745
+ new_options = opts.merge(
1746
+ :operation => :"CustomObjectsApi.get_object_schema",
1747
+ :header_params => header_params,
1748
+ :query_params => query_params,
1749
+ :form_params => form_params,
1750
+ :body => post_body,
1751
+ :auth_names => auth_names,
1752
+ :return_type => return_type
1753
+ )
1754
+
1755
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1756
+ if @api_client.config.debugging
1757
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1758
+ end
1759
+ return data, status_code, headers
1760
+ end
1761
+
1762
+ # Get Object Schema Relationships
1763
+ # Get related object schemas for an object schema<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_schema_relationships.json)
1764
+ # @param id [String] The ULID ID of the object schema.
1765
+ # @param [Hash] opts the optional parameters
1766
+ # @return [Hash<String, Object>]
1767
+ def get_object_schema_relationships(id, opts = {})
1768
+ data, _status_code, _headers = get_object_schema_relationships_with_http_info(id, opts)
1769
+ data
1770
+ end
1771
+
1772
+ # alias of `get_object_schema_relationships`
1773
+ alias get_object_schema_relationships_schemas get_object_schema_relationships
1774
+
1775
+ # alias of `get_object_schema_relationships`
1776
+ alias get_schema_ids_for_object_schema get_object_schema_relationships
1777
+
1778
+ # Get Object Schema Relationships
1779
+ # Get related object schemas for an object schema&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_schema_relationships.json)
1780
+ # @param id [String] The ULID ID of the object schema.
1781
+ # @param [Hash] opts the optional parameters
1782
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1783
+ def get_object_schema_relationships_with_http_info(id, opts = {})
1784
+ if @api_client.config.debugging
1785
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_schema_relationships ...'
1786
+ end
1787
+ # verify the required parameter 'id' is set
1788
+ if @api_client.config.client_side_validation && id.nil?
1789
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_schema_relationships"
1790
+ end
1791
+ # resource path
1792
+ local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1793
+
1794
+ # query parameters
1795
+ query_params = opts[:query_params] || {}
1796
+
1797
+ # header parameters
1798
+ header_params = opts[:header_params] || {}
1799
+ # klaviyo api revision
1800
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1801
+ # HTTP header 'Accept' (if needed)
1802
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1803
+
1804
+ # form parameters
1805
+ form_params = opts[:form_params] || {}
1806
+
1807
+ # http body (model)
1808
+ post_body = opts[:debug_body]
1809
+
1810
+ # return_type
1811
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1812
+
1813
+ # auth_names
1814
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1815
+
1816
+ new_options = opts.merge(
1817
+ :operation => :"CustomObjectsApi.get_object_schema_relationships",
1818
+ :header_params => header_params,
1819
+ :query_params => query_params,
1820
+ :form_params => form_params,
1821
+ :body => post_body,
1822
+ :auth_names => auth_names,
1823
+ :return_type => return_type
1824
+ )
1825
+
1826
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1827
+ if @api_client.config.debugging
1828
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_schema_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1829
+ end
1830
+ return data, status_code, headers
1831
+ end
1832
+
1833
+ # alias of `get_object_schema_relationships_with_http_info`
1834
+ alias get_object_schema_relationships_schemas_with_http_info get_object_schema_relationships_with_http_info
1835
+
1836
+ # alias of `get_object_schema_relationships_with_http_info`
1837
+ alias get_schema_ids_for_object_schema_with_http_info get_object_schema_relationships_with_http_info
1838
+
1839
+ # Get Object Type
1840
+ # Get the object type with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_type.json)
1841
+ # @param id [String] The ULID ID of the object type.
1842
+ # @param [Hash] opts the optional parameters
1843
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1844
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1845
+ # @option opts [Array<String>] :fields_profile_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1846
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1847
+ # @return [Hash<String, Object>]
1848
+ def get_object_type(id, opts = {})
1849
+ data, _status_code, _headers = get_object_type_with_http_info(id, opts)
1850
+ data
1851
+ end
1852
+
1853
+ # Get Object Type
1854
+ # Get the object type 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_type.json)
1855
+ # @param id [String] The ULID ID of the object type.
1856
+ # @param [Hash] opts the optional parameters
1857
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1858
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1859
+ # @option opts [Array<String>] :fields_profile_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1860
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1861
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1862
+ def get_object_type_with_http_info(id, opts = {})
1863
+ if @api_client.config.debugging
1864
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_type ...'
1865
+ end
1866
+ # verify the required parameter 'id' is set
1867
+ if @api_client.config.client_side_validation && id.nil?
1868
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_type"
1869
+ end
1870
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
1871
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
1872
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
1873
+ end
1874
+ allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
1875
+ if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
1876
+ fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
1877
+ end
1878
+ allowable_values = ["id"]
1879
+ if @api_client.config.client_side_validation && opts[:'fields_profile_object_type'] && !opts[:'fields_profile_object_type'].all? { |item| allowable_values.include?(item) }
1880
+ fail ArgumentError, "invalid value for \"fields_profile_object_type\", must include one of #{allowable_values}"
1881
+ end
1882
+ allowable_values = ["current-schema", "draft-schema", "object-types", "profile-object-types", "schema-versions"]
1883
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1884
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1885
+ end
1886
+ # resource path
1887
+ local_var_path = '/api/object-types/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1888
+
1889
+ # query parameters
1890
+ query_params = opts[:query_params] || {}
1891
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
1892
+ query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
1893
+ query_params[:'fields[profile-object-type]'] = @api_client.build_collection_param(opts[:'fields_profile_object_type'], :csv) if !opts[:'fields_profile_object_type'].nil?
1894
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1895
+
1896
+ # header parameters
1897
+ header_params = opts[:header_params] || {}
1898
+ # klaviyo api revision
1899
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1900
+ # HTTP header 'Accept' (if needed)
1901
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1902
+
1903
+ # form parameters
1904
+ form_params = opts[:form_params] || {}
1905
+
1906
+ # http body (model)
1907
+ post_body = opts[:debug_body]
1908
+
1909
+ # return_type
1910
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1911
+
1912
+ # auth_names
1913
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1914
+
1915
+ new_options = opts.merge(
1916
+ :operation => :"CustomObjectsApi.get_object_type",
1917
+ :header_params => header_params,
1918
+ :query_params => query_params,
1919
+ :form_params => form_params,
1920
+ :body => post_body,
1921
+ :auth_names => auth_names,
1922
+ :return_type => return_type
1923
+ )
1924
+
1925
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1926
+ if @api_client.config.debugging
1927
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1928
+ end
1929
+ return data, status_code, headers
1930
+ end
1931
+
1932
+ # Get Object Type Relationships
1933
+ # Get related object types for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_type_relationships.json)
1934
+ # @param id [String] The ULID ID of the object type.
1935
+ # @param [Hash] opts the optional parameters
1936
+ # @return [Hash<String, Object>]
1937
+ def get_object_type_relationships(id, opts = {})
1938
+ data, _status_code, _headers = get_object_type_relationships_with_http_info(id, opts)
1939
+ data
1940
+ end
1941
+
1942
+ # alias of `get_object_type_relationships`
1943
+ alias get_object_type_relationships_types get_object_type_relationships
1944
+
1945
+ # alias of `get_object_type_relationships`
1946
+ alias get_type_ids_for_object_type get_object_type_relationships
1947
+
1948
+ # Get Object Type Relationships
1949
+ # Get related object types for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_type_relationships.json)
1950
+ # @param id [String] The ULID ID of the object type.
1951
+ # @param [Hash] opts the optional parameters
1952
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1953
+ def get_object_type_relationships_with_http_info(id, opts = {})
1954
+ if @api_client.config.debugging
1955
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_type_relationships ...'
1956
+ end
1957
+ # verify the required parameter 'id' is set
1958
+ if @api_client.config.client_side_validation && id.nil?
1959
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_type_relationships"
1960
+ end
1961
+ # resource path
1962
+ local_var_path = '/api/object-types/{id}/relationships/object-types'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1963
+
1964
+ # query parameters
1965
+ query_params = opts[:query_params] || {}
1966
+
1967
+ # header parameters
1968
+ header_params = opts[:header_params] || {}
1969
+ # klaviyo api revision
1970
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1971
+ # HTTP header 'Accept' (if needed)
1972
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1973
+
1974
+ # form parameters
1975
+ form_params = opts[:form_params] || {}
1976
+
1977
+ # http body (model)
1978
+ post_body = opts[:debug_body]
1979
+
1980
+ # return_type
1981
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1982
+
1983
+ # auth_names
1984
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1985
+
1986
+ new_options = opts.merge(
1987
+ :operation => :"CustomObjectsApi.get_object_type_relationships",
1988
+ :header_params => header_params,
1989
+ :query_params => query_params,
1990
+ :form_params => form_params,
1991
+ :body => post_body,
1992
+ :auth_names => auth_names,
1993
+ :return_type => return_type
1994
+ )
1995
+
1996
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1997
+ if @api_client.config.debugging
1998
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_type_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1999
+ end
2000
+ return data, status_code, headers
2001
+ end
2002
+
2003
+ # alias of `get_object_type_relationships_with_http_info`
2004
+ alias get_object_type_relationships_types_with_http_info get_object_type_relationships_with_http_info
2005
+
2006
+ # alias of `get_object_type_relationships_with_http_info`
2007
+ alias get_type_ids_for_object_type_with_http_info get_object_type_relationships_with_http_info
2008
+
2009
+ # Get Object Types
2010
+ # Get all object types in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_types.json)
2011
+ # @param [Hash] opts the optional parameters
2012
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2013
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2014
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;namespace&#x60;: &#x60;equals&#x60; (string)
2015
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
2016
+ # @return [Hash<String, Object>]
2017
+ def get_object_types(opts = {})
2018
+ data, _status_code, _headers = get_object_types_with_http_info(opts)
2019
+ data
2020
+ end
2021
+
2022
+ # Get Object Types
2023
+ # Get all object types in an 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_object_types.json)
2024
+ # @param [Hash] opts the optional parameters
2025
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2026
+ # @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2027
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;namespace&#x60;: &#x60;equals&#x60; (string)
2028
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
2029
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2030
+ def get_object_types_with_http_info(opts = {})
2031
+ if @api_client.config.debugging
2032
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_types ...'
2033
+ end
2034
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
2035
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
2036
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
2037
+ end
2038
+ allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
2039
+ if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
2040
+ fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
2041
+ end
2042
+ allowable_values = ["current-schema", "draft-schema"]
2043
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
2044
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
2045
+ end
2046
+ # resource path
2047
+ local_var_path = '/api/object-types'
2048
+
2049
+ # query parameters
2050
+ query_params = opts[:query_params] || {}
2051
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
2052
+ query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
2053
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
2054
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
2055
+
2056
+ # header parameters
2057
+ header_params = opts[:header_params] || {}
2058
+ # klaviyo api revision
2059
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2060
+ # HTTP header 'Accept' (if needed)
2061
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2062
+
2063
+ # form parameters
2064
+ form_params = opts[:form_params] || {}
2065
+
2066
+ # http body (model)
2067
+ post_body = opts[:debug_body]
2068
+
2069
+ # return_type
2070
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2071
+
2072
+ # auth_names
2073
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2074
+
2075
+ new_options = opts.merge(
2076
+ :operation => :"CustomObjectsApi.get_object_types",
2077
+ :header_params => header_params,
2078
+ :query_params => query_params,
2079
+ :form_params => form_params,
2080
+ :body => post_body,
2081
+ :auth_names => auth_names,
2082
+ :return_type => return_type
2083
+ )
2084
+
2085
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2086
+ if @api_client.config.debugging
2087
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2088
+ end
2089
+ return data, status_code, headers
2090
+ end
2091
+
2092
+ # Get Profile Schema Relationships
2093
+ # Get related profile object schemas for an object schema<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_schema_relationships.json)
2094
+ # @param id [String] The ULID ID of the object schema.
2095
+ # @param [Hash] opts the optional parameters
2096
+ # @return [Hash<String, Object>]
2097
+ def get_profile_schema_relationships(id, opts = {})
2098
+ data, _status_code, _headers = get_profile_schema_relationships_with_http_info(id, opts)
2099
+ data
2100
+ end
2101
+
2102
+ # alias of `get_profile_schema_relationships`
2103
+ alias get_object_schema_relationships_profile_object_schemas get_profile_schema_relationships
2104
+
2105
+ # alias of `get_profile_schema_relationships`
2106
+ alias get_profile_object_schema_ids_for_object_schema get_profile_schema_relationships
2107
+
2108
+ # Get Profile Schema Relationships
2109
+ # Get related profile object schemas for an object schema&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_schema_relationships.json)
2110
+ # @param id [String] The ULID ID of the object schema.
2111
+ # @param [Hash] opts the optional parameters
2112
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2113
+ def get_profile_schema_relationships_with_http_info(id, opts = {})
2114
+ if @api_client.config.debugging
2115
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_profile_schema_relationships ...'
2116
+ end
2117
+ # verify the required parameter 'id' is set
2118
+ if @api_client.config.client_side_validation && id.nil?
2119
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_profile_schema_relationships"
2120
+ end
2121
+ # resource path
2122
+ local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2123
+
2124
+ # query parameters
2125
+ query_params = opts[:query_params] || {}
2126
+
2127
+ # header parameters
2128
+ header_params = opts[:header_params] || {}
2129
+ # klaviyo api revision
2130
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2131
+ # HTTP header 'Accept' (if needed)
2132
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2133
+
2134
+ # form parameters
2135
+ form_params = opts[:form_params] || {}
2136
+
2137
+ # http body (model)
2138
+ post_body = opts[:debug_body]
2139
+
2140
+ # return_type
2141
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2142
+
2143
+ # auth_names
2144
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2145
+
2146
+ new_options = opts.merge(
2147
+ :operation => :"CustomObjectsApi.get_profile_schema_relationships",
2148
+ :header_params => header_params,
2149
+ :query_params => query_params,
2150
+ :form_params => form_params,
2151
+ :body => post_body,
2152
+ :auth_names => auth_names,
2153
+ :return_type => return_type
2154
+ )
2155
+
2156
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2157
+ if @api_client.config.debugging
2158
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_profile_schema_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2159
+ end
2160
+ return data, status_code, headers
2161
+ end
2162
+
2163
+ # alias of `get_profile_schema_relationships_with_http_info`
2164
+ alias get_object_schema_relationships_profile_object_schemas_with_http_info get_profile_schema_relationships_with_http_info
2165
+
2166
+ # alias of `get_profile_schema_relationships_with_http_info`
2167
+ alias get_profile_object_schema_ids_for_object_schema_with_http_info get_profile_schema_relationships_with_http_info
2168
+
2169
+ # Get Profile Type Relationships
2170
+ # Get related profile object types for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_type_relationships.json)
2171
+ # @param id [String] The ULID ID of the object type.
2172
+ # @param [Hash] opts the optional parameters
2173
+ # @return [Hash<String, Object>]
2174
+ def get_profile_type_relationships(id, opts = {})
2175
+ data, _status_code, _headers = get_profile_type_relationships_with_http_info(id, opts)
2176
+ data
2177
+ end
2178
+
2179
+ # alias of `get_profile_type_relationships`
2180
+ alias get_object_type_relationships_profile_object_types get_profile_type_relationships
2181
+
2182
+ # alias of `get_profile_type_relationships`
2183
+ alias get_profile_object_type_ids_for_object_type get_profile_type_relationships
2184
+
2185
+ # Get Profile Type Relationships
2186
+ # Get related profile object types for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_type_relationships.json)
2187
+ # @param id [String] The ULID ID of the object type.
2188
+ # @param [Hash] opts the optional parameters
2189
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2190
+ def get_profile_type_relationships_with_http_info(id, opts = {})
2191
+ if @api_client.config.debugging
2192
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_profile_type_relationships ...'
2193
+ end
2194
+ # verify the required parameter 'id' is set
2195
+ if @api_client.config.client_side_validation && id.nil?
2196
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_profile_type_relationships"
2197
+ end
2198
+ # resource path
2199
+ local_var_path = '/api/object-types/{id}/relationships/profile-object-types'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2200
+
2201
+ # query parameters
2202
+ query_params = opts[:query_params] || {}
2203
+
2204
+ # header parameters
2205
+ header_params = opts[:header_params] || {}
2206
+ # klaviyo api revision
2207
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2208
+ # HTTP header 'Accept' (if needed)
2209
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2210
+
2211
+ # form parameters
2212
+ form_params = opts[:form_params] || {}
2213
+
2214
+ # http body (model)
2215
+ post_body = opts[:debug_body]
2216
+
2217
+ # return_type
2218
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2219
+
2220
+ # auth_names
2221
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2222
+
2223
+ new_options = opts.merge(
2224
+ :operation => :"CustomObjectsApi.get_profile_type_relationships",
2225
+ :header_params => header_params,
2226
+ :query_params => query_params,
2227
+ :form_params => form_params,
2228
+ :body => post_body,
2229
+ :auth_names => auth_names,
2230
+ :return_type => return_type
2231
+ )
2232
+
2233
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2234
+ if @api_client.config.debugging
2235
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_profile_type_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2236
+ end
2237
+ return data, status_code, headers
2238
+ end
2239
+
2240
+ # alias of `get_profile_type_relationships_with_http_info`
2241
+ alias get_object_type_relationships_profile_object_types_with_http_info get_profile_type_relationships_with_http_info
2242
+
2243
+ # alias of `get_profile_type_relationships_with_http_info`
2244
+ alias get_profile_object_type_ids_for_object_type_with_http_info get_profile_type_relationships_with_http_info
2245
+
2246
+ # Get Record IDs for Object Type
2247
+ # Get all object records for a given object type.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_record_ids_for_object_type.json)
2248
+ # @param id [String] The ULID ID of the object type.
2249
+ # @param [Hash] opts the optional parameters
2250
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
2251
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
2252
+ # @return [Hash<String, Object>]
2253
+ def get_record_ids_for_object_type(id, opts = {})
2254
+ data, _status_code, _headers = get_record_ids_for_object_type_with_http_info(id, opts)
2255
+ data
2256
+ end
2257
+
2258
+ # alias of `get_record_ids_for_object_type`
2259
+ alias get_object_type_relationships_records get_record_ids_for_object_type
2260
+
2261
+ # Get Record IDs for Object Type
2262
+ # Get all object records for a given object type.&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_record_ids_for_object_type.json)
2263
+ # @param id [String] The ULID ID of the object type.
2264
+ # @param [Hash] opts the optional parameters
2265
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
2266
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
2267
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2268
+ def get_record_ids_for_object_type_with_http_info(id, opts = {})
2269
+ if @api_client.config.debugging
2270
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_record_ids_for_object_type ...'
2271
+ end
2272
+ # verify the required parameter 'id' is set
2273
+ if @api_client.config.client_side_validation && id.nil?
2274
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_record_ids_for_object_type"
2275
+ end
2276
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
2277
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_record_ids_for_object_type, must be smaller than or equal to 100.'
2278
+ end
2279
+
2280
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
2281
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_record_ids_for_object_type, must be greater than or equal to 1.'
2282
+ end
2283
+
2284
+ # resource path
2285
+ local_var_path = '/api/object-types/{id}/relationships/object-records'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2286
+
2287
+ # query parameters
2288
+ query_params = opts[:query_params] || {}
2289
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
2290
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
2291
+
2292
+ # header parameters
2293
+ header_params = opts[:header_params] || {}
2294
+ # klaviyo api revision
2295
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2296
+ # HTTP header 'Accept' (if needed)
2297
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2298
+
2299
+ # form parameters
2300
+ form_params = opts[:form_params] || {}
2301
+
2302
+ # http body (model)
2303
+ post_body = opts[:debug_body]
2304
+
2305
+ # return_type
2306
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2307
+
2308
+ # auth_names
2309
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2310
+
2311
+ new_options = opts.merge(
2312
+ :operation => :"CustomObjectsApi.get_record_ids_for_object_type",
2313
+ :header_params => header_params,
2314
+ :query_params => query_params,
2315
+ :form_params => form_params,
2316
+ :body => post_body,
2317
+ :auth_names => auth_names,
2318
+ :return_type => return_type
2319
+ )
2320
+
2321
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2322
+ if @api_client.config.debugging
2323
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_record_ids_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2324
+ end
2325
+ return data, status_code, headers
2326
+ end
2327
+
2328
+ # alias of `get_record_ids_for_object_type_with_http_info`
2329
+ alias get_object_type_relationships_records_with_http_info get_record_ids_for_object_type_with_http_info
2330
+
2331
+ # Get Records for Object Type
2332
+ # Get all object records for a given object type.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_records_for_object_type.json)
2333
+ # @param id [String] The ULID ID of the object type.
2334
+ # @param [Hash] opts the optional parameters
2335
+ # @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2336
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
2337
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
2338
+ # @return [Hash<String, Object>]
2339
+ def get_records_for_object_type(id, opts = {})
2340
+ data, _status_code, _headers = get_records_for_object_type_with_http_info(id, opts)
2341
+ data
2342
+ end
2343
+
2344
+ # alias of `get_records_for_object_type`
2345
+ alias get_object_type_records get_records_for_object_type
2346
+
2347
+ # Get Records for Object Type
2348
+ # Get all object records for a given object type.&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_records_for_object_type.json)
2349
+ # @param id [String] The ULID ID of the object type.
2350
+ # @param [Hash] opts the optional parameters
2351
+ # @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2352
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
2353
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
2354
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2355
+ def get_records_for_object_type_with_http_info(id, opts = {})
2356
+ if @api_client.config.debugging
2357
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_records_for_object_type ...'
2358
+ end
2359
+ # verify the required parameter 'id' is set
2360
+ if @api_client.config.client_side_validation && id.nil?
2361
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_records_for_object_type"
2362
+ end
2363
+ allowable_values = ["id", "record_properties"]
2364
+ if @api_client.config.client_side_validation && opts[:'fields_object_record'] && !opts[:'fields_object_record'].all? { |item| allowable_values.include?(item) }
2365
+ fail ArgumentError, "invalid value for \"fields_object_record\", must include one of #{allowable_values}"
2366
+ end
2367
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
2368
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_records_for_object_type, must be smaller than or equal to 100.'
2369
+ end
2370
+
2371
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
2372
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_records_for_object_type, must be greater than or equal to 1.'
2373
+ end
2374
+
2375
+ # resource path
2376
+ local_var_path = '/api/object-types/{id}/object-records'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2377
+
2378
+ # query parameters
2379
+ query_params = opts[:query_params] || {}
2380
+ query_params[:'fields[object-record]'] = @api_client.build_collection_param(opts[:'fields_object_record'], :csv) if !opts[:'fields_object_record'].nil?
2381
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
2382
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
2383
+
2384
+ # header parameters
2385
+ header_params = opts[:header_params] || {}
2386
+ # klaviyo api revision
2387
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2388
+ # HTTP header 'Accept' (if needed)
2389
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2390
+
2391
+ # form parameters
2392
+ form_params = opts[:form_params] || {}
2393
+
2394
+ # http body (model)
2395
+ post_body = opts[:debug_body]
2396
+
2397
+ # return_type
2398
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2399
+
2400
+ # auth_names
2401
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2402
+
2403
+ new_options = opts.merge(
2404
+ :operation => :"CustomObjectsApi.get_records_for_object_type",
2405
+ :header_params => header_params,
2406
+ :query_params => query_params,
2407
+ :form_params => form_params,
2408
+ :body => post_body,
2409
+ :auth_names => auth_names,
2410
+ :return_type => return_type
2411
+ )
2412
+
2413
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2414
+ if @api_client.config.debugging
2415
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_records_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2416
+ end
2417
+ return data, status_code, headers
2418
+ end
2419
+
2420
+ # alias of `get_records_for_object_type_with_http_info`
2421
+ alias get_object_type_records_with_http_info get_records_for_object_type_with_http_info
2422
+
2423
+ # Get Schema Version IDs for Object Type
2424
+ # Get all schema versions for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_schema_version_ids_for_object_type.json)
2425
+ # @param id [String] The ULID ID of the object type.
2426
+ # @param [Hash] opts the optional parameters
2427
+ # @return [Hash<String, Object>]
2428
+ def get_schema_version_ids_for_object_type(id, opts = {})
2429
+ data, _status_code, _headers = get_schema_version_ids_for_object_type_with_http_info(id, opts)
2430
+ data
2431
+ end
2432
+
2433
+ # alias of `get_schema_version_ids_for_object_type`
2434
+ alias get_object_type_relationships_schema_versions get_schema_version_ids_for_object_type
2435
+
2436
+ # Get Schema Version IDs for Object Type
2437
+ # Get all schema versions for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_schema_version_ids_for_object_type.json)
2438
+ # @param id [String] The ULID ID of the object type.
2439
+ # @param [Hash] opts the optional parameters
2440
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2441
+ def get_schema_version_ids_for_object_type_with_http_info(id, opts = {})
2442
+ if @api_client.config.debugging
2443
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_schema_version_ids_for_object_type ...'
2444
+ end
2445
+ # verify the required parameter 'id' is set
2446
+ if @api_client.config.client_side_validation && id.nil?
2447
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_schema_version_ids_for_object_type"
2448
+ end
2449
+ # resource path
2450
+ local_var_path = '/api/object-types/{id}/relationships/schema-versions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2451
+
2452
+ # query parameters
2453
+ query_params = opts[:query_params] || {}
2454
+
2455
+ # header parameters
2456
+ header_params = opts[:header_params] || {}
2457
+ # klaviyo api revision
2458
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2459
+ # HTTP header 'Accept' (if needed)
2460
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2461
+
2462
+ # form parameters
2463
+ form_params = opts[:form_params] || {}
2464
+
2465
+ # http body (model)
2466
+ post_body = opts[:debug_body]
2467
+
2468
+ # return_type
2469
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2470
+
2471
+ # auth_names
2472
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2473
+
2474
+ new_options = opts.merge(
2475
+ :operation => :"CustomObjectsApi.get_schema_version_ids_for_object_type",
2476
+ :header_params => header_params,
2477
+ :query_params => query_params,
2478
+ :form_params => form_params,
2479
+ :body => post_body,
2480
+ :auth_names => auth_names,
2481
+ :return_type => return_type
2482
+ )
2483
+
2484
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2485
+ if @api_client.config.debugging
2486
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_schema_version_ids_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2487
+ end
2488
+ return data, status_code, headers
2489
+ end
2490
+
2491
+ # alias of `get_schema_version_ids_for_object_type_with_http_info`
2492
+ alias get_object_type_relationships_schema_versions_with_http_info get_schema_version_ids_for_object_type_with_http_info
2493
+
2494
+ # Get Schema Versions for Object Type
2495
+ # Get all schema versions for an object type<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_schema_versions_for_object_type.json)
2496
+ # @param id [String] The ULID ID of the object type.
2497
+ # @param [Hash] opts the optional parameters
2498
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2499
+ # @return [Hash<String, Object>]
2500
+ def get_schema_versions_for_object_type(id, opts = {})
2501
+ data, _status_code, _headers = get_schema_versions_for_object_type_with_http_info(id, opts)
2502
+ data
2503
+ end
2504
+
2505
+ # alias of `get_schema_versions_for_object_type`
2506
+ alias get_object_type_schema_versions get_schema_versions_for_object_type
2507
+
2508
+ # Get Schema Versions for Object Type
2509
+ # Get all schema versions for an object type&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_schema_versions_for_object_type.json)
2510
+ # @param id [String] The ULID ID of the object type.
2511
+ # @param [Hash] opts the optional parameters
2512
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2513
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2514
+ def get_schema_versions_for_object_type_with_http_info(id, opts = {})
2515
+ if @api_client.config.debugging
2516
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_schema_versions_for_object_type ...'
2517
+ end
2518
+ # verify the required parameter 'id' is set
2519
+ if @api_client.config.client_side_validation && id.nil?
2520
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_schema_versions_for_object_type"
2521
+ end
2522
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
2523
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
2524
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
2525
+ end
2526
+ # resource path
2527
+ local_var_path = '/api/object-types/{id}/schema-versions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2528
+
2529
+ # query parameters
2530
+ query_params = opts[:query_params] || {}
2531
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
2532
+
2533
+ # header parameters
2534
+ header_params = opts[:header_params] || {}
2535
+ # klaviyo api revision
2536
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2537
+ # HTTP header 'Accept' (if needed)
2538
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2539
+
2540
+ # form parameters
2541
+ form_params = opts[:form_params] || {}
2542
+
2543
+ # http body (model)
2544
+ post_body = opts[:debug_body]
2545
+
2546
+ # return_type
2547
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2548
+
2549
+ # auth_names
2550
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2551
+
2552
+ new_options = opts.merge(
2553
+ :operation => :"CustomObjectsApi.get_schema_versions_for_object_type",
2554
+ :header_params => header_params,
2555
+ :query_params => query_params,
2556
+ :form_params => form_params,
2557
+ :body => post_body,
2558
+ :auth_names => auth_names,
2559
+ :return_type => return_type
2560
+ )
2561
+
2562
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2563
+ if @api_client.config.debugging
2564
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_schema_versions_for_object_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2565
+ end
2566
+ return data, status_code, headers
2567
+ end
2568
+
2569
+ # alias of `get_schema_versions_for_object_type_with_http_info`
2570
+ alias get_object_type_schema_versions_with_http_info get_schema_versions_for_object_type_with_http_info
2571
+
2572
+ # Get Source Mapping
2573
+ # Get the source mapping with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping.json)
2574
+ # @param id [String] The ID of the source mapping
2575
+ # @param [Hash] opts the optional parameters
2576
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2577
+ # @return [Hash<String, Object>]
2578
+ def get_source_mapping(id, opts = {})
2579
+ data, _status_code, _headers = get_source_mapping_with_http_info(id, opts)
2580
+ data
2581
+ end
2582
+
2583
+ # Get Source Mapping
2584
+ # Get the source mapping 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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping.json)
2585
+ # @param id [String] The ID of the source mapping
2586
+ # @param [Hash] opts the optional parameters
2587
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2588
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2589
+ def get_source_mapping_with_http_info(id, opts = {})
2590
+ if @api_client.config.debugging
2591
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_source_mapping ...'
2592
+ end
2593
+ # verify the required parameter 'id' is set
2594
+ if @api_client.config.client_side_validation && id.nil?
2595
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_source_mapping"
2596
+ end
2597
+ allowable_values = ["id", "property_mappings", "relationship_mappings"]
2598
+ if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
2599
+ fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
2600
+ end
2601
+ # resource path
2602
+ local_var_path = '/api/source-mappings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2603
+
2604
+ # query parameters
2605
+ query_params = opts[:query_params] || {}
2606
+ query_params[:'fields[source-mapping]'] = @api_client.build_collection_param(opts[:'fields_source_mapping'], :csv) if !opts[:'fields_source_mapping'].nil?
2607
+
2608
+ # header parameters
2609
+ header_params = opts[:header_params] || {}
2610
+ # klaviyo api revision
2611
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2612
+ # HTTP header 'Accept' (if needed)
2613
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2614
+
2615
+ # form parameters
2616
+ form_params = opts[:form_params] || {}
2617
+
2618
+ # http body (model)
2619
+ post_body = opts[:debug_body]
2620
+
2621
+ # return_type
2622
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2623
+
2624
+ # auth_names
2625
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2626
+
2627
+ new_options = opts.merge(
2628
+ :operation => :"CustomObjectsApi.get_source_mapping",
2629
+ :header_params => header_params,
2630
+ :query_params => query_params,
2631
+ :form_params => form_params,
2632
+ :body => post_body,
2633
+ :auth_names => auth_names,
2634
+ :return_type => return_type
2635
+ )
2636
+
2637
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2638
+ if @api_client.config.debugging
2639
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_source_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2640
+ end
2641
+ return data, status_code, headers
2642
+ end
2643
+
2644
+ # Get Source Mapping for Object Schema
2645
+ # Get source mapping for an object schema<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping_for_object_schema.json)
2646
+ # @param id [String] The ULID ID of the object schema.
2647
+ # @param [Hash] opts the optional parameters
2648
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2649
+ # @return [Hash<String, Object>]
2650
+ def get_source_mapping_for_object_schema(id, opts = {})
2651
+ data, _status_code, _headers = get_source_mapping_for_object_schema_with_http_info(id, opts)
2652
+ data
2653
+ end
2654
+
2655
+ # alias of `get_source_mapping_for_object_schema`
2656
+ alias get_object_schema_source_mapping get_source_mapping_for_object_schema
2657
+
2658
+ # Get Source Mapping for Object Schema
2659
+ # Get source mapping for an object schema&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping_for_object_schema.json)
2660
+ # @param id [String] The ULID ID of the object schema.
2661
+ # @param [Hash] opts the optional parameters
2662
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2663
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2664
+ def get_source_mapping_for_object_schema_with_http_info(id, opts = {})
2665
+ if @api_client.config.debugging
2666
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_source_mapping_for_object_schema ...'
2667
+ end
2668
+ # verify the required parameter 'id' is set
2669
+ if @api_client.config.client_side_validation && id.nil?
2670
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_source_mapping_for_object_schema"
2671
+ end
2672
+ allowable_values = ["id", "property_mappings", "relationship_mappings"]
2673
+ if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
2674
+ fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
2675
+ end
2676
+ # resource path
2677
+ local_var_path = '/api/object-schemas/{id}/source-mapping'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2678
+
2679
+ # query parameters
2680
+ query_params = opts[:query_params] || {}
2681
+ query_params[:'fields[source-mapping]'] = @api_client.build_collection_param(opts[:'fields_source_mapping'], :csv) if !opts[:'fields_source_mapping'].nil?
2682
+
2683
+ # header parameters
2684
+ header_params = opts[:header_params] || {}
2685
+ # klaviyo api revision
2686
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2687
+ # HTTP header 'Accept' (if needed)
2688
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2689
+
2690
+ # form parameters
2691
+ form_params = opts[:form_params] || {}
2692
+
2693
+ # http body (model)
2694
+ post_body = opts[:debug_body]
2695
+
2696
+ # return_type
2697
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2698
+
2699
+ # auth_names
2700
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2701
+
2702
+ new_options = opts.merge(
2703
+ :operation => :"CustomObjectsApi.get_source_mapping_for_object_schema",
2704
+ :header_params => header_params,
2705
+ :query_params => query_params,
2706
+ :form_params => form_params,
2707
+ :body => post_body,
2708
+ :auth_names => auth_names,
2709
+ :return_type => return_type
2710
+ )
2711
+
2712
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2713
+ if @api_client.config.debugging
2714
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_source_mapping_for_object_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2715
+ end
2716
+ return data, status_code, headers
2717
+ end
2718
+
2719
+ # alias of `get_source_mapping_for_object_schema_with_http_info`
2720
+ alias get_object_schema_source_mapping_with_http_info get_source_mapping_for_object_schema_with_http_info
2721
+
2722
+ # Get Source Mapping ID for Object Schema
2723
+ # Get source mapping for an object schema<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping_id_for_object_schema.json)
2724
+ # @param id [String] The ULID ID of the object schema.
2725
+ # @param [Hash] opts the optional parameters
2726
+ # @return [Hash<String, Object>]
2727
+ def get_source_mapping_id_for_object_schema(id, opts = {})
2728
+ data, _status_code, _headers = get_source_mapping_id_for_object_schema_with_http_info(id, opts)
2729
+ data
2730
+ end
2731
+
2732
+ # alias of `get_source_mapping_id_for_object_schema`
2733
+ alias get_object_schema_relationships_source_mapping get_source_mapping_id_for_object_schema
2734
+
2735
+ # Get Source Mapping ID for Object Schema
2736
+ # Get source mapping for an object schema&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;custom-objects:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_source_mapping_id_for_object_schema.json)
2737
+ # @param id [String] The ULID ID of the object schema.
2738
+ # @param [Hash] opts the optional parameters
2739
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2740
+ def get_source_mapping_id_for_object_schema_with_http_info(id, opts = {})
2741
+ if @api_client.config.debugging
2742
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_source_mapping_id_for_object_schema ...'
2743
+ end
2744
+ # verify the required parameter 'id' is set
2745
+ if @api_client.config.client_side_validation && id.nil?
2746
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_source_mapping_id_for_object_schema"
2747
+ end
2748
+ # resource path
2749
+ local_var_path = '/api/object-schemas/{id}/relationships/source-mapping'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2750
+
2751
+ # query parameters
2752
+ query_params = opts[:query_params] || {}
2753
+
2754
+ # header parameters
2755
+ header_params = opts[:header_params] || {}
2756
+ # klaviyo api revision
2757
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2758
+ # HTTP header 'Accept' (if needed)
2759
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2760
+
2761
+ # form parameters
2762
+ form_params = opts[:form_params] || {}
2763
+
2764
+ # http body (model)
2765
+ post_body = opts[:debug_body]
2766
+
2767
+ # return_type
2768
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2769
+
2770
+ # auth_names
2771
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2772
+
2773
+ new_options = opts.merge(
2774
+ :operation => :"CustomObjectsApi.get_source_mapping_id_for_object_schema",
445
2775
  :header_params => header_params,
446
2776
  :query_params => query_params,
447
2777
  :form_params => form_params,
@@ -452,7 +2782,352 @@ module KlaviyoAPI
452
2782
 
453
2783
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
454
2784
  if @api_client.config.debugging
455
- @api_client.config.logger.debug "API called: CustomObjectsApi#get_data_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2785
+ @api_client.config.logger.debug "API called: CustomObjectsApi#get_source_mapping_id_for_object_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2786
+ end
2787
+ return data, status_code, headers
2788
+ end
2789
+
2790
+ # alias of `get_source_mapping_id_for_object_schema_with_http_info`
2791
+ alias get_object_schema_relationships_source_mapping_with_http_info get_source_mapping_id_for_object_schema_with_http_info
2792
+
2793
+ # Update Object Schema
2794
+ # Update the object schema with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_object_schema.json)
2795
+ # @param id [String] The ULID ID of the object schema.
2796
+ # @param object_schema_partial_update_query [ObjectSchemaPartialUpdateQuery] Update a object schema by ID
2797
+ # @param [Hash] opts the optional parameters
2798
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2799
+ # @return [Hash<String, Object>]
2800
+ def update_object_schema(id, object_schema_partial_update_query, opts = {})
2801
+ data, _status_code, _headers = update_object_schema_with_http_info(id, object_schema_partial_update_query, opts)
2802
+ data
2803
+ end
2804
+
2805
+ # Update Object Schema
2806
+ # Update the object schema 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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_object_schema.json)
2807
+ # @param id [String] The ULID ID of the object schema.
2808
+ # @param object_schema_partial_update_query [ObjectSchemaPartialUpdateQuery] Update a object schema by ID
2809
+ # @param [Hash] opts the optional parameters
2810
+ # @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
2811
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2812
+ def update_object_schema_with_http_info(id, object_schema_partial_update_query, opts = {})
2813
+ if @api_client.config.debugging
2814
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_object_schema ...'
2815
+ end
2816
+ # verify the required parameter 'id' is set
2817
+ if @api_client.config.client_side_validation && id.nil?
2818
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.update_object_schema"
2819
+ end
2820
+ # verify the required parameter 'object_schema_partial_update_query' is set
2821
+ if @api_client.config.client_side_validation && object_schema_partial_update_query.nil?
2822
+ fail ArgumentError, "Missing the required parameter 'object_schema_partial_update_query' when calling CustomObjectsApi.update_object_schema"
2823
+ end
2824
+ allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
2825
+ if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
2826
+ fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
2827
+ end
2828
+ # resource path
2829
+ local_var_path = '/api/object-schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2830
+
2831
+ # query parameters
2832
+ query_params = opts[:query_params] || {}
2833
+ query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
2834
+
2835
+ # header parameters
2836
+ header_params = opts[:header_params] || {}
2837
+ # klaviyo api revision
2838
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2839
+ # HTTP header 'Accept' (if needed)
2840
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2841
+ # HTTP header 'Content-Type'
2842
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
2843
+ if !content_type.nil?
2844
+ header_params['Content-Type'] = content_type
2845
+ end
2846
+
2847
+ # form parameters
2848
+ form_params = opts[:form_params] || {}
2849
+
2850
+ # http body (model)
2851
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_schema_partial_update_query)
2852
+
2853
+ # return_type
2854
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
2855
+
2856
+ # auth_names
2857
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2858
+
2859
+ new_options = opts.merge(
2860
+ :operation => :"CustomObjectsApi.update_object_schema",
2861
+ :header_params => header_params,
2862
+ :query_params => query_params,
2863
+ :form_params => form_params,
2864
+ :body => post_body,
2865
+ :auth_names => auth_names,
2866
+ :return_type => return_type
2867
+ )
2868
+
2869
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
2870
+ if @api_client.config.debugging
2871
+ @api_client.config.logger.debug "API called: CustomObjectsApi#update_object_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2872
+ end
2873
+ return data, status_code, headers
2874
+ end
2875
+
2876
+ # Update Object Schema Relationship
2877
+ # Update a relationship between object schemas<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_object_schema_relationship.json)
2878
+ # @param id [String] The ULID ID of the object schema.
2879
+ # @param object_schema_relationship_partial_update_query [ObjectSchemaRelationshipPartialUpdateQuery] Update a relationship between object schemas
2880
+ # @param [Hash] opts the optional parameters
2881
+ # @return [nil]
2882
+ def update_object_schema_relationship(id, object_schema_relationship_partial_update_query, opts = {})
2883
+ update_object_schema_relationship_with_http_info(id, object_schema_relationship_partial_update_query, opts)
2884
+ nil
2885
+ end
2886
+
2887
+ # alias of `update_object_schema_relationship`
2888
+ alias update_object_schema_relationships_schemas update_object_schema_relationship
2889
+
2890
+ # alias of `update_object_schema_relationship`
2891
+ alias update_schemas_for_object_schema update_object_schema_relationship
2892
+
2893
+ # Update Object Schema Relationship
2894
+ # Update a relationship between object schemas&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_object_schema_relationship.json)
2895
+ # @param id [String] The ULID ID of the object schema.
2896
+ # @param object_schema_relationship_partial_update_query [ObjectSchemaRelationshipPartialUpdateQuery] Update a relationship between object schemas
2897
+ # @param [Hash] opts the optional parameters
2898
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2899
+ def update_object_schema_relationship_with_http_info(id, object_schema_relationship_partial_update_query, opts = {})
2900
+ if @api_client.config.debugging
2901
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_object_schema_relationship ...'
2902
+ end
2903
+ # verify the required parameter 'id' is set
2904
+ if @api_client.config.client_side_validation && id.nil?
2905
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.update_object_schema_relationship"
2906
+ end
2907
+ # verify the required parameter 'object_schema_relationship_partial_update_query' is set
2908
+ if @api_client.config.client_side_validation && object_schema_relationship_partial_update_query.nil?
2909
+ fail ArgumentError, "Missing the required parameter 'object_schema_relationship_partial_update_query' when calling CustomObjectsApi.update_object_schema_relationship"
2910
+ end
2911
+ # resource path
2912
+ local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2913
+
2914
+ # query parameters
2915
+ query_params = opts[:query_params] || {}
2916
+
2917
+ # header parameters
2918
+ header_params = opts[:header_params] || {}
2919
+ # klaviyo api revision
2920
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
2921
+ # HTTP header 'Accept' (if needed)
2922
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2923
+ # HTTP header 'Content-Type'
2924
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
2925
+ if !content_type.nil?
2926
+ header_params['Content-Type'] = content_type
2927
+ end
2928
+
2929
+ # form parameters
2930
+ form_params = opts[:form_params] || {}
2931
+
2932
+ # http body (model)
2933
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(object_schema_relationship_partial_update_query)
2934
+
2935
+ # return_type
2936
+ return_type = opts[:debug_return_type]
2937
+
2938
+ # auth_names
2939
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2940
+
2941
+ new_options = opts.merge(
2942
+ :operation => :"CustomObjectsApi.update_object_schema_relationship",
2943
+ :header_params => header_params,
2944
+ :query_params => query_params,
2945
+ :form_params => form_params,
2946
+ :body => post_body,
2947
+ :auth_names => auth_names,
2948
+ :return_type => return_type
2949
+ )
2950
+
2951
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
2952
+ if @api_client.config.debugging
2953
+ @api_client.config.logger.debug "API called: CustomObjectsApi#update_object_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2954
+ end
2955
+ return data, status_code, headers
2956
+ end
2957
+
2958
+ # alias of `update_object_schema_relationship_with_http_info`
2959
+ alias update_object_schema_relationships_schemas_with_http_info update_object_schema_relationship_with_http_info
2960
+
2961
+ # alias of `update_object_schema_relationship_with_http_info`
2962
+ alias update_schemas_for_object_schema_with_http_info update_object_schema_relationship_with_http_info
2963
+
2964
+ # Update Profile Schema Relationship
2965
+ # Update a relationship between an object schema and a profile<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile_schema_relationship.json)
2966
+ # @param id [String] The ULID ID of the object schema.
2967
+ # @param profile_object_schema_relationship_partial_update_query [ProfileObjectSchemaRelationshipPartialUpdateQuery] Update a relationship between an object schema and a profile
2968
+ # @param [Hash] opts the optional parameters
2969
+ # @return [nil]
2970
+ def update_profile_schema_relationship(id, profile_object_schema_relationship_partial_update_query, opts = {})
2971
+ update_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_partial_update_query, opts)
2972
+ nil
2973
+ end
2974
+
2975
+ # alias of `update_profile_schema_relationship`
2976
+ alias update_object_schema_relationships_profile_object_schemas update_profile_schema_relationship
2977
+
2978
+ # alias of `update_profile_schema_relationship`
2979
+ alias update_profile_object_schemas_for_object_schema update_profile_schema_relationship
2980
+
2981
+ # Update Profile Schema Relationship
2982
+ # Update a relationship between an object schema and a profile&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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile_schema_relationship.json)
2983
+ # @param id [String] The ULID ID of the object schema.
2984
+ # @param profile_object_schema_relationship_partial_update_query [ProfileObjectSchemaRelationshipPartialUpdateQuery] Update a relationship between an object schema and a profile
2985
+ # @param [Hash] opts the optional parameters
2986
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2987
+ def update_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_partial_update_query, opts = {})
2988
+ if @api_client.config.debugging
2989
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_profile_schema_relationship ...'
2990
+ end
2991
+ # verify the required parameter 'id' is set
2992
+ if @api_client.config.client_side_validation && id.nil?
2993
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.update_profile_schema_relationship"
2994
+ end
2995
+ # verify the required parameter 'profile_object_schema_relationship_partial_update_query' is set
2996
+ if @api_client.config.client_side_validation && profile_object_schema_relationship_partial_update_query.nil?
2997
+ fail ArgumentError, "Missing the required parameter 'profile_object_schema_relationship_partial_update_query' when calling CustomObjectsApi.update_profile_schema_relationship"
2998
+ end
2999
+ # resource path
3000
+ local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
3001
+
3002
+ # query parameters
3003
+ query_params = opts[:query_params] || {}
3004
+
3005
+ # header parameters
3006
+ header_params = opts[:header_params] || {}
3007
+ # klaviyo api revision
3008
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
3009
+ # HTTP header 'Accept' (if needed)
3010
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
3011
+ # HTTP header 'Content-Type'
3012
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
3013
+ if !content_type.nil?
3014
+ header_params['Content-Type'] = content_type
3015
+ end
3016
+
3017
+ # form parameters
3018
+ form_params = opts[:form_params] || {}
3019
+
3020
+ # http body (model)
3021
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_object_schema_relationship_partial_update_query)
3022
+
3023
+ # return_type
3024
+ return_type = opts[:debug_return_type]
3025
+
3026
+ # auth_names
3027
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
3028
+
3029
+ new_options = opts.merge(
3030
+ :operation => :"CustomObjectsApi.update_profile_schema_relationship",
3031
+ :header_params => header_params,
3032
+ :query_params => query_params,
3033
+ :form_params => form_params,
3034
+ :body => post_body,
3035
+ :auth_names => auth_names,
3036
+ :return_type => return_type
3037
+ )
3038
+
3039
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
3040
+ if @api_client.config.debugging
3041
+ @api_client.config.logger.debug "API called: CustomObjectsApi#update_profile_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3042
+ end
3043
+ return data, status_code, headers
3044
+ end
3045
+
3046
+ # alias of `update_profile_schema_relationship_with_http_info`
3047
+ alias update_object_schema_relationships_profile_object_schemas_with_http_info update_profile_schema_relationship_with_http_info
3048
+
3049
+ # alias of `update_profile_schema_relationship_with_http_info`
3050
+ alias update_profile_object_schemas_for_object_schema_with_http_info update_profile_schema_relationship_with_http_info
3051
+
3052
+ # Update Source Mapping
3053
+ # Update the source mapping with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_source_mapping.json)
3054
+ # @param id [String] The ULID ID of the source mapping
3055
+ # @param source_mapping_partial_update_query [SourceMappingPartialUpdateQuery] Update a source mapping by ID
3056
+ # @param [Hash] opts the optional parameters
3057
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
3058
+ # @return [Hash<String, Object>]
3059
+ def update_source_mapping(id, source_mapping_partial_update_query, opts = {})
3060
+ data, _status_code, _headers = update_source_mapping_with_http_info(id, source_mapping_partial_update_query, opts)
3061
+ data
3062
+ end
3063
+
3064
+ # Update Source Mapping
3065
+ # Update the source mapping 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;custom-objects:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_source_mapping.json)
3066
+ # @param id [String] The ULID ID of the source mapping
3067
+ # @param source_mapping_partial_update_query [SourceMappingPartialUpdateQuery] Update a source mapping by ID
3068
+ # @param [Hash] opts the optional parameters
3069
+ # @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
3070
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
3071
+ def update_source_mapping_with_http_info(id, source_mapping_partial_update_query, opts = {})
3072
+ if @api_client.config.debugging
3073
+ @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_source_mapping ...'
3074
+ end
3075
+ # verify the required parameter 'id' is set
3076
+ if @api_client.config.client_side_validation && id.nil?
3077
+ fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.update_source_mapping"
3078
+ end
3079
+ # verify the required parameter 'source_mapping_partial_update_query' is set
3080
+ if @api_client.config.client_side_validation && source_mapping_partial_update_query.nil?
3081
+ fail ArgumentError, "Missing the required parameter 'source_mapping_partial_update_query' when calling CustomObjectsApi.update_source_mapping"
3082
+ end
3083
+ allowable_values = ["id", "property_mappings", "relationship_mappings"]
3084
+ if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
3085
+ fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
3086
+ end
3087
+ # resource path
3088
+ local_var_path = '/api/source-mappings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
3089
+
3090
+ # query parameters
3091
+ query_params = opts[:query_params] || {}
3092
+ query_params[:'fields[source-mapping]'] = @api_client.build_collection_param(opts[:'fields_source_mapping'], :csv) if !opts[:'fields_source_mapping'].nil?
3093
+
3094
+ # header parameters
3095
+ header_params = opts[:header_params] || {}
3096
+ # klaviyo api revision
3097
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
3098
+ # HTTP header 'Accept' (if needed)
3099
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
3100
+ # HTTP header 'Content-Type'
3101
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
3102
+ if !content_type.nil?
3103
+ header_params['Content-Type'] = content_type
3104
+ end
3105
+
3106
+ # form parameters
3107
+ form_params = opts[:form_params] || {}
3108
+
3109
+ # http body (model)
3110
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(source_mapping_partial_update_query)
3111
+
3112
+ # return_type
3113
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
3114
+
3115
+ # auth_names
3116
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
3117
+
3118
+ new_options = opts.merge(
3119
+ :operation => :"CustomObjectsApi.update_source_mapping",
3120
+ :header_params => header_params,
3121
+ :query_params => query_params,
3122
+ :form_params => form_params,
3123
+ :body => post_body,
3124
+ :auth_names => auth_names,
3125
+ :return_type => return_type
3126
+ )
3127
+
3128
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
3129
+ if @api_client.config.debugging
3130
+ @api_client.config.logger.debug "API called: CustomObjectsApi#update_source_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
456
3131
  end
457
3132
  return data, status_code, headers
458
3133
  end