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,8 +22,8 @@ module KlaviyoAPI
|
|
|
22
22
|
# Returns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_campaign_values.json)
|
|
23
23
|
# @param campaign_values_request_dto [CampaignValuesRequestDTO]
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_campaign_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
26
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_campaign_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
26
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
27
27
|
# @return [Hash<String, Object>]
|
|
28
28
|
def query_campaign_values(campaign_values_request_dto, opts = {})
|
|
29
29
|
data, _status_code, _headers = query_campaign_values_with_http_info(campaign_values_request_dto, opts)
|
|
@@ -40,8 +40,8 @@ module KlaviyoAPI
|
|
|
40
40
|
# Returns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `campaigns:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_campaign_values.json)
|
|
41
41
|
# @param campaign_values_request_dto [CampaignValuesRequestDTO]
|
|
42
42
|
# @param [Hash] opts the optional parameters
|
|
43
|
-
# @option opts [Array<String>] :fields_campaign_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
44
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
43
|
+
# @option opts [Array<String>] :fields_campaign_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
44
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
45
45
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
46
46
|
def query_campaign_values_with_http_info(campaign_values_request_dto, opts = {})
|
|
47
47
|
if @api_client.config.debugging
|
|
@@ -66,7 +66,7 @@ module KlaviyoAPI
|
|
|
66
66
|
# header parameters
|
|
67
67
|
header_params = opts[:header_params] || {}
|
|
68
68
|
# klaviyo api revision
|
|
69
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
69
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
70
70
|
# HTTP header 'Accept' (if needed)
|
|
71
71
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
72
72
|
# HTTP header 'Content-Type'
|
|
@@ -114,8 +114,8 @@ module KlaviyoAPI
|
|
|
114
114
|
# Returns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_series.json)
|
|
115
115
|
# @param flow_series_request_dto [FlowSeriesRequestDTO]
|
|
116
116
|
# @param [Hash] opts the optional parameters
|
|
117
|
-
# @option opts [Array<String>] :fields_flow_series_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
118
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
117
|
+
# @option opts [Array<String>] :fields_flow_series_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
118
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
119
119
|
# @return [Hash<String, Object>]
|
|
120
120
|
def query_flow_series(flow_series_request_dto, opts = {})
|
|
121
121
|
data, _status_code, _headers = query_flow_series_with_http_info(flow_series_request_dto, opts)
|
|
@@ -132,8 +132,8 @@ module KlaviyoAPI
|
|
|
132
132
|
# Returns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_series.json)
|
|
133
133
|
# @param flow_series_request_dto [FlowSeriesRequestDTO]
|
|
134
134
|
# @param [Hash] opts the optional parameters
|
|
135
|
-
# @option opts [Array<String>] :fields_flow_series_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
136
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
135
|
+
# @option opts [Array<String>] :fields_flow_series_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
136
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
137
137
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
138
138
|
def query_flow_series_with_http_info(flow_series_request_dto, opts = {})
|
|
139
139
|
if @api_client.config.debugging
|
|
@@ -158,7 +158,7 @@ module KlaviyoAPI
|
|
|
158
158
|
# header parameters
|
|
159
159
|
header_params = opts[:header_params] || {}
|
|
160
160
|
# klaviyo api revision
|
|
161
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
161
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
162
162
|
# HTTP header 'Accept' (if needed)
|
|
163
163
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
164
164
|
# HTTP header 'Content-Type'
|
|
@@ -206,8 +206,8 @@ module KlaviyoAPI
|
|
|
206
206
|
# Returns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_values.json)
|
|
207
207
|
# @param flow_values_request_dto [FlowValuesRequestDTO]
|
|
208
208
|
# @param [Hash] opts the optional parameters
|
|
209
|
-
# @option opts [Array<String>] :fields_flow_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
210
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
209
|
+
# @option opts [Array<String>] :fields_flow_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
210
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
211
211
|
# @return [Hash<String, Object>]
|
|
212
212
|
def query_flow_values(flow_values_request_dto, opts = {})
|
|
213
213
|
data, _status_code, _headers = query_flow_values_with_http_info(flow_values_request_dto, opts)
|
|
@@ -224,8 +224,8 @@ module KlaviyoAPI
|
|
|
224
224
|
# Returns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_values.json)
|
|
225
225
|
# @param flow_values_request_dto [FlowValuesRequestDTO]
|
|
226
226
|
# @param [Hash] opts the optional parameters
|
|
227
|
-
# @option opts [Array<String>] :fields_flow_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
228
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
227
|
+
# @option opts [Array<String>] :fields_flow_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
228
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
229
229
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
230
230
|
def query_flow_values_with_http_info(flow_values_request_dto, opts = {})
|
|
231
231
|
if @api_client.config.debugging
|
|
@@ -250,7 +250,7 @@ module KlaviyoAPI
|
|
|
250
250
|
# header parameters
|
|
251
251
|
header_params = opts[:header_params] || {}
|
|
252
252
|
# klaviyo api revision
|
|
253
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
253
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
254
254
|
# HTTP header 'Accept' (if needed)
|
|
255
255
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
256
256
|
# HTTP header 'Content-Type'
|
|
@@ -298,7 +298,7 @@ module KlaviyoAPI
|
|
|
298
298
|
# Returns the requested form analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_series.json)
|
|
299
299
|
# @param form_series_request_dto [FormSeriesRequestDTO]
|
|
300
300
|
# @param [Hash] opts the optional parameters
|
|
301
|
-
# @option opts [Array<String>] :fields_form_series_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
301
|
+
# @option opts [Array<String>] :fields_form_series_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
302
302
|
# @return [Hash<String, Object>]
|
|
303
303
|
def query_form_series(form_series_request_dto, opts = {})
|
|
304
304
|
data, _status_code, _headers = query_form_series_with_http_info(form_series_request_dto, opts)
|
|
@@ -315,7 +315,7 @@ module KlaviyoAPI
|
|
|
315
315
|
# Returns the requested form analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_series.json)
|
|
316
316
|
# @param form_series_request_dto [FormSeriesRequestDTO]
|
|
317
317
|
# @param [Hash] opts the optional parameters
|
|
318
|
-
# @option opts [Array<String>] :fields_form_series_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
318
|
+
# @option opts [Array<String>] :fields_form_series_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
319
319
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
320
320
|
def query_form_series_with_http_info(form_series_request_dto, opts = {})
|
|
321
321
|
if @api_client.config.debugging
|
|
@@ -339,7 +339,7 @@ module KlaviyoAPI
|
|
|
339
339
|
# header parameters
|
|
340
340
|
header_params = opts[:header_params] || {}
|
|
341
341
|
# klaviyo api revision
|
|
342
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
342
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
343
343
|
# HTTP header 'Accept' (if needed)
|
|
344
344
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
345
345
|
# HTTP header 'Content-Type'
|
|
@@ -387,7 +387,7 @@ module KlaviyoAPI
|
|
|
387
387
|
# Returns the requested form analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_values.json)
|
|
388
388
|
# @param form_values_request_dto [FormValuesRequestDTO]
|
|
389
389
|
# @param [Hash] opts the optional parameters
|
|
390
|
-
# @option opts [Array<String>] :fields_form_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
390
|
+
# @option opts [Array<String>] :fields_form_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
391
391
|
# @return [Hash<String, Object>]
|
|
392
392
|
def query_form_values(form_values_request_dto, opts = {})
|
|
393
393
|
data, _status_code, _headers = query_form_values_with_http_info(form_values_request_dto, opts)
|
|
@@ -404,7 +404,7 @@ module KlaviyoAPI
|
|
|
404
404
|
# Returns the requested form analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_values.json)
|
|
405
405
|
# @param form_values_request_dto [FormValuesRequestDTO]
|
|
406
406
|
# @param [Hash] opts the optional parameters
|
|
407
|
-
# @option opts [Array<String>] :fields_form_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
407
|
+
# @option opts [Array<String>] :fields_form_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
408
408
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
409
409
|
def query_form_values_with_http_info(form_values_request_dto, opts = {})
|
|
410
410
|
if @api_client.config.debugging
|
|
@@ -428,7 +428,7 @@ module KlaviyoAPI
|
|
|
428
428
|
# header parameters
|
|
429
429
|
header_params = opts[:header_params] || {}
|
|
430
430
|
# klaviyo api revision
|
|
431
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
431
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
432
432
|
# HTTP header 'Accept' (if needed)
|
|
433
433
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
434
434
|
# HTTP header 'Content-Type'
|
|
@@ -476,7 +476,7 @@ module KlaviyoAPI
|
|
|
476
476
|
# Returns the requested segment analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_series.json)
|
|
477
477
|
# @param segment_series_request_dto [SegmentSeriesRequestDTO]
|
|
478
478
|
# @param [Hash] opts the optional parameters
|
|
479
|
-
# @option opts [Array<String>] :fields_segment_series_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
479
|
+
# @option opts [Array<String>] :fields_segment_series_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
480
480
|
# @return [Hash<String, Object>]
|
|
481
481
|
def query_segment_series(segment_series_request_dto, opts = {})
|
|
482
482
|
data, _status_code, _headers = query_segment_series_with_http_info(segment_series_request_dto, opts)
|
|
@@ -493,7 +493,7 @@ module KlaviyoAPI
|
|
|
493
493
|
# Returns the requested segment analytics series data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_series.json)
|
|
494
494
|
# @param segment_series_request_dto [SegmentSeriesRequestDTO]
|
|
495
495
|
# @param [Hash] opts the optional parameters
|
|
496
|
-
# @option opts [Array<String>] :fields_segment_series_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
496
|
+
# @option opts [Array<String>] :fields_segment_series_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
497
497
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
498
498
|
def query_segment_series_with_http_info(segment_series_request_dto, opts = {})
|
|
499
499
|
if @api_client.config.debugging
|
|
@@ -517,7 +517,7 @@ module KlaviyoAPI
|
|
|
517
517
|
# header parameters
|
|
518
518
|
header_params = opts[:header_params] || {}
|
|
519
519
|
# klaviyo api revision
|
|
520
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
520
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
521
521
|
# HTTP header 'Accept' (if needed)
|
|
522
522
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
523
523
|
# HTTP header 'Content-Type'
|
|
@@ -565,7 +565,7 @@ module KlaviyoAPI
|
|
|
565
565
|
# Returns the requested segment analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_values.json)
|
|
566
566
|
# @param segment_values_request_dto [SegmentValuesRequestDTO]
|
|
567
567
|
# @param [Hash] opts the optional parameters
|
|
568
|
-
# @option opts [Array<String>] :fields_segment_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
568
|
+
# @option opts [Array<String>] :fields_segment_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
569
569
|
# @return [Hash<String, Object>]
|
|
570
570
|
def query_segment_values(segment_values_request_dto, opts = {})
|
|
571
571
|
data, _status_code, _headers = query_segment_values_with_http_info(segment_values_request_dto, opts)
|
|
@@ -582,7 +582,7 @@ module KlaviyoAPI
|
|
|
582
582
|
# Returns the requested segment analytics values data.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_values.json)
|
|
583
583
|
# @param segment_values_request_dto [SegmentValuesRequestDTO]
|
|
584
584
|
# @param [Hash] opts the optional parameters
|
|
585
|
-
# @option opts [Array<String>] :fields_segment_values_report For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
585
|
+
# @option opts [Array<String>] :fields_segment_values_report For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
586
586
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
587
587
|
def query_segment_values_with_http_info(segment_values_request_dto, opts = {})
|
|
588
588
|
if @api_client.config.debugging
|
|
@@ -606,7 +606,7 @@ module KlaviyoAPI
|
|
|
606
606
|
# header parameters
|
|
607
607
|
header_params = opts[:header_params] || {}
|
|
608
608
|
# klaviyo api revision
|
|
609
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
609
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
610
610
|
# HTTP header 'Accept' (if needed)
|
|
611
611
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
612
612
|
# HTTP header 'Content-Type'
|
|
@@ -22,9 +22,9 @@ module KlaviyoAPI
|
|
|
22
22
|
# Get the review with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `reviews:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_review.json)
|
|
23
23
|
# @param id [String] The ID of the review
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
26
|
-
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
27
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
26
|
+
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
27
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
28
28
|
# @return [Hash<String, Object>]
|
|
29
29
|
def get_review(id, opts = {})
|
|
30
30
|
data, _status_code, _headers = get_review_with_http_info(id, opts)
|
|
@@ -35,9 +35,9 @@ module KlaviyoAPI
|
|
|
35
35
|
# Get the review with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `reviews:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_review.json)
|
|
36
36
|
# @param id [String] The ID of the review
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
39
|
-
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
40
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
38
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
39
|
+
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
40
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
41
41
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
42
42
|
def get_review_with_http_info(id, opts = {})
|
|
43
43
|
if @api_client.config.debugging
|
|
@@ -71,7 +71,7 @@ module KlaviyoAPI
|
|
|
71
71
|
# header parameters
|
|
72
72
|
header_params = opts[:header_params] || {}
|
|
73
73
|
# klaviyo api revision
|
|
74
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
74
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
75
75
|
# HTTP header 'Accept' (if needed)
|
|
76
76
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
77
77
|
|
|
@@ -107,13 +107,13 @@ module KlaviyoAPI
|
|
|
107
107
|
# Get Reviews
|
|
108
108
|
# Get all reviews.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `reviews:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_reviews.json)
|
|
109
109
|
# @param [Hash] opts the optional parameters
|
|
110
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
111
|
-
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
112
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
113
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
114
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
110
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
111
|
+
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
112
|
+
# @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>`created`: `greater-or-equal`, `less-or-equal` (date-time)<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal` (integer)<br>`id`: `any`, `equals` (string)<br>`item.id`: `any`, `equals` (string)<br>`content`: `contains` (string)<br>`status`: `equals` (allowed values: `'published'`, `'unpublished'`, `'rejected'`, `'featured'`, `'pending'`, `'all'`)<br>`review_type`: `equals` (allowed values: `'question'`, `'review'`, `'rating'`, `'store'`)<br>`verified`: `equals` (boolean)
|
|
113
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
114
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
115
115
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
116
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
116
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
117
117
|
# @return [Hash<String, Object>]
|
|
118
118
|
def get_reviews(opts = {})
|
|
119
119
|
data, _status_code, _headers = get_reviews_with_http_info(opts)
|
|
@@ -123,13 +123,13 @@ module KlaviyoAPI
|
|
|
123
123
|
# Get Reviews
|
|
124
124
|
# Get all reviews.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `reviews:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_reviews.json)
|
|
125
125
|
# @param [Hash] opts the optional parameters
|
|
126
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
127
|
-
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
128
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
129
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
130
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
126
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
127
|
+
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
128
|
+
# @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>`created`: `greater-or-equal`, `less-or-equal` (date-time)<br>`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal` (integer)<br>`id`: `any`, `equals` (string)<br>`item.id`: `any`, `equals` (string)<br>`content`: `contains` (string)<br>`status`: `equals` (allowed values: `'published'`, `'unpublished'`, `'rejected'`, `'featured'`, `'pending'`, `'all'`)<br>`review_type`: `equals` (allowed values: `'question'`, `'review'`, `'rating'`, `'store'`)<br>`verified`: `equals` (boolean)
|
|
129
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
130
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
131
131
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
132
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
132
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
133
133
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
134
134
|
def get_reviews_with_http_info(opts = {})
|
|
135
135
|
if @api_client.config.debugging
|
|
@@ -175,7 +175,7 @@ module KlaviyoAPI
|
|
|
175
175
|
# header parameters
|
|
176
176
|
header_params = opts[:header_params] || {}
|
|
177
177
|
# klaviyo api revision
|
|
178
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
178
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
179
179
|
# HTTP header 'Accept' (if needed)
|
|
180
180
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
181
181
|
|
|
@@ -213,7 +213,7 @@ module KlaviyoAPI
|
|
|
213
213
|
# @param id [String] The id of the review (review ID).
|
|
214
214
|
# @param review_patch_query [ReviewPatchQuery] DTO for updating reviews
|
|
215
215
|
# @param [Hash] opts the optional parameters
|
|
216
|
-
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
216
|
+
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
217
217
|
# @return [Hash<String, Object>]
|
|
218
218
|
def update_review(id, review_patch_query, opts = {})
|
|
219
219
|
data, _status_code, _headers = update_review_with_http_info(id, review_patch_query, opts)
|
|
@@ -225,7 +225,7 @@ module KlaviyoAPI
|
|
|
225
225
|
# @param id [String] The id of the review (review ID).
|
|
226
226
|
# @param review_patch_query [ReviewPatchQuery] DTO for updating reviews
|
|
227
227
|
# @param [Hash] opts the optional parameters
|
|
228
|
-
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
228
|
+
# @option opts [Array<String>] :fields_review For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
229
229
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
230
230
|
def update_review_with_http_info(id, review_patch_query, opts = {})
|
|
231
231
|
if @api_client.config.debugging
|
|
@@ -253,7 +253,7 @@ module KlaviyoAPI
|
|
|
253
253
|
# header parameters
|
|
254
254
|
header_params = opts[:header_params] || {}
|
|
255
255
|
# klaviyo api revision
|
|
256
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
256
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
257
257
|
# HTTP header 'Accept' (if needed)
|
|
258
258
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
259
259
|
# HTTP header 'Content-Type'
|