klaviyo-api-sdk 18.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +44 -0
- data/README.md +1525 -459
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
- data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3298 -653
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
- data/lib/klaviyo-api-sdk/api/client_api.rb +9 -13
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +80 -80
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +120 -117
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +190 -113
- data/lib/klaviyo-api-sdk/api/forms_api.rb +292 -43
- data/lib/klaviyo-api-sdk/api/images_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/lists_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -163
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/segments_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/tags_api.rb +62 -62
- data/lib/klaviyo-api-sdk/api/templates_api.rb +236 -76
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +19 -19
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → ab_test_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → ab_test_settings.rb} +36 -35
- data/lib/klaviyo-api-sdk/models/action_output_split_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → audience_create_query_resource_object_relationships.rb} +19 -24
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
- data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
- data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
- data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{audiences.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +25 -28
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
- 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
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_footer_patch_attributes.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_header_patch_attributes.rb} +36 -38
- data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
- data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → brand_library_text_styles_letter_spacing.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → brand_social_group_create_query_resource_object_attributes_social_links_inner.rb} +3 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
- 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
- data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button_definition.rb → campaign_definition.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
- data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb} +17 -14
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → continue_with_shop.rb} +29 -22
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → continue_with_shop_autofill.rb} +50 -37
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → continue_with_shop_properties.rb} +76 -59
- data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +33 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → coupon_assigner_configuration.rb} +40 -48
- data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
- data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
- data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/email_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → first_party_social_link.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → flow_action_insert_query_resource_object_attributes_anchor_action.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb} +86 -16
- data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
- 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
- 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
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +36 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → iaf_open_url.rb} +42 -34
- data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
- data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → link_text_styles_letter_spacing.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb} +31 -30
- data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
- data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb} +56 -57
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
- data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
- data/lib/klaviyo-api-sdk/models/message_tracking_options.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → multi_branch_split_action_link_only.rb} +15 -32
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +4 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +28 -8
- data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_video.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → rcs_rich_content.rb} +36 -14
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/review_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +2 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{render_options.rb → spacing_styles.rb} +48 -40
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +21 -31
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb} +54 -53
- data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → throttled_options.rb} +31 -32
- data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → timezone_options.rb} +13 -13
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → translation_partial_update_query_resource_object_attributes.rb} +39 -41
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
- 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
- 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
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
- 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
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_definition.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -5
- data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → variation_definition_details.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +305 -78
- data/lib/klaviyo-api-sdk.rb.bak +306 -79
- metadata +315 -82
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +0 -293
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
|
@@ -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-
|
|
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'
|
|
@@ -129,7 +129,7 @@ module KlaviyoAPI
|
|
|
129
129
|
# header parameters
|
|
130
130
|
header_params = opts[:header_params] || {}
|
|
131
131
|
# klaviyo api revision
|
|
132
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
132
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
133
133
|
# HTTP header 'Accept' (if needed)
|
|
134
134
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
135
135
|
# HTTP header 'Content-Type'
|
|
@@ -174,7 +174,7 @@ module KlaviyoAPI
|
|
|
174
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)
|
|
175
175
|
# @param data_source_create_query [DataSourceCreateQuery] Create data source
|
|
176
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-
|
|
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
|
|
178
178
|
# @return [Hash<String, Object>]
|
|
179
179
|
def create_data_source(data_source_create_query, opts = {})
|
|
180
180
|
data, _status_code, _headers = create_data_source_with_http_info(data_source_create_query, opts)
|
|
@@ -185,7 +185,7 @@ module KlaviyoAPI
|
|
|
185
185
|
# 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)
|
|
186
186
|
# @param data_source_create_query [DataSourceCreateQuery] Create data source
|
|
187
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-
|
|
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
|
|
189
189
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
190
190
|
def create_data_source_with_http_info(data_source_create_query, opts = {})
|
|
191
191
|
if @api_client.config.debugging
|
|
@@ -209,7 +209,7 @@ module KlaviyoAPI
|
|
|
209
209
|
# header parameters
|
|
210
210
|
header_params = opts[:header_params] || {}
|
|
211
211
|
# klaviyo api revision
|
|
212
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
212
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
213
213
|
# HTTP header 'Accept' (if needed)
|
|
214
214
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
215
215
|
# HTTP header 'Content-Type'
|
|
@@ -282,7 +282,7 @@ module KlaviyoAPI
|
|
|
282
282
|
# header parameters
|
|
283
283
|
header_params = opts[:header_params] || {}
|
|
284
284
|
# klaviyo api revision
|
|
285
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
286
286
|
# HTTP header 'Accept' (if needed)
|
|
287
287
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
288
288
|
# HTTP header 'Content-Type'
|
|
@@ -327,7 +327,7 @@ module KlaviyoAPI
|
|
|
327
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
328
|
# @param object_schema_create_query [ObjectSchemaCreateQuery] Create an object schema
|
|
329
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-
|
|
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
331
|
# @return [Hash<String, Object>]
|
|
332
332
|
def create_object_schema(object_schema_create_query, opts = {})
|
|
333
333
|
data, _status_code, _headers = create_object_schema_with_http_info(object_schema_create_query, opts)
|
|
@@ -338,7 +338,7 @@ module KlaviyoAPI
|
|
|
338
338
|
# 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)
|
|
339
339
|
# @param object_schema_create_query [ObjectSchemaCreateQuery] Create an object schema
|
|
340
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-
|
|
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
342
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
343
343
|
def create_object_schema_with_http_info(object_schema_create_query, opts = {})
|
|
344
344
|
if @api_client.config.debugging
|
|
@@ -362,7 +362,7 @@ module KlaviyoAPI
|
|
|
362
362
|
# header parameters
|
|
363
363
|
header_params = opts[:header_params] || {}
|
|
364
364
|
# klaviyo api revision
|
|
365
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
365
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
366
366
|
# HTTP header 'Accept' (if needed)
|
|
367
367
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
368
368
|
# HTTP header 'Content-Type'
|
|
@@ -444,7 +444,7 @@ module KlaviyoAPI
|
|
|
444
444
|
# header parameters
|
|
445
445
|
header_params = opts[:header_params] || {}
|
|
446
446
|
# klaviyo api revision
|
|
447
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
447
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
448
448
|
# HTTP header 'Accept' (if needed)
|
|
449
449
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
450
450
|
# HTTP header 'Content-Type'
|
|
@@ -492,7 +492,7 @@ module KlaviyoAPI
|
|
|
492
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
493
|
# @param object_type_create_query [ObjectTypeCreateQuery] Create an object type
|
|
494
494
|
# @param [Hash] opts the optional parameters
|
|
495
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
496
496
|
# @return [Hash<String, Object>]
|
|
497
497
|
def create_object_type(object_type_create_query, opts = {})
|
|
498
498
|
data, _status_code, _headers = create_object_type_with_http_info(object_type_create_query, opts)
|
|
@@ -503,7 +503,7 @@ module KlaviyoAPI
|
|
|
503
503
|
# 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)
|
|
504
504
|
# @param object_type_create_query [ObjectTypeCreateQuery] Create an object type
|
|
505
505
|
# @param [Hash] opts the optional parameters
|
|
506
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
507
507
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
508
508
|
def create_object_type_with_http_info(object_type_create_query, opts = {})
|
|
509
509
|
if @api_client.config.debugging
|
|
@@ -527,7 +527,7 @@ module KlaviyoAPI
|
|
|
527
527
|
# header parameters
|
|
528
528
|
header_params = opts[:header_params] || {}
|
|
529
529
|
# klaviyo api revision
|
|
530
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
530
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
531
531
|
# HTTP header 'Accept' (if needed)
|
|
532
532
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
533
533
|
# HTTP header 'Content-Type'
|
|
@@ -609,7 +609,7 @@ module KlaviyoAPI
|
|
|
609
609
|
# header parameters
|
|
610
610
|
header_params = opts[:header_params] || {}
|
|
611
611
|
# klaviyo api revision
|
|
612
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
612
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
613
613
|
# HTTP header 'Accept' (if needed)
|
|
614
614
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
615
615
|
# HTTP header 'Content-Type'
|
|
@@ -685,7 +685,7 @@ module KlaviyoAPI
|
|
|
685
685
|
# header parameters
|
|
686
686
|
header_params = opts[:header_params] || {}
|
|
687
687
|
# klaviyo api revision
|
|
688
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
688
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
689
689
|
# HTTP header 'Accept' (if needed)
|
|
690
690
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
691
691
|
|
|
@@ -762,7 +762,7 @@ module KlaviyoAPI
|
|
|
762
762
|
# header parameters
|
|
763
763
|
header_params = opts[:header_params] || {}
|
|
764
764
|
# klaviyo api revision
|
|
765
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
765
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
766
766
|
# HTTP header 'Accept' (if needed)
|
|
767
767
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
768
768
|
# HTTP header 'Content-Type'
|
|
@@ -838,7 +838,7 @@ module KlaviyoAPI
|
|
|
838
838
|
# header parameters
|
|
839
839
|
header_params = opts[:header_params] || {}
|
|
840
840
|
# klaviyo api revision
|
|
841
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
841
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
842
842
|
# HTTP header 'Accept' (if needed)
|
|
843
843
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
844
844
|
|
|
@@ -915,7 +915,7 @@ module KlaviyoAPI
|
|
|
915
915
|
# header parameters
|
|
916
916
|
header_params = opts[:header_params] || {}
|
|
917
917
|
# klaviyo api revision
|
|
918
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
918
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
919
919
|
# HTTP header 'Accept' (if needed)
|
|
920
920
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
921
921
|
# HTTP header 'Content-Type'
|
|
@@ -963,7 +963,7 @@ module KlaviyoAPI
|
|
|
963
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
964
|
# @param id [String] The ULID ID of the object type.
|
|
965
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-
|
|
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
967
|
# @return [Hash<String, Object>]
|
|
968
968
|
def get_current_schema_for_object_type(id, opts = {})
|
|
969
969
|
data, _status_code, _headers = get_current_schema_for_object_type_with_http_info(id, opts)
|
|
@@ -977,7 +977,7 @@ module KlaviyoAPI
|
|
|
977
977
|
# 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)
|
|
978
978
|
# @param id [String] The ULID ID of the object type.
|
|
979
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-
|
|
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
981
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
982
982
|
def get_current_schema_for_object_type_with_http_info(id, opts = {})
|
|
983
983
|
if @api_client.config.debugging
|
|
@@ -1001,7 +1001,7 @@ module KlaviyoAPI
|
|
|
1001
1001
|
# header parameters
|
|
1002
1002
|
header_params = opts[:header_params] || {}
|
|
1003
1003
|
# klaviyo api revision
|
|
1004
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1004
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1005
1005
|
# HTTP header 'Accept' (if needed)
|
|
1006
1006
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1007
1007
|
|
|
@@ -1072,7 +1072,7 @@ module KlaviyoAPI
|
|
|
1072
1072
|
# header parameters
|
|
1073
1073
|
header_params = opts[:header_params] || {}
|
|
1074
1074
|
# klaviyo api revision
|
|
1075
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1075
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1076
1076
|
# HTTP header 'Accept' (if needed)
|
|
1077
1077
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1078
1078
|
|
|
@@ -1112,7 +1112,7 @@ module KlaviyoAPI
|
|
|
1112
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
1113
|
# @param id [String] The ID of the data source
|
|
1114
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-
|
|
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
1116
|
# @return [Hash<String, Object>]
|
|
1117
1117
|
def get_data_source(id, opts = {})
|
|
1118
1118
|
data, _status_code, _headers = get_data_source_with_http_info(id, opts)
|
|
@@ -1123,7 +1123,7 @@ module KlaviyoAPI
|
|
|
1123
1123
|
# 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)
|
|
1124
1124
|
# @param id [String] The ID of the data source
|
|
1125
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-
|
|
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
1127
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1128
1128
|
def get_data_source_with_http_info(id, opts = {})
|
|
1129
1129
|
if @api_client.config.debugging
|
|
@@ -1147,7 +1147,7 @@ module KlaviyoAPI
|
|
|
1147
1147
|
# header parameters
|
|
1148
1148
|
header_params = opts[:header_params] || {}
|
|
1149
1149
|
# klaviyo api revision
|
|
1150
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1150
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1151
1151
|
# HTTP header 'Accept' (if needed)
|
|
1152
1152
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1153
1153
|
|
|
@@ -1183,8 +1183,9 @@ module KlaviyoAPI
|
|
|
1183
1183
|
# Get Data Sources
|
|
1184
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
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-
|
|
1187
|
-
# @option opts [String] :
|
|
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<br>Allowed field(s)/operator(s):<br>`namespace`: `equals` (string)
|
|
1188
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1188
1189
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
1189
1190
|
# @return [Hash<String, Object>]
|
|
1190
1191
|
def get_data_sources(opts = {})
|
|
@@ -1195,8 +1196,9 @@ module KlaviyoAPI
|
|
|
1195
1196
|
# Get Data Sources
|
|
1196
1197
|
# 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)
|
|
1197
1198
|
# @param [Hash] opts the optional parameters
|
|
1198
|
-
# @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1199
|
-
# @option opts [String] :
|
|
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<br>Allowed field(s)/operator(s):<br>`namespace`: `equals` (string)
|
|
1201
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1200
1202
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
1201
1203
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1202
1204
|
def get_data_sources_with_http_info(opts = {})
|
|
@@ -1221,13 +1223,14 @@ module KlaviyoAPI
|
|
|
1221
1223
|
# query parameters
|
|
1222
1224
|
query_params = opts[:query_params] || {}
|
|
1223
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?
|
|
1224
1227
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
1225
1228
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
1226
1229
|
|
|
1227
1230
|
# header parameters
|
|
1228
1231
|
header_params = opts[:header_params] || {}
|
|
1229
1232
|
# klaviyo api revision
|
|
1230
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1233
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1231
1234
|
# HTTP header 'Accept' (if needed)
|
|
1232
1235
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1233
1236
|
|
|
@@ -1264,7 +1267,7 @@ module KlaviyoAPI
|
|
|
1264
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)
|
|
1265
1268
|
# @param id [String] The ULID ID of the object type.
|
|
1266
1269
|
# @param [Hash] opts the optional parameters
|
|
1267
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1268
1271
|
# @return [Hash<String, Object>]
|
|
1269
1272
|
def get_draft_schema_for_object_type(id, opts = {})
|
|
1270
1273
|
data, _status_code, _headers = get_draft_schema_for_object_type_with_http_info(id, opts)
|
|
@@ -1278,7 +1281,7 @@ module KlaviyoAPI
|
|
|
1278
1281
|
# 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)
|
|
1279
1282
|
# @param id [String] The ULID ID of the object type.
|
|
1280
1283
|
# @param [Hash] opts the optional parameters
|
|
1281
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1282
1285
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1283
1286
|
def get_draft_schema_for_object_type_with_http_info(id, opts = {})
|
|
1284
1287
|
if @api_client.config.debugging
|
|
@@ -1302,7 +1305,7 @@ module KlaviyoAPI
|
|
|
1302
1305
|
# header parameters
|
|
1303
1306
|
header_params = opts[:header_params] || {}
|
|
1304
1307
|
# klaviyo api revision
|
|
1305
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1308
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1306
1309
|
# HTTP header 'Accept' (if needed)
|
|
1307
1310
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1308
1311
|
|
|
@@ -1373,7 +1376,7 @@ module KlaviyoAPI
|
|
|
1373
1376
|
# header parameters
|
|
1374
1377
|
header_params = opts[:header_params] || {}
|
|
1375
1378
|
# klaviyo api revision
|
|
1376
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1379
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1377
1380
|
# HTTP header 'Accept' (if needed)
|
|
1378
1381
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1379
1382
|
|
|
@@ -1413,8 +1416,8 @@ module KlaviyoAPI
|
|
|
1413
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)
|
|
1414
1417
|
# @param id [String] The ULID ID of the object type.
|
|
1415
1418
|
# @param [Hash] opts the optional parameters
|
|
1416
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1417
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1419
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`record_id`: `equals` (string)<br>`status`: `any`, `equals` (allowed values: `'error'`, `'warning'`, `'info'`)<br>`event_type`: `any`, `equals` (allowed values: `'validation_error'`)<br>`timestamp`: `greater-or-equal`, `less-than` (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
|
|
1418
1421
|
# @return [Hash<String, Object>]
|
|
1419
1422
|
def get_ingestion_log_ids_for_object_type(id, opts = {})
|
|
1420
1423
|
data, _status_code, _headers = get_ingestion_log_ids_for_object_type_with_http_info(id, opts)
|
|
@@ -1428,8 +1431,8 @@ module KlaviyoAPI
|
|
|
1428
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.<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)
|
|
1429
1432
|
# @param id [String] The ULID ID of the object type.
|
|
1430
1433
|
# @param [Hash] opts the optional parameters
|
|
1431
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1432
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1434
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`record_id`: `equals` (string)<br>`status`: `any`, `equals` (allowed values: `'error'`, `'warning'`, `'info'`)<br>`event_type`: `any`, `equals` (allowed values: `'validation_error'`)<br>`timestamp`: `greater-or-equal`, `less-than` (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
|
|
1433
1436
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1434
1437
|
def get_ingestion_log_ids_for_object_type_with_http_info(id, opts = {})
|
|
1435
1438
|
if @api_client.config.debugging
|
|
@@ -1450,7 +1453,7 @@ module KlaviyoAPI
|
|
|
1450
1453
|
# header parameters
|
|
1451
1454
|
header_params = opts[:header_params] || {}
|
|
1452
1455
|
# klaviyo api revision
|
|
1453
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1456
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1454
1457
|
# HTTP header 'Accept' (if needed)
|
|
1455
1458
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1456
1459
|
|
|
@@ -1490,12 +1493,12 @@ module KlaviyoAPI
|
|
|
1490
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)
|
|
1491
1494
|
# @param id [String] The ULID ID of the object type.
|
|
1492
1495
|
# @param [Hash] opts the optional parameters
|
|
1493
|
-
# @option opts [Array<String>] :fields_object_ingestion_log For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1494
|
-
# @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1495
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1496
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1497
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1498
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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<br>Allowed field(s)/operator(s):<br>`record_id`: `equals` (string)<br>`status`: `any`, `equals` (allowed values: `'error'`, `'warning'`, `'info'`)<br>`event_type`: `any`, `equals` (allowed values: `'validation_error'`)<br>`timestamp`: `greater-or-equal`, `less-than` (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
|
|
1499
1502
|
# @return [Hash<String, Object>]
|
|
1500
1503
|
def get_ingestion_logs_for_object_type(id, opts = {})
|
|
1501
1504
|
data, _status_code, _headers = get_ingestion_logs_for_object_type_with_http_info(id, opts)
|
|
@@ -1509,12 +1512,12 @@ module KlaviyoAPI
|
|
|
1509
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.<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)
|
|
1510
1513
|
# @param id [String] The ULID ID of the object type.
|
|
1511
1514
|
# @param [Hash] opts the optional parameters
|
|
1512
|
-
# @option opts [Array<String>] :fields_object_ingestion_log For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1513
|
-
# @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1514
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1515
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1516
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1517
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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<br>Allowed field(s)/operator(s):<br>`record_id`: `equals` (string)<br>`status`: `any`, `equals` (allowed values: `'error'`, `'warning'`, `'info'`)<br>`event_type`: `any`, `equals` (allowed values: `'validation_error'`)<br>`timestamp`: `greater-or-equal`, `less-than` (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
|
|
1518
1521
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1519
1522
|
def get_ingestion_logs_for_object_type_with_http_info(id, opts = {})
|
|
1520
1523
|
if @api_client.config.debugging
|
|
@@ -1555,7 +1558,7 @@ module KlaviyoAPI
|
|
|
1555
1558
|
# header parameters
|
|
1556
1559
|
header_params = opts[:header_params] || {}
|
|
1557
1560
|
# klaviyo api revision
|
|
1558
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1561
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1559
1562
|
# HTTP header 'Accept' (if needed)
|
|
1560
1563
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1561
1564
|
|
|
@@ -1595,7 +1598,7 @@ module KlaviyoAPI
|
|
|
1595
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)
|
|
1596
1599
|
# @param id [String] The compound ID of the object record, formatted as object_type_id:::object_record_id
|
|
1597
1600
|
# @param [Hash] opts the optional parameters
|
|
1598
|
-
# @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1599
1602
|
# @return [Hash<String, Object>]
|
|
1600
1603
|
def get_object_record(id, opts = {})
|
|
1601
1604
|
data, _status_code, _headers = get_object_record_with_http_info(id, opts)
|
|
@@ -1606,7 +1609,7 @@ module KlaviyoAPI
|
|
|
1606
1609
|
# 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)
|
|
1607
1610
|
# @param id [String] The compound ID of the object record, formatted as object_type_id:::object_record_id
|
|
1608
1611
|
# @param [Hash] opts the optional parameters
|
|
1609
|
-
# @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1610
1613
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1611
1614
|
def get_object_record_with_http_info(id, opts = {})
|
|
1612
1615
|
if @api_client.config.debugging
|
|
@@ -1630,7 +1633,7 @@ module KlaviyoAPI
|
|
|
1630
1633
|
# header parameters
|
|
1631
1634
|
header_params = opts[:header_params] || {}
|
|
1632
1635
|
# klaviyo api revision
|
|
1633
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1636
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1634
1637
|
# HTTP header 'Accept' (if needed)
|
|
1635
1638
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1636
1639
|
|
|
@@ -1667,10 +1670,10 @@ module KlaviyoAPI
|
|
|
1667
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)
|
|
1668
1671
|
# @param id [String] The ULID ID of the object schema.
|
|
1669
1672
|
# @param [Hash] opts the optional parameters
|
|
1670
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1671
|
-
# @option opts [Array<String>] :fields_profile_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1672
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1673
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1674
1677
|
# @return [Hash<String, Object>]
|
|
1675
1678
|
def get_object_schema(id, opts = {})
|
|
1676
1679
|
data, _status_code, _headers = get_object_schema_with_http_info(id, opts)
|
|
@@ -1681,10 +1684,10 @@ module KlaviyoAPI
|
|
|
1681
1684
|
# 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)
|
|
1682
1685
|
# @param id [String] The ULID ID of the object schema.
|
|
1683
1686
|
# @param [Hash] opts the optional parameters
|
|
1684
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1685
|
-
# @option opts [Array<String>] :fields_profile_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1686
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1687
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1688
1691
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1689
1692
|
def get_object_schema_with_http_info(id, opts = {})
|
|
1690
1693
|
if @api_client.config.debugging
|
|
@@ -1694,11 +1697,11 @@ module KlaviyoAPI
|
|
|
1694
1697
|
if @api_client.config.client_side_validation && id.nil?
|
|
1695
1698
|
fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_schema"
|
|
1696
1699
|
end
|
|
1697
|
-
allowable_values = ["description", "id", "
|
|
1700
|
+
allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
|
|
1698
1701
|
if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
|
|
1699
1702
|
fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
|
|
1700
1703
|
end
|
|
1701
|
-
allowable_values = ["id"
|
|
1704
|
+
allowable_values = ["id"]
|
|
1702
1705
|
if @api_client.config.client_side_validation && opts[:'fields_profile_object_schema'] && !opts[:'fields_profile_object_schema'].all? { |item| allowable_values.include?(item) }
|
|
1703
1706
|
fail ArgumentError, "invalid value for \"fields_profile_object_schema\", must include one of #{allowable_values}"
|
|
1704
1707
|
end
|
|
@@ -1723,7 +1726,7 @@ module KlaviyoAPI
|
|
|
1723
1726
|
# header parameters
|
|
1724
1727
|
header_params = opts[:header_params] || {}
|
|
1725
1728
|
# klaviyo api revision
|
|
1726
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1729
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1727
1730
|
# HTTP header 'Accept' (if needed)
|
|
1728
1731
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1729
1732
|
|
|
@@ -1794,7 +1797,7 @@ module KlaviyoAPI
|
|
|
1794
1797
|
# header parameters
|
|
1795
1798
|
header_params = opts[:header_params] || {}
|
|
1796
1799
|
# klaviyo api revision
|
|
1797
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1800
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1798
1801
|
# HTTP header 'Accept' (if needed)
|
|
1799
1802
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1800
1803
|
|
|
@@ -1837,10 +1840,10 @@ module KlaviyoAPI
|
|
|
1837
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)
|
|
1838
1841
|
# @param id [String] The ULID ID of the object type.
|
|
1839
1842
|
# @param [Hash] opts the optional parameters
|
|
1840
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1841
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1842
|
-
# @option opts [Array<String>] :fields_profile_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1843
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1844
1847
|
# @return [Hash<String, Object>]
|
|
1845
1848
|
def get_object_type(id, opts = {})
|
|
1846
1849
|
data, _status_code, _headers = get_object_type_with_http_info(id, opts)
|
|
@@ -1851,10 +1854,10 @@ module KlaviyoAPI
|
|
|
1851
1854
|
# 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)
|
|
1852
1855
|
# @param id [String] The ULID ID of the object type.
|
|
1853
1856
|
# @param [Hash] opts the optional parameters
|
|
1854
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1855
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1856
|
-
# @option opts [Array<String>] :fields_profile_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1857
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
1858
1861
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1859
1862
|
def get_object_type_with_http_info(id, opts = {})
|
|
1860
1863
|
if @api_client.config.debugging
|
|
@@ -1868,11 +1871,11 @@ module KlaviyoAPI
|
|
|
1868
1871
|
if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
|
|
1869
1872
|
fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
|
|
1870
1873
|
end
|
|
1871
|
-
allowable_values = ["created_at", "description", "id", "
|
|
1874
|
+
allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
|
|
1872
1875
|
if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
|
|
1873
1876
|
fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
|
|
1874
1877
|
end
|
|
1875
|
-
allowable_values = ["id"
|
|
1878
|
+
allowable_values = ["id"]
|
|
1876
1879
|
if @api_client.config.client_side_validation && opts[:'fields_profile_object_type'] && !opts[:'fields_profile_object_type'].all? { |item| allowable_values.include?(item) }
|
|
1877
1880
|
fail ArgumentError, "invalid value for \"fields_profile_object_type\", must include one of #{allowable_values}"
|
|
1878
1881
|
end
|
|
@@ -1893,7 +1896,7 @@ module KlaviyoAPI
|
|
|
1893
1896
|
# header parameters
|
|
1894
1897
|
header_params = opts[:header_params] || {}
|
|
1895
1898
|
# klaviyo api revision
|
|
1896
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1899
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1897
1900
|
# HTTP header 'Accept' (if needed)
|
|
1898
1901
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1899
1902
|
|
|
@@ -1964,7 +1967,7 @@ module KlaviyoAPI
|
|
|
1964
1967
|
# header parameters
|
|
1965
1968
|
header_params = opts[:header_params] || {}
|
|
1966
1969
|
# klaviyo api revision
|
|
1967
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1970
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1968
1971
|
# HTTP header 'Accept' (if needed)
|
|
1969
1972
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1970
1973
|
|
|
@@ -2006,10 +2009,10 @@ module KlaviyoAPI
|
|
|
2006
2009
|
# Get Object Types
|
|
2007
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)
|
|
2008
2011
|
# @param [Hash] opts the optional parameters
|
|
2009
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2010
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2011
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2012
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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<br>Allowed field(s)/operator(s):<br>`namespace`: `equals` (string)
|
|
2015
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2013
2016
|
# @return [Hash<String, Object>]
|
|
2014
2017
|
def get_object_types(opts = {})
|
|
2015
2018
|
data, _status_code, _headers = get_object_types_with_http_info(opts)
|
|
@@ -2019,10 +2022,10 @@ module KlaviyoAPI
|
|
|
2019
2022
|
# Get Object Types
|
|
2020
2023
|
# 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)
|
|
2021
2024
|
# @param [Hash] opts the optional parameters
|
|
2022
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2023
|
-
# @option opts [Array<String>] :fields_object_type For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2024
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2025
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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<br>Allowed field(s)/operator(s):<br>`namespace`: `equals` (string)
|
|
2028
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
2026
2029
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2027
2030
|
def get_object_types_with_http_info(opts = {})
|
|
2028
2031
|
if @api_client.config.debugging
|
|
@@ -2053,7 +2056,7 @@ module KlaviyoAPI
|
|
|
2053
2056
|
# header parameters
|
|
2054
2057
|
header_params = opts[:header_params] || {}
|
|
2055
2058
|
# klaviyo api revision
|
|
2056
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2059
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2057
2060
|
# HTTP header 'Accept' (if needed)
|
|
2058
2061
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2059
2062
|
|
|
@@ -2124,7 +2127,7 @@ module KlaviyoAPI
|
|
|
2124
2127
|
# header parameters
|
|
2125
2128
|
header_params = opts[:header_params] || {}
|
|
2126
2129
|
# klaviyo api revision
|
|
2127
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2128
2131
|
# HTTP header 'Accept' (if needed)
|
|
2129
2132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2130
2133
|
|
|
@@ -2201,7 +2204,7 @@ module KlaviyoAPI
|
|
|
2201
2204
|
# header parameters
|
|
2202
2205
|
header_params = opts[:header_params] || {}
|
|
2203
2206
|
# klaviyo api revision
|
|
2204
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2207
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2205
2208
|
# HTTP header 'Accept' (if needed)
|
|
2206
2209
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2207
2210
|
|
|
@@ -2244,7 +2247,7 @@ module KlaviyoAPI
|
|
|
2244
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)
|
|
2245
2248
|
# @param id [String] The ULID ID of the object type.
|
|
2246
2249
|
# @param [Hash] opts the optional parameters
|
|
2247
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2250
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2248
2251
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2249
2252
|
# @return [Hash<String, Object>]
|
|
2250
2253
|
def get_record_ids_for_object_type(id, opts = {})
|
|
@@ -2259,7 +2262,7 @@ module KlaviyoAPI
|
|
|
2259
2262
|
# 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)
|
|
2260
2263
|
# @param id [String] The ULID ID of the object type.
|
|
2261
2264
|
# @param [Hash] opts the optional parameters
|
|
2262
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2265
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
2263
2266
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2264
2267
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2265
2268
|
def get_record_ids_for_object_type_with_http_info(id, opts = {})
|
|
@@ -2289,7 +2292,7 @@ module KlaviyoAPI
|
|
|
2289
2292
|
# header parameters
|
|
2290
2293
|
header_params = opts[:header_params] || {}
|
|
2291
2294
|
# klaviyo api revision
|
|
2292
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2295
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2293
2296
|
# HTTP header 'Accept' (if needed)
|
|
2294
2297
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2295
2298
|
|
|
@@ -2329,8 +2332,8 @@ module KlaviyoAPI
|
|
|
2329
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)
|
|
2330
2333
|
# @param id [String] The ULID ID of the object type.
|
|
2331
2334
|
# @param [Hash] opts the optional parameters
|
|
2332
|
-
# @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2333
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2334
2337
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2335
2338
|
# @return [Hash<String, Object>]
|
|
2336
2339
|
def get_records_for_object_type(id, opts = {})
|
|
@@ -2345,8 +2348,8 @@ module KlaviyoAPI
|
|
|
2345
2348
|
# 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)
|
|
2346
2349
|
# @param id [String] The ULID ID of the object type.
|
|
2347
2350
|
# @param [Hash] opts the optional parameters
|
|
2348
|
-
# @option opts [Array<String>] :fields_object_record For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2349
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2350
2353
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2351
2354
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2352
2355
|
def get_records_for_object_type_with_http_info(id, opts = {})
|
|
@@ -2381,7 +2384,7 @@ module KlaviyoAPI
|
|
|
2381
2384
|
# header parameters
|
|
2382
2385
|
header_params = opts[:header_params] || {}
|
|
2383
2386
|
# klaviyo api revision
|
|
2384
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2387
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2385
2388
|
# HTTP header 'Accept' (if needed)
|
|
2386
2389
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2387
2390
|
|
|
@@ -2452,7 +2455,7 @@ module KlaviyoAPI
|
|
|
2452
2455
|
# header parameters
|
|
2453
2456
|
header_params = opts[:header_params] || {}
|
|
2454
2457
|
# klaviyo api revision
|
|
2455
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2458
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2456
2459
|
# HTTP header 'Accept' (if needed)
|
|
2457
2460
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2458
2461
|
|
|
@@ -2492,7 +2495,7 @@ module KlaviyoAPI
|
|
|
2492
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)
|
|
2493
2496
|
# @param id [String] The ULID ID of the object type.
|
|
2494
2497
|
# @param [Hash] opts the optional parameters
|
|
2495
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2496
2499
|
# @return [Hash<String, Object>]
|
|
2497
2500
|
def get_schema_versions_for_object_type(id, opts = {})
|
|
2498
2501
|
data, _status_code, _headers = get_schema_versions_for_object_type_with_http_info(id, opts)
|
|
@@ -2506,7 +2509,7 @@ module KlaviyoAPI
|
|
|
2506
2509
|
# 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)
|
|
2507
2510
|
# @param id [String] The ULID ID of the object type.
|
|
2508
2511
|
# @param [Hash] opts the optional parameters
|
|
2509
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2510
2513
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2511
2514
|
def get_schema_versions_for_object_type_with_http_info(id, opts = {})
|
|
2512
2515
|
if @api_client.config.debugging
|
|
@@ -2530,7 +2533,7 @@ module KlaviyoAPI
|
|
|
2530
2533
|
# header parameters
|
|
2531
2534
|
header_params = opts[:header_params] || {}
|
|
2532
2535
|
# klaviyo api revision
|
|
2533
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2536
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2534
2537
|
# HTTP header 'Accept' (if needed)
|
|
2535
2538
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2536
2539
|
|
|
@@ -2570,7 +2573,7 @@ module KlaviyoAPI
|
|
|
2570
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)
|
|
2571
2574
|
# @param id [String] The ID of the source mapping
|
|
2572
2575
|
# @param [Hash] opts the optional parameters
|
|
2573
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2574
2577
|
# @return [Hash<String, Object>]
|
|
2575
2578
|
def get_source_mapping(id, opts = {})
|
|
2576
2579
|
data, _status_code, _headers = get_source_mapping_with_http_info(id, opts)
|
|
@@ -2581,7 +2584,7 @@ module KlaviyoAPI
|
|
|
2581
2584
|
# 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)
|
|
2582
2585
|
# @param id [String] The ID of the source mapping
|
|
2583
2586
|
# @param [Hash] opts the optional parameters
|
|
2584
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2585
2588
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2586
2589
|
def get_source_mapping_with_http_info(id, opts = {})
|
|
2587
2590
|
if @api_client.config.debugging
|
|
@@ -2605,7 +2608,7 @@ module KlaviyoAPI
|
|
|
2605
2608
|
# header parameters
|
|
2606
2609
|
header_params = opts[:header_params] || {}
|
|
2607
2610
|
# klaviyo api revision
|
|
2608
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2611
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2609
2612
|
# HTTP header 'Accept' (if needed)
|
|
2610
2613
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2611
2614
|
|
|
@@ -2642,7 +2645,7 @@ module KlaviyoAPI
|
|
|
2642
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)
|
|
2643
2646
|
# @param id [String] The ULID ID of the object schema.
|
|
2644
2647
|
# @param [Hash] opts the optional parameters
|
|
2645
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2646
2649
|
# @return [Hash<String, Object>]
|
|
2647
2650
|
def get_source_mapping_for_object_schema(id, opts = {})
|
|
2648
2651
|
data, _status_code, _headers = get_source_mapping_for_object_schema_with_http_info(id, opts)
|
|
@@ -2656,7 +2659,7 @@ module KlaviyoAPI
|
|
|
2656
2659
|
# 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)
|
|
2657
2660
|
# @param id [String] The ULID ID of the object schema.
|
|
2658
2661
|
# @param [Hash] opts the optional parameters
|
|
2659
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2660
2663
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2661
2664
|
def get_source_mapping_for_object_schema_with_http_info(id, opts = {})
|
|
2662
2665
|
if @api_client.config.debugging
|
|
@@ -2680,7 +2683,7 @@ module KlaviyoAPI
|
|
|
2680
2683
|
# header parameters
|
|
2681
2684
|
header_params = opts[:header_params] || {}
|
|
2682
2685
|
# klaviyo api revision
|
|
2683
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2686
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2684
2687
|
# HTTP header 'Accept' (if needed)
|
|
2685
2688
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2686
2689
|
|
|
@@ -2751,7 +2754,7 @@ module KlaviyoAPI
|
|
|
2751
2754
|
# header parameters
|
|
2752
2755
|
header_params = opts[:header_params] || {}
|
|
2753
2756
|
# klaviyo api revision
|
|
2754
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2757
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2755
2758
|
# HTTP header 'Accept' (if needed)
|
|
2756
2759
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2757
2760
|
|
|
@@ -2792,7 +2795,7 @@ module KlaviyoAPI
|
|
|
2792
2795
|
# @param id [String] The ULID ID of the object schema.
|
|
2793
2796
|
# @param object_schema_partial_update_query [ObjectSchemaPartialUpdateQuery] Update a object schema by ID
|
|
2794
2797
|
# @param [Hash] opts the optional parameters
|
|
2795
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2796
2799
|
# @return [Hash<String, Object>]
|
|
2797
2800
|
def update_object_schema(id, object_schema_partial_update_query, opts = {})
|
|
2798
2801
|
data, _status_code, _headers = update_object_schema_with_http_info(id, object_schema_partial_update_query, opts)
|
|
@@ -2804,7 +2807,7 @@ module KlaviyoAPI
|
|
|
2804
2807
|
# @param id [String] The ULID ID of the object schema.
|
|
2805
2808
|
# @param object_schema_partial_update_query [ObjectSchemaPartialUpdateQuery] Update a object schema by ID
|
|
2806
2809
|
# @param [Hash] opts the optional parameters
|
|
2807
|
-
# @option opts [Array<String>] :fields_object_schema For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
2808
2811
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2809
2812
|
def update_object_schema_with_http_info(id, object_schema_partial_update_query, opts = {})
|
|
2810
2813
|
if @api_client.config.debugging
|
|
@@ -2832,7 +2835,7 @@ module KlaviyoAPI
|
|
|
2832
2835
|
# header parameters
|
|
2833
2836
|
header_params = opts[:header_params] || {}
|
|
2834
2837
|
# klaviyo api revision
|
|
2835
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2838
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2836
2839
|
# HTTP header 'Accept' (if needed)
|
|
2837
2840
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2838
2841
|
# HTTP header 'Content-Type'
|
|
@@ -2914,7 +2917,7 @@ module KlaviyoAPI
|
|
|
2914
2917
|
# header parameters
|
|
2915
2918
|
header_params = opts[:header_params] || {}
|
|
2916
2919
|
# klaviyo api revision
|
|
2917
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2920
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
2918
2921
|
# HTTP header 'Accept' (if needed)
|
|
2919
2922
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2920
2923
|
# HTTP header 'Content-Type'
|
|
@@ -3002,7 +3005,7 @@ module KlaviyoAPI
|
|
|
3002
3005
|
# header parameters
|
|
3003
3006
|
header_params = opts[:header_params] || {}
|
|
3004
3007
|
# klaviyo api revision
|
|
3005
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3008
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3006
3009
|
# HTTP header 'Accept' (if needed)
|
|
3007
3010
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3008
3011
|
# HTTP header 'Content-Type'
|
|
@@ -3051,7 +3054,7 @@ module KlaviyoAPI
|
|
|
3051
3054
|
# @param id [String] The ULID ID of the source mapping
|
|
3052
3055
|
# @param source_mapping_partial_update_query [SourceMappingPartialUpdateQuery] Update a source mapping by ID
|
|
3053
3056
|
# @param [Hash] opts the optional parameters
|
|
3054
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
3055
3058
|
# @return [Hash<String, Object>]
|
|
3056
3059
|
def update_source_mapping(id, source_mapping_partial_update_query, opts = {})
|
|
3057
3060
|
data, _status_code, _headers = update_source_mapping_with_http_info(id, source_mapping_partial_update_query, opts)
|
|
@@ -3063,7 +3066,7 @@ module KlaviyoAPI
|
|
|
3063
3066
|
# @param id [String] The ULID ID of the source mapping
|
|
3064
3067
|
# @param source_mapping_partial_update_query [SourceMappingPartialUpdateQuery] Update a source mapping by ID
|
|
3065
3068
|
# @param [Hash] opts the optional parameters
|
|
3066
|
-
# @option opts [Array<String>] :fields_source_mapping For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
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
|
|
3067
3070
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
3068
3071
|
def update_source_mapping_with_http_info(id, source_mapping_partial_update_query, opts = {})
|
|
3069
3072
|
if @api_client.config.debugging
|
|
@@ -3091,7 +3094,7 @@ module KlaviyoAPI
|
|
|
3091
3094
|
# header parameters
|
|
3092
3095
|
header_params = opts[:header_params] || {}
|
|
3093
3096
|
# klaviyo api revision
|
|
3094
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3097
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
3095
3098
|
# HTTP header 'Accept' (if needed)
|
|
3096
3099
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
3097
3100
|
# HTTP header 'Content-Type'
|