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
|
@@ -22,7 +22,7 @@ module KlaviyoAPI
|
|
|
22
22
|
# Create a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)
|
|
23
23
|
# @param web_feed_create_query [WebFeedCreateQuery] Create a web feed
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
26
26
|
# @return [Hash<String, Object>]
|
|
27
27
|
def create_web_feed(web_feed_create_query, opts = {})
|
|
28
28
|
data, _status_code, _headers = create_web_feed_with_http_info(web_feed_create_query, opts)
|
|
@@ -33,7 +33,7 @@ module KlaviyoAPI
|
|
|
33
33
|
# Create a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)
|
|
34
34
|
# @param web_feed_create_query [WebFeedCreateQuery] Create a web feed
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
36
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
37
37
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
38
38
|
def create_web_feed_with_http_info(web_feed_create_query, opts = {})
|
|
39
39
|
if @api_client.config.debugging
|
|
@@ -57,7 +57,7 @@ module KlaviyoAPI
|
|
|
57
57
|
# header parameters
|
|
58
58
|
header_params = opts[:header_params] || {}
|
|
59
59
|
# klaviyo api revision
|
|
60
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
61
61
|
# HTTP header 'Accept' (if needed)
|
|
62
62
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
63
63
|
# HTTP header 'Content-Type'
|
|
@@ -127,7 +127,7 @@ module KlaviyoAPI
|
|
|
127
127
|
# header parameters
|
|
128
128
|
header_params = opts[:header_params] || {}
|
|
129
129
|
# klaviyo api revision
|
|
130
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
131
131
|
# HTTP header 'Accept' (if needed)
|
|
132
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
133
133
|
|
|
@@ -164,7 +164,7 @@ module KlaviyoAPI
|
|
|
164
164
|
# Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)
|
|
165
165
|
# @param id [String] The ID of the web feed
|
|
166
166
|
# @param [Hash] opts the optional parameters
|
|
167
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
167
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
168
168
|
# @return [Hash<String, Object>]
|
|
169
169
|
def get_web_feed(id, opts = {})
|
|
170
170
|
data, _status_code, _headers = get_web_feed_with_http_info(id, opts)
|
|
@@ -175,7 +175,7 @@ module KlaviyoAPI
|
|
|
175
175
|
# Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)
|
|
176
176
|
# @param id [String] The ID of the web feed
|
|
177
177
|
# @param [Hash] opts the optional parameters
|
|
178
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
178
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
179
179
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
180
180
|
def get_web_feed_with_http_info(id, opts = {})
|
|
181
181
|
if @api_client.config.debugging
|
|
@@ -199,7 +199,7 @@ module KlaviyoAPI
|
|
|
199
199
|
# header parameters
|
|
200
200
|
header_params = opts[:header_params] || {}
|
|
201
201
|
# klaviyo api revision
|
|
202
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
202
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
203
203
|
# HTTP header 'Accept' (if needed)
|
|
204
204
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
205
205
|
|
|
@@ -235,11 +235,11 @@ module KlaviyoAPI
|
|
|
235
235
|
# Get Web Feeds
|
|
236
236
|
# Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)
|
|
237
237
|
# @param [Hash] opts the optional parameters
|
|
238
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
239
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
240
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
238
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
239
|
+
# @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>`name`: `any`, `contains`, `equals` (string)<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
240
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
241
241
|
# @option opts [Integer] :page_size Default: 5. Min: 1. Max: 20. (default to 5)
|
|
242
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
242
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
243
243
|
# @return [Hash<String, Object>]
|
|
244
244
|
def get_web_feeds(opts = {})
|
|
245
245
|
data, _status_code, _headers = get_web_feeds_with_http_info(opts)
|
|
@@ -249,11 +249,11 @@ module KlaviyoAPI
|
|
|
249
249
|
# Get Web Feeds
|
|
250
250
|
# Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)
|
|
251
251
|
# @param [Hash] opts the optional parameters
|
|
252
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
253
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
254
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
252
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
253
|
+
# @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>`name`: `any`, `contains`, `equals` (string)<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
254
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
255
255
|
# @option opts [Integer] :page_size Default: 5. Min: 1. Max: 20. (default to 5)
|
|
256
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
256
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
257
257
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
258
258
|
def get_web_feeds_with_http_info(opts = {})
|
|
259
259
|
if @api_client.config.debugging
|
|
@@ -289,7 +289,7 @@ module KlaviyoAPI
|
|
|
289
289
|
# header parameters
|
|
290
290
|
header_params = opts[:header_params] || {}
|
|
291
291
|
# klaviyo api revision
|
|
292
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
292
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
293
293
|
# HTTP header 'Accept' (if needed)
|
|
294
294
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
295
295
|
|
|
@@ -327,7 +327,7 @@ module KlaviyoAPI
|
|
|
327
327
|
# @param id [String] The ID of the web feed
|
|
328
328
|
# @param web_feed_partial_update_query [WebFeedPartialUpdateQuery] Update a web feed by ID
|
|
329
329
|
# @param [Hash] opts the optional parameters
|
|
330
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
330
|
+
# @option opts [Array<String>] :fields_web_feed 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 update_web_feed(id, web_feed_partial_update_query, opts = {})
|
|
333
333
|
data, _status_code, _headers = update_web_feed_with_http_info(id, web_feed_partial_update_query, opts)
|
|
@@ -339,7 +339,7 @@ module KlaviyoAPI
|
|
|
339
339
|
# @param id [String] The ID of the web feed
|
|
340
340
|
# @param web_feed_partial_update_query [WebFeedPartialUpdateQuery] Update a web feed by ID
|
|
341
341
|
# @param [Hash] opts the optional parameters
|
|
342
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
342
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
343
343
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
344
344
|
def update_web_feed_with_http_info(id, web_feed_partial_update_query, opts = {})
|
|
345
345
|
if @api_client.config.debugging
|
|
@@ -367,7 +367,7 @@ module KlaviyoAPI
|
|
|
367
367
|
# header parameters
|
|
368
368
|
header_params = opts[:header_params] || {}
|
|
369
369
|
# klaviyo api revision
|
|
370
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
370
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
371
371
|
# HTTP header 'Accept' (if needed)
|
|
372
372
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
373
373
|
# HTTP header 'Content-Type'
|
|
@@ -22,7 +22,7 @@ module KlaviyoAPI
|
|
|
22
22
|
# Create a new Webhook<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_webhook.json)
|
|
23
23
|
# @param webhook_create_query [WebhookCreateQuery]
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
26
26
|
# @return [Hash<String, Object>]
|
|
27
27
|
def create_webhook(webhook_create_query, opts = {})
|
|
28
28
|
data, _status_code, _headers = create_webhook_with_http_info(webhook_create_query, opts)
|
|
@@ -33,7 +33,7 @@ module KlaviyoAPI
|
|
|
33
33
|
# Create a new Webhook<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_webhook.json)
|
|
34
34
|
# @param webhook_create_query [WebhookCreateQuery]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
36
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
37
37
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
38
38
|
def create_webhook_with_http_info(webhook_create_query, opts = {})
|
|
39
39
|
if @api_client.config.debugging
|
|
@@ -57,7 +57,7 @@ module KlaviyoAPI
|
|
|
57
57
|
# header parameters
|
|
58
58
|
header_params = opts[:header_params] || {}
|
|
59
59
|
# klaviyo api revision
|
|
60
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
61
61
|
# HTTP header 'Accept' (if needed)
|
|
62
62
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
63
63
|
# HTTP header 'Content-Type'
|
|
@@ -127,7 +127,7 @@ module KlaviyoAPI
|
|
|
127
127
|
# header parameters
|
|
128
128
|
header_params = opts[:header_params] || {}
|
|
129
129
|
# klaviyo api revision
|
|
130
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
131
131
|
# HTTP header 'Accept' (if needed)
|
|
132
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
133
133
|
|
|
@@ -164,9 +164,9 @@ module KlaviyoAPI
|
|
|
164
164
|
# Get the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook.json)
|
|
165
165
|
# @param id [String] The ID of the webhook.
|
|
166
166
|
# @param [Hash] opts the optional parameters
|
|
167
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
168
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
169
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
167
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
168
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
169
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
170
170
|
# @return [Hash<String, Object>]
|
|
171
171
|
def get_webhook(id, opts = {})
|
|
172
172
|
data, _status_code, _headers = get_webhook_with_http_info(id, opts)
|
|
@@ -177,9 +177,9 @@ module KlaviyoAPI
|
|
|
177
177
|
# Get the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook.json)
|
|
178
178
|
# @param id [String] The ID of the webhook.
|
|
179
179
|
# @param [Hash] opts the optional parameters
|
|
180
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
181
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
182
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
180
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
181
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
182
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
183
183
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
184
184
|
def get_webhook_with_http_info(id, opts = {})
|
|
185
185
|
if @api_client.config.debugging
|
|
@@ -213,7 +213,7 @@ module KlaviyoAPI
|
|
|
213
213
|
# header parameters
|
|
214
214
|
header_params = opts[:header_params] || {}
|
|
215
215
|
# klaviyo api revision
|
|
216
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
216
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
217
217
|
# HTTP header 'Accept' (if needed)
|
|
218
218
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
219
219
|
|
|
@@ -250,7 +250,7 @@ module KlaviyoAPI
|
|
|
250
250
|
# Get the webhook topic with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topic.json)
|
|
251
251
|
# @param id [String] The ID of the webhook topic.
|
|
252
252
|
# @param [Hash] opts the optional parameters
|
|
253
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
253
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
254
254
|
# @return [Hash<String, Object>]
|
|
255
255
|
def get_webhook_topic(id, opts = {})
|
|
256
256
|
data, _status_code, _headers = get_webhook_topic_with_http_info(id, opts)
|
|
@@ -261,7 +261,7 @@ module KlaviyoAPI
|
|
|
261
261
|
# Get the webhook topic with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topic.json)
|
|
262
262
|
# @param id [String] The ID of the webhook topic.
|
|
263
263
|
# @param [Hash] opts the optional parameters
|
|
264
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
264
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
265
265
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
266
266
|
def get_webhook_topic_with_http_info(id, opts = {})
|
|
267
267
|
if @api_client.config.debugging
|
|
@@ -285,7 +285,7 @@ module KlaviyoAPI
|
|
|
285
285
|
# header parameters
|
|
286
286
|
header_params = opts[:header_params] || {}
|
|
287
287
|
# klaviyo api revision
|
|
288
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
288
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
289
289
|
# HTTP header 'Accept' (if needed)
|
|
290
290
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
291
291
|
|
|
@@ -321,7 +321,7 @@ module KlaviyoAPI
|
|
|
321
321
|
# Get Webhook Topics
|
|
322
322
|
# Get all webhook topics in a Klaviyo account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topics.json)
|
|
323
323
|
# @param [Hash] opts the optional parameters
|
|
324
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
324
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
325
325
|
# @return [Hash<String, Object>]
|
|
326
326
|
def get_webhook_topics(opts = {})
|
|
327
327
|
data, _status_code, _headers = get_webhook_topics_with_http_info(opts)
|
|
@@ -331,7 +331,7 @@ module KlaviyoAPI
|
|
|
331
331
|
# Get Webhook Topics
|
|
332
332
|
# Get all webhook topics in a Klaviyo account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topics.json)
|
|
333
333
|
# @param [Hash] opts the optional parameters
|
|
334
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
334
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
335
335
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
336
336
|
def get_webhook_topics_with_http_info(opts = {})
|
|
337
337
|
if @api_client.config.debugging
|
|
@@ -351,7 +351,7 @@ module KlaviyoAPI
|
|
|
351
351
|
# header parameters
|
|
352
352
|
header_params = opts[:header_params] || {}
|
|
353
353
|
# klaviyo api revision
|
|
354
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
354
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
355
355
|
# HTTP header 'Accept' (if needed)
|
|
356
356
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
357
357
|
|
|
@@ -387,9 +387,9 @@ module KlaviyoAPI
|
|
|
387
387
|
# Get Webhooks
|
|
388
388
|
# Get all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhooks.json)
|
|
389
389
|
# @param [Hash] opts the optional parameters
|
|
390
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
391
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
392
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
390
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
391
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
392
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
393
393
|
# @return [Hash<String, Object>]
|
|
394
394
|
def get_webhooks(opts = {})
|
|
395
395
|
data, _status_code, _headers = get_webhooks_with_http_info(opts)
|
|
@@ -399,9 +399,9 @@ module KlaviyoAPI
|
|
|
399
399
|
# Get Webhooks
|
|
400
400
|
# Get all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhooks.json)
|
|
401
401
|
# @param [Hash] opts the optional parameters
|
|
402
|
-
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
403
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
404
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
402
|
+
# @option opts [Array<String>] :fields_webhook_topic For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
403
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
404
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
405
405
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
406
406
|
def get_webhooks_with_http_info(opts = {})
|
|
407
407
|
if @api_client.config.debugging
|
|
@@ -431,7 +431,7 @@ module KlaviyoAPI
|
|
|
431
431
|
# header parameters
|
|
432
432
|
header_params = opts[:header_params] || {}
|
|
433
433
|
# klaviyo api revision
|
|
434
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
434
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
435
435
|
# HTTP header 'Accept' (if needed)
|
|
436
436
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
437
437
|
|
|
@@ -469,7 +469,7 @@ module KlaviyoAPI
|
|
|
469
469
|
# @param id [String] The ID of the webhook.
|
|
470
470
|
# @param webhook_partial_update_query [WebhookPartialUpdateQuery]
|
|
471
471
|
# @param [Hash] opts the optional parameters
|
|
472
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
472
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
473
473
|
# @return [Hash<String, Object>]
|
|
474
474
|
def update_webhook(id, webhook_partial_update_query, opts = {})
|
|
475
475
|
data, _status_code, _headers = update_webhook_with_http_info(id, webhook_partial_update_query, opts)
|
|
@@ -481,7 +481,7 @@ module KlaviyoAPI
|
|
|
481
481
|
# @param id [String] The ID of the webhook.
|
|
482
482
|
# @param webhook_partial_update_query [WebhookPartialUpdateQuery]
|
|
483
483
|
# @param [Hash] opts the optional parameters
|
|
484
|
-
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
484
|
+
# @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
485
485
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
486
486
|
def update_webhook_with_http_info(id, webhook_partial_update_query, opts = {})
|
|
487
487
|
if @api_client.config.debugging
|
|
@@ -509,7 +509,7 @@ module KlaviyoAPI
|
|
|
509
509
|
# header parameters
|
|
510
510
|
header_params = opts[:header_params] || {}
|
|
511
511
|
# klaviyo api revision
|
|
512
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
512
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
513
513
|
# HTTP header 'Accept' (if needed)
|
|
514
514
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
515
515
|
# HTTP header 'Content-Type'
|
|
@@ -31,7 +31,7 @@ module KlaviyoAPI
|
|
|
31
31
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
32
32
|
def initialize(config = Configuration.default)
|
|
33
33
|
@config = config
|
|
34
|
-
@user_agent = "klaviyo-api-ruby/
|
|
34
|
+
@user_agent = "klaviyo-api-ruby/19.0.0"
|
|
35
35
|
@default_headers = {
|
|
36
36
|
'Content-Type' => 'application/json',
|
|
37
37
|
'User-Agent' => @user_agent
|
|
@@ -13,9 +13,11 @@ require 'date'
|
|
|
13
13
|
require 'time'
|
|
14
14
|
|
|
15
15
|
module KlaviyoAPI
|
|
16
|
-
class
|
|
16
|
+
class AbTestActionLinkOnly
|
|
17
17
|
attr_accessor :type
|
|
18
18
|
|
|
19
|
+
attr_accessor :links
|
|
20
|
+
|
|
19
21
|
class EnumAttributeValidator
|
|
20
22
|
attr_reader :datatype
|
|
21
23
|
attr_reader :allowable_values
|
|
@@ -41,7 +43,8 @@ module KlaviyoAPI
|
|
|
41
43
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
42
44
|
def self.attribute_map
|
|
43
45
|
{
|
|
44
|
-
:'type' => :'type'
|
|
46
|
+
:'type' => :'type',
|
|
47
|
+
:'links' => :'links'
|
|
45
48
|
}
|
|
46
49
|
end
|
|
47
50
|
|
|
@@ -53,7 +56,8 @@ module KlaviyoAPI
|
|
|
53
56
|
# Attribute type mapping.
|
|
54
57
|
def self.openapi_types
|
|
55
58
|
{
|
|
56
|
-
:'type' => :'String'
|
|
59
|
+
:'type' => :'String',
|
|
60
|
+
:'links' => :'Link'
|
|
57
61
|
}
|
|
58
62
|
end
|
|
59
63
|
|
|
@@ -67,13 +71,13 @@ module KlaviyoAPI
|
|
|
67
71
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
68
72
|
def initialize(attributes = {})
|
|
69
73
|
if (!attributes.is_a?(Hash))
|
|
70
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::
|
|
74
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::AbTestActionLinkOnly` initialize method"
|
|
71
75
|
end
|
|
72
76
|
|
|
73
77
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
74
78
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
75
79
|
if (!self.class.attribute_map.key?(k.to_sym))
|
|
76
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::
|
|
80
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::AbTestActionLinkOnly`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
77
81
|
end
|
|
78
82
|
h[k.to_sym] = v
|
|
79
83
|
}
|
|
@@ -81,6 +85,10 @@ module KlaviyoAPI
|
|
|
81
85
|
if attributes.key?(:'type')
|
|
82
86
|
self.type = attributes[:'type']
|
|
83
87
|
end
|
|
88
|
+
|
|
89
|
+
if attributes.key?(:'links')
|
|
90
|
+
self.links = attributes[:'links']
|
|
91
|
+
end
|
|
84
92
|
end
|
|
85
93
|
|
|
86
94
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -91,6 +99,10 @@ module KlaviyoAPI
|
|
|
91
99
|
invalid_properties.push('invalid value for "type", type cannot be nil.')
|
|
92
100
|
end
|
|
93
101
|
|
|
102
|
+
if @links.nil?
|
|
103
|
+
invalid_properties.push('invalid value for "links", links cannot be nil.')
|
|
104
|
+
end
|
|
105
|
+
|
|
94
106
|
invalid_properties
|
|
95
107
|
end
|
|
96
108
|
|
|
@@ -98,15 +110,16 @@ module KlaviyoAPI
|
|
|
98
110
|
# @return true if the model is valid
|
|
99
111
|
def valid?
|
|
100
112
|
return false if @type.nil?
|
|
101
|
-
type_validator = EnumAttributeValidator.new('String', ["
|
|
113
|
+
type_validator = EnumAttributeValidator.new('String', ["ab-test"])
|
|
102
114
|
return false unless type_validator.valid?(@type)
|
|
115
|
+
return false if @links.nil?
|
|
103
116
|
true
|
|
104
117
|
end
|
|
105
118
|
|
|
106
119
|
# Custom attribute writer method checking allowed values (enum).
|
|
107
120
|
# @param [Object] type Object to be assigned
|
|
108
121
|
def type=(type)
|
|
109
|
-
validator = EnumAttributeValidator.new('String', ["
|
|
122
|
+
validator = EnumAttributeValidator.new('String', ["ab-test"])
|
|
110
123
|
unless validator.valid?(type)
|
|
111
124
|
fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
|
|
112
125
|
end
|
|
@@ -118,7 +131,8 @@ module KlaviyoAPI
|
|
|
118
131
|
def ==(o)
|
|
119
132
|
return true if self.equal?(o)
|
|
120
133
|
self.class == o.class &&
|
|
121
|
-
type == o.type
|
|
134
|
+
type == o.type &&
|
|
135
|
+
links == o.links
|
|
122
136
|
end
|
|
123
137
|
|
|
124
138
|
# @see the `==` method
|
|
@@ -130,7 +144,7 @@ module KlaviyoAPI
|
|
|
130
144
|
# Calculates hash code according to all attributes.
|
|
131
145
|
# @return [Integer] Hash code
|
|
132
146
|
def hash
|
|
133
|
-
[type].hash
|
|
147
|
+
[type, links].hash
|
|
134
148
|
end
|
|
135
149
|
|
|
136
150
|
# Builds the object from hash
|
|
@@ -13,12 +13,15 @@ require 'date'
|
|
|
13
13
|
require 'time'
|
|
14
14
|
|
|
15
15
|
module KlaviyoAPI
|
|
16
|
-
class
|
|
17
|
-
|
|
16
|
+
class ABTestSettings
|
|
17
|
+
# The metric used to pick the winning variation.
|
|
18
|
+
attr_accessor :winner_metric
|
|
18
19
|
|
|
19
|
-
|
|
20
|
+
# The percentage of the audience that receives the winning variation. The remainder is split evenly across the variations under test.
|
|
21
|
+
attr_accessor :winner_percentage
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
# How long to collect results before picking a winner, in hours.
|
|
24
|
+
attr_accessor :winner_wait_hours
|
|
22
25
|
|
|
23
26
|
class EnumAttributeValidator
|
|
24
27
|
attr_reader :datatype
|
|
@@ -45,9 +48,9 @@ module KlaviyoAPI
|
|
|
45
48
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
46
49
|
def self.attribute_map
|
|
47
50
|
{
|
|
48
|
-
:'
|
|
49
|
-
:'
|
|
50
|
-
:'
|
|
51
|
+
:'winner_metric' => :'winner_metric',
|
|
52
|
+
:'winner_percentage' => :'winner_percentage',
|
|
53
|
+
:'winner_wait_hours' => :'winner_wait_hours'
|
|
51
54
|
}
|
|
52
55
|
end
|
|
53
56
|
|
|
@@ -59,15 +62,18 @@ module KlaviyoAPI
|
|
|
59
62
|
# Attribute type mapping.
|
|
60
63
|
def self.openapi_types
|
|
61
64
|
{
|
|
62
|
-
:'
|
|
63
|
-
:'
|
|
64
|
-
:'
|
|
65
|
+
:'winner_metric' => :'String',
|
|
66
|
+
:'winner_percentage' => :'Integer',
|
|
67
|
+
:'winner_wait_hours' => :'Integer'
|
|
65
68
|
}
|
|
66
69
|
end
|
|
67
70
|
|
|
68
71
|
# List of attributes with nullable: true
|
|
69
72
|
def self.openapi_nullable
|
|
70
73
|
Set.new([
|
|
74
|
+
:'winner_metric',
|
|
75
|
+
:'winner_percentage',
|
|
76
|
+
:'winner_wait_hours'
|
|
71
77
|
])
|
|
72
78
|
end
|
|
73
79
|
|
|
@@ -75,27 +81,27 @@ module KlaviyoAPI
|
|
|
75
81
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
76
82
|
def initialize(attributes = {})
|
|
77
83
|
if (!attributes.is_a?(Hash))
|
|
78
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::
|
|
84
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ABTestSettings` initialize method"
|
|
79
85
|
end
|
|
80
86
|
|
|
81
87
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
82
88
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
83
89
|
if (!self.class.attribute_map.key?(k.to_sym))
|
|
84
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::
|
|
90
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::ABTestSettings`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
85
91
|
end
|
|
86
92
|
h[k.to_sym] = v
|
|
87
93
|
}
|
|
88
94
|
|
|
89
|
-
if attributes.key?(:'
|
|
90
|
-
self.
|
|
95
|
+
if attributes.key?(:'winner_metric')
|
|
96
|
+
self.winner_metric = attributes[:'winner_metric']
|
|
91
97
|
end
|
|
92
98
|
|
|
93
|
-
if attributes.key?(:'
|
|
94
|
-
self.
|
|
99
|
+
if attributes.key?(:'winner_percentage')
|
|
100
|
+
self.winner_percentage = attributes[:'winner_percentage']
|
|
95
101
|
end
|
|
96
102
|
|
|
97
|
-
if attributes.key?(:'
|
|
98
|
-
self.
|
|
103
|
+
if attributes.key?(:'winner_wait_hours')
|
|
104
|
+
self.winner_wait_hours = attributes[:'winner_wait_hours']
|
|
99
105
|
end
|
|
100
106
|
end
|
|
101
107
|
|
|
@@ -103,30 +109,25 @@ module KlaviyoAPI
|
|
|
103
109
|
# @return Array for valid properties with the reasons
|
|
104
110
|
def list_invalid_properties
|
|
105
111
|
invalid_properties = Array.new
|
|
106
|
-
if @channel.nil?
|
|
107
|
-
invalid_properties.push('invalid value for "channel", channel cannot be nil.')
|
|
108
|
-
end
|
|
109
|
-
|
|
110
112
|
invalid_properties
|
|
111
113
|
end
|
|
112
114
|
|
|
113
115
|
# Check to see if the all the properties in the model are valid
|
|
114
116
|
# @return true if the model is valid
|
|
115
117
|
def valid?
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
return false unless channel_validator.valid?(@channel)
|
|
118
|
+
winner_metric_validator = EnumAttributeValidator.new('String', ["clicks_unique", "opens_unique", "placed_orders_unique"])
|
|
119
|
+
return false unless winner_metric_validator.valid?(@winner_metric)
|
|
119
120
|
true
|
|
120
121
|
end
|
|
121
122
|
|
|
122
123
|
# Custom attribute writer method checking allowed values (enum).
|
|
123
|
-
# @param [Object]
|
|
124
|
-
def
|
|
125
|
-
validator = EnumAttributeValidator.new('String', ["
|
|
126
|
-
unless validator.valid?(
|
|
127
|
-
fail ArgumentError, "invalid value for \"
|
|
124
|
+
# @param [Object] winner_metric Object to be assigned
|
|
125
|
+
def winner_metric=(winner_metric)
|
|
126
|
+
validator = EnumAttributeValidator.new('String', ["clicks_unique", "opens_unique", "placed_orders_unique"])
|
|
127
|
+
unless validator.valid?(winner_metric)
|
|
128
|
+
fail ArgumentError, "invalid value for \"winner_metric\", must be one of #{validator.allowable_values}."
|
|
128
129
|
end
|
|
129
|
-
@
|
|
130
|
+
@winner_metric = winner_metric
|
|
130
131
|
end
|
|
131
132
|
|
|
132
133
|
# Checks equality by comparing each attribute.
|
|
@@ -134,9 +135,9 @@ module KlaviyoAPI
|
|
|
134
135
|
def ==(o)
|
|
135
136
|
return true if self.equal?(o)
|
|
136
137
|
self.class == o.class &&
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
138
|
+
winner_metric == o.winner_metric &&
|
|
139
|
+
winner_percentage == o.winner_percentage &&
|
|
140
|
+
winner_wait_hours == o.winner_wait_hours
|
|
140
141
|
end
|
|
141
142
|
|
|
142
143
|
# @see the `==` method
|
|
@@ -148,7 +149,7 @@ module KlaviyoAPI
|
|
|
148
149
|
# Calculates hash code according to all attributes.
|
|
149
150
|
# @return [Integer] Hash code
|
|
150
151
|
def hash
|
|
151
|
-
[
|
|
152
|
+
[winner_metric, winner_percentage, winner_wait_hours].hash
|
|
152
153
|
end
|
|
153
154
|
|
|
154
155
|
# Builds the object from hash
|