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 new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)
|
|
23
23
|
# @param form_create_query [FormCreateQuery] Creates a Form from parameters
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_form 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_form(form_create_query, opts = {})
|
|
28
28
|
data, _status_code, _headers = create_form_with_http_info(form_create_query, opts)
|
|
@@ -33,7 +33,7 @@ module KlaviyoAPI
|
|
|
33
33
|
# Create a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)
|
|
34
34
|
# @param form_create_query [FormCreateQuery] Creates a Form from parameters
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
36
|
+
# @option opts [Array<String>] :fields_form 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_form_with_http_info(form_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 form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)
|
|
165
165
|
# @param id [String] The ID of the form
|
|
166
166
|
# @param [Hash] opts the optional parameters
|
|
167
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
167
|
+
# @option opts [Array<String>] :fields_form 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_form(id, opts = {})
|
|
170
170
|
data, _status_code, _headers = get_form_with_http_info(id, opts)
|
|
@@ -175,7 +175,7 @@ module KlaviyoAPI
|
|
|
175
175
|
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)
|
|
176
176
|
# @param id [String] The ID of the form
|
|
177
177
|
# @param [Hash] opts the optional parameters
|
|
178
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
178
|
+
# @option opts [Array<String>] :fields_form 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_form_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
|
|
|
@@ -236,7 +236,7 @@ module KlaviyoAPI
|
|
|
236
236
|
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)
|
|
237
237
|
# @param id [String] The ID of the form version
|
|
238
238
|
# @param [Hash] opts the optional parameters
|
|
239
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
239
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
240
240
|
# @return [Hash<String, Object>]
|
|
241
241
|
def get_form_for_form_version(id, opts = {})
|
|
242
242
|
data, _status_code, _headers = get_form_for_form_version_with_http_info(id, opts)
|
|
@@ -250,7 +250,7 @@ module KlaviyoAPI
|
|
|
250
250
|
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)
|
|
251
251
|
# @param id [String] The ID of the form version
|
|
252
252
|
# @param [Hash] opts the optional parameters
|
|
253
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
253
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
254
254
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
255
255
|
def get_form_for_form_version_with_http_info(id, opts = {})
|
|
256
256
|
if @api_client.config.debugging
|
|
@@ -274,7 +274,7 @@ module KlaviyoAPI
|
|
|
274
274
|
# header parameters
|
|
275
275
|
header_params = opts[:header_params] || {}
|
|
276
276
|
# klaviyo api revision
|
|
277
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
277
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
278
278
|
# HTTP header 'Accept' (if needed)
|
|
279
279
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
280
280
|
|
|
@@ -345,7 +345,7 @@ module KlaviyoAPI
|
|
|
345
345
|
# header parameters
|
|
346
346
|
header_params = opts[:header_params] || {}
|
|
347
347
|
# klaviyo api revision
|
|
348
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
348
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
349
349
|
# HTTP header 'Accept' (if needed)
|
|
350
350
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
351
351
|
|
|
@@ -385,9 +385,9 @@ module KlaviyoAPI
|
|
|
385
385
|
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)
|
|
386
386
|
# @param id [String] The ID of the form version
|
|
387
387
|
# @param [Hash] opts the optional parameters
|
|
388
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
389
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
390
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
388
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
389
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
390
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
391
391
|
# @return [Hash<String, Object>]
|
|
392
392
|
def get_form_version(id, opts = {})
|
|
393
393
|
data, _status_code, _headers = get_form_version_with_http_info(id, opts)
|
|
@@ -398,9 +398,9 @@ module KlaviyoAPI
|
|
|
398
398
|
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)
|
|
399
399
|
# @param id [String] The ID of the form version
|
|
400
400
|
# @param [Hash] opts the optional parameters
|
|
401
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
402
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
403
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
401
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
402
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
403
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
404
404
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
405
405
|
def get_form_version_with_http_info(id, opts = {})
|
|
406
406
|
if @api_client.config.debugging
|
|
@@ -434,7 +434,7 @@ module KlaviyoAPI
|
|
|
434
434
|
# header parameters
|
|
435
435
|
header_params = opts[:header_params] || {}
|
|
436
436
|
# klaviyo api revision
|
|
437
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
437
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
438
438
|
# HTTP header 'Accept' (if needed)
|
|
439
439
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
440
440
|
|
|
@@ -470,11 +470,11 @@ module KlaviyoAPI
|
|
|
470
470
|
# Get Forms
|
|
471
471
|
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)
|
|
472
472
|
# @param [Hash] opts the optional parameters
|
|
473
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
474
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
475
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
473
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
474
|
+
# @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>`id`: `any`, `equals` (string)<br>`name`: `any`, `contains`, `equals` (string)<br>`ab_test`: `equals` (boolean)<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'live'`, `'draft'`)
|
|
475
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
476
476
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
477
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
477
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
478
478
|
# @return [Hash<String, Object>]
|
|
479
479
|
def get_forms(opts = {})
|
|
480
480
|
data, _status_code, _headers = get_forms_with_http_info(opts)
|
|
@@ -484,11 +484,11 @@ module KlaviyoAPI
|
|
|
484
484
|
# Get Forms
|
|
485
485
|
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)
|
|
486
486
|
# @param [Hash] opts the optional parameters
|
|
487
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
488
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
489
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
487
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
488
|
+
# @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>`id`: `any`, `equals` (string)<br>`name`: `any`, `contains`, `equals` (string)<br>`ab_test`: `equals` (boolean)<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`status`: `equals` (allowed values: `'live'`, `'draft'`)
|
|
489
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
490
490
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
491
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
491
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
492
492
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
493
493
|
def get_forms_with_http_info(opts = {})
|
|
494
494
|
if @api_client.config.debugging
|
|
@@ -524,7 +524,7 @@ module KlaviyoAPI
|
|
|
524
524
|
# header parameters
|
|
525
525
|
header_params = opts[:header_params] || {}
|
|
526
526
|
# klaviyo api revision
|
|
527
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
527
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
528
528
|
# HTTP header 'Accept' (if needed)
|
|
529
529
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
530
530
|
|
|
@@ -561,10 +561,10 @@ module KlaviyoAPI
|
|
|
561
561
|
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)
|
|
562
562
|
# @param id [String] The ID of the form
|
|
563
563
|
# @param [Hash] opts the optional parameters
|
|
564
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
565
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
564
|
+
# @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>`form_type`: `any`, `equals` (allowed values: `'popup'`, `'embed'`, `'full_page'`, `'flyout'`, `'banner'`)<br>`status`: `equals` (allowed values: `'live'`, `'draft'`)<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
565
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
566
566
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
567
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
567
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
568
568
|
# @return [Hash<String, Object>]
|
|
569
569
|
def get_version_ids_for_form(id, opts = {})
|
|
570
570
|
data, _status_code, _headers = get_version_ids_for_form_with_http_info(id, opts)
|
|
@@ -581,10 +581,10 @@ module KlaviyoAPI
|
|
|
581
581
|
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)
|
|
582
582
|
# @param id [String] The ID of the form
|
|
583
583
|
# @param [Hash] opts the optional parameters
|
|
584
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
585
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
584
|
+
# @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>`form_type`: `any`, `equals` (allowed values: `'popup'`, `'embed'`, `'full_page'`, `'flyout'`, `'banner'`)<br>`status`: `equals` (allowed values: `'live'`, `'draft'`)<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
585
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
586
586
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
587
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
587
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
588
588
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
589
589
|
def get_version_ids_for_form_with_http_info(id, opts = {})
|
|
590
590
|
if @api_client.config.debugging
|
|
@@ -615,7 +615,7 @@ module KlaviyoAPI
|
|
|
615
615
|
# header parameters
|
|
616
616
|
header_params = opts[:header_params] || {}
|
|
617
617
|
# klaviyo api revision
|
|
618
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
618
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
619
619
|
# HTTP header 'Accept' (if needed)
|
|
620
620
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
621
621
|
|
|
@@ -658,11 +658,11 @@ module KlaviyoAPI
|
|
|
658
658
|
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)
|
|
659
659
|
# @param id [String] The ID of the form
|
|
660
660
|
# @param [Hash] opts the optional parameters
|
|
661
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
662
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
663
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
661
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
662
|
+
# @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>`form_type`: `any`, `equals` (allowed values: `'popup'`, `'embed'`, `'full_page'`, `'flyout'`, `'banner'`)<br>`status`: `equals` (allowed values: `'live'`, `'draft'`)<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
663
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
664
664
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
665
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
665
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
666
666
|
# @return [Hash<String, Object>]
|
|
667
667
|
def get_versions_for_form(id, opts = {})
|
|
668
668
|
data, _status_code, _headers = get_versions_for_form_with_http_info(id, opts)
|
|
@@ -679,11 +679,11 @@ module KlaviyoAPI
|
|
|
679
679
|
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)
|
|
680
680
|
# @param id [String] The ID of the form
|
|
681
681
|
# @param [Hash] opts the optional parameters
|
|
682
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
683
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
684
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
682
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
683
|
+
# @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>`form_type`: `any`, `equals` (allowed values: `'popup'`, `'embed'`, `'full_page'`, `'flyout'`, `'banner'`)<br>`status`: `equals` (allowed values: `'live'`, `'draft'`)<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
684
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
685
685
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
686
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
686
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
687
687
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
688
688
|
def get_versions_for_form_with_http_info(id, opts = {})
|
|
689
689
|
if @api_client.config.debugging
|
|
@@ -719,7 +719,7 @@ module KlaviyoAPI
|
|
|
719
719
|
# header parameters
|
|
720
720
|
header_params = opts[:header_params] || {}
|
|
721
721
|
# klaviyo api revision
|
|
722
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
722
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
723
723
|
# HTTP header 'Accept' (if needed)
|
|
724
724
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
725
725
|
|
|
@@ -757,5 +757,254 @@ module KlaviyoAPI
|
|
|
757
757
|
|
|
758
758
|
# alias of `get_versions_for_form_with_http_info`
|
|
759
759
|
alias get_form_versions_with_http_info get_versions_for_form_with_http_info
|
|
760
|
+
|
|
761
|
+
# Publish Form
|
|
762
|
+
# Publish the draft version of a form. The publish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a draft A/B test are not supported and must be published from the form editor.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/publish_form.json)
|
|
763
|
+
# @param form_publish_job_create_query [FormPublishJobCreateQuery] Publish the draft version of a form.
|
|
764
|
+
# @param [Hash] opts the optional parameters
|
|
765
|
+
# @option opts [Array<String>] :fields_form_publish_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
766
|
+
# @return [Hash<String, Object>]
|
|
767
|
+
def publish_form(form_publish_job_create_query, opts = {})
|
|
768
|
+
data, _status_code, _headers = publish_form_with_http_info(form_publish_job_create_query, opts)
|
|
769
|
+
data
|
|
770
|
+
end
|
|
771
|
+
|
|
772
|
+
# alias of `publish_form`
|
|
773
|
+
alias create_form_publish_job publish_form
|
|
774
|
+
|
|
775
|
+
# Publish Form
|
|
776
|
+
# Publish the draft version of a form. The publish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a draft A/B test are not supported and must be published from the form editor.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/publish_form.json)
|
|
777
|
+
# @param form_publish_job_create_query [FormPublishJobCreateQuery] Publish the draft version of a form.
|
|
778
|
+
# @param [Hash] opts the optional parameters
|
|
779
|
+
# @option opts [Array<String>] :fields_form_publish_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
780
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
781
|
+
def publish_form_with_http_info(form_publish_job_create_query, opts = {})
|
|
782
|
+
if @api_client.config.debugging
|
|
783
|
+
@api_client.config.logger.debug 'Calling API: FormsApi.publish_form ...'
|
|
784
|
+
end
|
|
785
|
+
# verify the required parameter 'form_publish_job_create_query' is set
|
|
786
|
+
if @api_client.config.client_side_validation && form_publish_job_create_query.nil?
|
|
787
|
+
fail ArgumentError, "Missing the required parameter 'form_publish_job_create_query' when calling FormsApi.publish_form"
|
|
788
|
+
end
|
|
789
|
+
allowable_values = ["created_at", "id", "status"]
|
|
790
|
+
if @api_client.config.client_side_validation && opts[:'fields_form_publish_job'] && !opts[:'fields_form_publish_job'].all? { |item| allowable_values.include?(item) }
|
|
791
|
+
fail ArgumentError, "invalid value for \"fields_form_publish_job\", must include one of #{allowable_values}"
|
|
792
|
+
end
|
|
793
|
+
# resource path
|
|
794
|
+
local_var_path = '/api/form-publish-jobs'
|
|
795
|
+
|
|
796
|
+
# query parameters
|
|
797
|
+
query_params = opts[:query_params] || {}
|
|
798
|
+
query_params[:'fields[form-publish-job]'] = @api_client.build_collection_param(opts[:'fields_form_publish_job'], :csv) if !opts[:'fields_form_publish_job'].nil?
|
|
799
|
+
|
|
800
|
+
# header parameters
|
|
801
|
+
header_params = opts[:header_params] || {}
|
|
802
|
+
# klaviyo api revision
|
|
803
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
804
|
+
# HTTP header 'Accept' (if needed)
|
|
805
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
806
|
+
# HTTP header 'Content-Type'
|
|
807
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
808
|
+
if !content_type.nil?
|
|
809
|
+
header_params['Content-Type'] = content_type
|
|
810
|
+
end
|
|
811
|
+
|
|
812
|
+
# form parameters
|
|
813
|
+
form_params = opts[:form_params] || {}
|
|
814
|
+
|
|
815
|
+
# http body (model)
|
|
816
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(form_publish_job_create_query)
|
|
817
|
+
|
|
818
|
+
# return_type
|
|
819
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
820
|
+
|
|
821
|
+
# auth_names
|
|
822
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
823
|
+
|
|
824
|
+
new_options = opts.merge(
|
|
825
|
+
:operation => :"FormsApi.publish_form",
|
|
826
|
+
:header_params => header_params,
|
|
827
|
+
:query_params => query_params,
|
|
828
|
+
:form_params => form_params,
|
|
829
|
+
:body => post_body,
|
|
830
|
+
:auth_names => auth_names,
|
|
831
|
+
:return_type => return_type
|
|
832
|
+
)
|
|
833
|
+
|
|
834
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
835
|
+
if @api_client.config.debugging
|
|
836
|
+
@api_client.config.logger.debug "API called: FormsApi#publish_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
837
|
+
end
|
|
838
|
+
return data, status_code, headers
|
|
839
|
+
end
|
|
840
|
+
|
|
841
|
+
# alias of `publish_form_with_http_info`
|
|
842
|
+
alias create_form_publish_job_with_http_info publish_form_with_http_info
|
|
843
|
+
|
|
844
|
+
# Unpublish Form
|
|
845
|
+
# Unpublish the live version of a form. The unpublish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a live A/B test are not supported and must be unpublished from the form editor.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unpublish_form.json)
|
|
846
|
+
# @param form_unpublish_job_create_query [FormUnpublishJobCreateQuery] Unpublish the live version of a form.
|
|
847
|
+
# @param [Hash] opts the optional parameters
|
|
848
|
+
# @option opts [Array<String>] :fields_form_unpublish_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
849
|
+
# @return [Hash<String, Object>]
|
|
850
|
+
def unpublish_form(form_unpublish_job_create_query, opts = {})
|
|
851
|
+
data, _status_code, _headers = unpublish_form_with_http_info(form_unpublish_job_create_query, opts)
|
|
852
|
+
data
|
|
853
|
+
end
|
|
854
|
+
|
|
855
|
+
# alias of `unpublish_form`
|
|
856
|
+
alias create_form_unpublish_job unpublish_form
|
|
857
|
+
|
|
858
|
+
# Unpublish Form
|
|
859
|
+
# Unpublish the live version of a form. The unpublish completes synchronously; the returned job resource cannot be retrieved afterwards. Forms with a live A/B test are not supported and must be unpublished from the form editor.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unpublish_form.json)
|
|
860
|
+
# @param form_unpublish_job_create_query [FormUnpublishJobCreateQuery] Unpublish the live version of a form.
|
|
861
|
+
# @param [Hash] opts the optional parameters
|
|
862
|
+
# @option opts [Array<String>] :fields_form_unpublish_job For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
863
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
864
|
+
def unpublish_form_with_http_info(form_unpublish_job_create_query, opts = {})
|
|
865
|
+
if @api_client.config.debugging
|
|
866
|
+
@api_client.config.logger.debug 'Calling API: FormsApi.unpublish_form ...'
|
|
867
|
+
end
|
|
868
|
+
# verify the required parameter 'form_unpublish_job_create_query' is set
|
|
869
|
+
if @api_client.config.client_side_validation && form_unpublish_job_create_query.nil?
|
|
870
|
+
fail ArgumentError, "Missing the required parameter 'form_unpublish_job_create_query' when calling FormsApi.unpublish_form"
|
|
871
|
+
end
|
|
872
|
+
allowable_values = ["created_at", "id", "status"]
|
|
873
|
+
if @api_client.config.client_side_validation && opts[:'fields_form_unpublish_job'] && !opts[:'fields_form_unpublish_job'].all? { |item| allowable_values.include?(item) }
|
|
874
|
+
fail ArgumentError, "invalid value for \"fields_form_unpublish_job\", must include one of #{allowable_values}"
|
|
875
|
+
end
|
|
876
|
+
# resource path
|
|
877
|
+
local_var_path = '/api/form-unpublish-jobs'
|
|
878
|
+
|
|
879
|
+
# query parameters
|
|
880
|
+
query_params = opts[:query_params] || {}
|
|
881
|
+
query_params[:'fields[form-unpublish-job]'] = @api_client.build_collection_param(opts[:'fields_form_unpublish_job'], :csv) if !opts[:'fields_form_unpublish_job'].nil?
|
|
882
|
+
|
|
883
|
+
# header parameters
|
|
884
|
+
header_params = opts[:header_params] || {}
|
|
885
|
+
# klaviyo api revision
|
|
886
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
887
|
+
# HTTP header 'Accept' (if needed)
|
|
888
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
889
|
+
# HTTP header 'Content-Type'
|
|
890
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
891
|
+
if !content_type.nil?
|
|
892
|
+
header_params['Content-Type'] = content_type
|
|
893
|
+
end
|
|
894
|
+
|
|
895
|
+
# form parameters
|
|
896
|
+
form_params = opts[:form_params] || {}
|
|
897
|
+
|
|
898
|
+
# http body (model)
|
|
899
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(form_unpublish_job_create_query)
|
|
900
|
+
|
|
901
|
+
# return_type
|
|
902
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
903
|
+
|
|
904
|
+
# auth_names
|
|
905
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
906
|
+
|
|
907
|
+
new_options = opts.merge(
|
|
908
|
+
:operation => :"FormsApi.unpublish_form",
|
|
909
|
+
:header_params => header_params,
|
|
910
|
+
:query_params => query_params,
|
|
911
|
+
:form_params => form_params,
|
|
912
|
+
:body => post_body,
|
|
913
|
+
:auth_names => auth_names,
|
|
914
|
+
:return_type => return_type
|
|
915
|
+
)
|
|
916
|
+
|
|
917
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
918
|
+
if @api_client.config.debugging
|
|
919
|
+
@api_client.config.logger.debug "API called: FormsApi#unpublish_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
920
|
+
end
|
|
921
|
+
return data, status_code, headers
|
|
922
|
+
end
|
|
923
|
+
|
|
924
|
+
# alias of `unpublish_form_with_http_info`
|
|
925
|
+
alias create_form_unpublish_job_with_http_info unpublish_form_with_http_info
|
|
926
|
+
|
|
927
|
+
# Update Form
|
|
928
|
+
# Update a form. Only submitted attributes change, and `definition` replaces the stored definition. Live versions and form lifecycle fields cannot be edited.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_form.json)
|
|
929
|
+
# @param id [String] The ID of the form.
|
|
930
|
+
# @param form_partial_update_query [FormPartialUpdateQuery] Update a form. Omitted attributes keep their current values.
|
|
931
|
+
# @param [Hash] opts the optional parameters
|
|
932
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
933
|
+
# @return [Hash<String, Object>]
|
|
934
|
+
def update_form(id, form_partial_update_query, opts = {})
|
|
935
|
+
data, _status_code, _headers = update_form_with_http_info(id, form_partial_update_query, opts)
|
|
936
|
+
data
|
|
937
|
+
end
|
|
938
|
+
|
|
939
|
+
# Update Form
|
|
940
|
+
# Update a form. Only submitted attributes change, and `definition` replaces the stored definition. Live versions and form lifecycle fields cannot be edited.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_form.json)
|
|
941
|
+
# @param id [String] The ID of the form.
|
|
942
|
+
# @param form_partial_update_query [FormPartialUpdateQuery] Update a form. Omitted attributes keep their current values.
|
|
943
|
+
# @param [Hash] opts the optional parameters
|
|
944
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
945
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
946
|
+
def update_form_with_http_info(id, form_partial_update_query, opts = {})
|
|
947
|
+
if @api_client.config.debugging
|
|
948
|
+
@api_client.config.logger.debug 'Calling API: FormsApi.update_form ...'
|
|
949
|
+
end
|
|
950
|
+
# verify the required parameter 'id' is set
|
|
951
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
952
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.update_form"
|
|
953
|
+
end
|
|
954
|
+
# verify the required parameter 'form_partial_update_query' is set
|
|
955
|
+
if @api_client.config.client_side_validation && form_partial_update_query.nil?
|
|
956
|
+
fail ArgumentError, "Missing the required parameter 'form_partial_update_query' when calling FormsApi.update_form"
|
|
957
|
+
end
|
|
958
|
+
allowable_values = ["ab_test", "created_at", "definition", "definition.versions", "id", "name", "status", "updated_at"]
|
|
959
|
+
if @api_client.config.client_side_validation && opts[:'fields_form'] && !opts[:'fields_form'].all? { |item| allowable_values.include?(item) }
|
|
960
|
+
fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
|
|
961
|
+
end
|
|
962
|
+
# resource path
|
|
963
|
+
local_var_path = '/api/forms/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
964
|
+
|
|
965
|
+
# query parameters
|
|
966
|
+
query_params = opts[:query_params] || {}
|
|
967
|
+
query_params[:'fields[form]'] = @api_client.build_collection_param(opts[:'fields_form'], :csv) if !opts[:'fields_form'].nil?
|
|
968
|
+
|
|
969
|
+
# header parameters
|
|
970
|
+
header_params = opts[:header_params] || {}
|
|
971
|
+
# klaviyo api revision
|
|
972
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
973
|
+
# HTTP header 'Accept' (if needed)
|
|
974
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
975
|
+
# HTTP header 'Content-Type'
|
|
976
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
977
|
+
if !content_type.nil?
|
|
978
|
+
header_params['Content-Type'] = content_type
|
|
979
|
+
end
|
|
980
|
+
|
|
981
|
+
# form parameters
|
|
982
|
+
form_params = opts[:form_params] || {}
|
|
983
|
+
|
|
984
|
+
# http body (model)
|
|
985
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(form_partial_update_query)
|
|
986
|
+
|
|
987
|
+
# return_type
|
|
988
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
989
|
+
|
|
990
|
+
# auth_names
|
|
991
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
992
|
+
|
|
993
|
+
new_options = opts.merge(
|
|
994
|
+
:operation => :"FormsApi.update_form",
|
|
995
|
+
:header_params => header_params,
|
|
996
|
+
:query_params => query_params,
|
|
997
|
+
:form_params => form_params,
|
|
998
|
+
:body => post_body,
|
|
999
|
+
:auth_names => auth_names,
|
|
1000
|
+
:return_type => return_type
|
|
1001
|
+
)
|
|
1002
|
+
|
|
1003
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
1004
|
+
if @api_client.config.debugging
|
|
1005
|
+
@api_client.config.logger.debug "API called: FormsApi#update_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1006
|
+
end
|
|
1007
|
+
return data, status_code, headers
|
|
1008
|
+
end
|
|
760
1009
|
end
|
|
761
1010
|
end
|