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
|
@@ -0,0 +1,1102 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Klaviyo API
|
|
3
|
+
|
|
4
|
+
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
|
5
|
+
|
|
6
|
+
Contact: developers@klaviyo.com
|
|
7
|
+
Generated by: https://openapi-generator.tech
|
|
8
|
+
OpenAPI Generator version: 6.2.1
|
|
9
|
+
|
|
10
|
+
=end
|
|
11
|
+
|
|
12
|
+
require 'cgi'
|
|
13
|
+
|
|
14
|
+
module KlaviyoAPI
|
|
15
|
+
class TranslationsApi
|
|
16
|
+
attr_accessor :api_client
|
|
17
|
+
|
|
18
|
+
def initialize(api_client = ApiClient.default)
|
|
19
|
+
@api_client = api_client
|
|
20
|
+
end
|
|
21
|
+
# Create Translation
|
|
22
|
+
# Create a translation.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_translation.json)
|
|
23
|
+
# @param translation_create_query [TranslationCreateQuery] Create a translation
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :additional_fields_translation Request additional fields not included by default in the response. Supported values: 'values'
|
|
26
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
27
|
+
# @return [Hash<String, Object>]
|
|
28
|
+
def create_translation(translation_create_query, opts = {})
|
|
29
|
+
data, _status_code, _headers = create_translation_with_http_info(translation_create_query, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Create Translation
|
|
34
|
+
# Create a translation.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_translation.json)
|
|
35
|
+
# @param translation_create_query [TranslationCreateQuery] Create a translation
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @option opts [Array<String>] :additional_fields_translation Request additional fields not included by default in the response. Supported values: 'values'
|
|
38
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
39
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
40
|
+
def create_translation_with_http_info(translation_create_query, opts = {})
|
|
41
|
+
if @api_client.config.debugging
|
|
42
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.create_translation ...'
|
|
43
|
+
end
|
|
44
|
+
# verify the required parameter 'translation_create_query' is set
|
|
45
|
+
if @api_client.config.client_side_validation && translation_create_query.nil?
|
|
46
|
+
fail ArgumentError, "Missing the required parameter 'translation_create_query' when calling TranslationsApi.create_translation"
|
|
47
|
+
end
|
|
48
|
+
allowable_values = ["values"]
|
|
49
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_translation'] && !opts[:'additional_fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
50
|
+
fail ArgumentError, "invalid value for \"additional_fields_translation\", must include one of #{allowable_values}"
|
|
51
|
+
end
|
|
52
|
+
allowable_values = ["channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated", "values"]
|
|
53
|
+
if @api_client.config.client_side_validation && opts[:'fields_translation'] && !opts[:'fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
54
|
+
fail ArgumentError, "invalid value for \"fields_translation\", must include one of #{allowable_values}"
|
|
55
|
+
end
|
|
56
|
+
# resource path
|
|
57
|
+
local_var_path = '/api/translations'
|
|
58
|
+
|
|
59
|
+
# query parameters
|
|
60
|
+
query_params = opts[:query_params] || {}
|
|
61
|
+
query_params[:'additional-fields[translation]'] = @api_client.build_collection_param(opts[:'additional_fields_translation'], :csv) if !opts[:'additional_fields_translation'].nil?
|
|
62
|
+
query_params[:'fields[translation]'] = @api_client.build_collection_param(opts[:'fields_translation'], :csv) if !opts[:'fields_translation'].nil?
|
|
63
|
+
|
|
64
|
+
# header parameters
|
|
65
|
+
header_params = opts[:header_params] || {}
|
|
66
|
+
# klaviyo api revision
|
|
67
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
68
|
+
# HTTP header 'Accept' (if needed)
|
|
69
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
70
|
+
# HTTP header 'Content-Type'
|
|
71
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
72
|
+
if !content_type.nil?
|
|
73
|
+
header_params['Content-Type'] = content_type
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# form parameters
|
|
77
|
+
form_params = opts[:form_params] || {}
|
|
78
|
+
|
|
79
|
+
# http body (model)
|
|
80
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(translation_create_query)
|
|
81
|
+
|
|
82
|
+
# return_type
|
|
83
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
84
|
+
|
|
85
|
+
# auth_names
|
|
86
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
87
|
+
|
|
88
|
+
new_options = opts.merge(
|
|
89
|
+
:operation => :"TranslationsApi.create_translation",
|
|
90
|
+
:header_params => header_params,
|
|
91
|
+
:query_params => query_params,
|
|
92
|
+
:form_params => form_params,
|
|
93
|
+
:body => post_body,
|
|
94
|
+
:auth_names => auth_names,
|
|
95
|
+
:return_type => return_type
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
99
|
+
if @api_client.config.debugging
|
|
100
|
+
@api_client.config.logger.debug "API called: TranslationsApi#create_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
101
|
+
end
|
|
102
|
+
return data, status_code, headers
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Delete Translation
|
|
106
|
+
# Delete the translation with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_translation.json)
|
|
107
|
+
# @param id [String] The ID of the translation
|
|
108
|
+
# @param [Hash] opts the optional parameters
|
|
109
|
+
# @return [nil]
|
|
110
|
+
def delete_translation(id, opts = {})
|
|
111
|
+
delete_translation_with_http_info(id, opts)
|
|
112
|
+
nil
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# Delete Translation
|
|
116
|
+
# Delete the translation with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_translation.json)
|
|
117
|
+
# @param id [String] The ID of the translation
|
|
118
|
+
# @param [Hash] opts the optional parameters
|
|
119
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
120
|
+
def delete_translation_with_http_info(id, opts = {})
|
|
121
|
+
if @api_client.config.debugging
|
|
122
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.delete_translation ...'
|
|
123
|
+
end
|
|
124
|
+
# verify the required parameter 'id' is set
|
|
125
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
126
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.delete_translation"
|
|
127
|
+
end
|
|
128
|
+
# resource path
|
|
129
|
+
local_var_path = '/api/translations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
130
|
+
|
|
131
|
+
# query parameters
|
|
132
|
+
query_params = opts[:query_params] || {}
|
|
133
|
+
|
|
134
|
+
# header parameters
|
|
135
|
+
header_params = opts[:header_params] || {}
|
|
136
|
+
# klaviyo api revision
|
|
137
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
138
|
+
# HTTP header 'Accept' (if needed)
|
|
139
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
140
|
+
|
|
141
|
+
# form parameters
|
|
142
|
+
form_params = opts[:form_params] || {}
|
|
143
|
+
|
|
144
|
+
# http body (model)
|
|
145
|
+
post_body = opts[:debug_body]
|
|
146
|
+
|
|
147
|
+
# return_type
|
|
148
|
+
return_type = opts[:debug_return_type]
|
|
149
|
+
|
|
150
|
+
# auth_names
|
|
151
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
152
|
+
|
|
153
|
+
new_options = opts.merge(
|
|
154
|
+
:operation => :"TranslationsApi.delete_translation",
|
|
155
|
+
:header_params => header_params,
|
|
156
|
+
:query_params => query_params,
|
|
157
|
+
:form_params => form_params,
|
|
158
|
+
:body => post_body,
|
|
159
|
+
:auth_names => auth_names,
|
|
160
|
+
:return_type => return_type
|
|
161
|
+
)
|
|
162
|
+
|
|
163
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
164
|
+
if @api_client.config.debugging
|
|
165
|
+
@api_client.config.logger.debug "API called: TranslationsApi#delete_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
166
|
+
end
|
|
167
|
+
return data, status_code, headers
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# Get Campaign Variation for Translation
|
|
171
|
+
# Get the campaign variation for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation_for_translation.json)
|
|
172
|
+
# @param id [String] The ID of the translation
|
|
173
|
+
# @param [Hash] opts the optional parameters
|
|
174
|
+
# @option opts [Array<String>] :fields_campaign_variation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
175
|
+
# @return [Hash<String, Object>]
|
|
176
|
+
def get_campaign_variation_for_translation(id, opts = {})
|
|
177
|
+
data, _status_code, _headers = get_campaign_variation_for_translation_with_http_info(id, opts)
|
|
178
|
+
data
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# alias of `get_campaign_variation_for_translation`
|
|
182
|
+
alias get_translation_campaign_variation get_campaign_variation_for_translation
|
|
183
|
+
|
|
184
|
+
# Get Campaign Variation for Translation
|
|
185
|
+
# Get the campaign variation for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation_for_translation.json)
|
|
186
|
+
# @param id [String] The ID of the translation
|
|
187
|
+
# @param [Hash] opts the optional parameters
|
|
188
|
+
# @option opts [Array<String>] :fields_campaign_variation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
189
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
190
|
+
def get_campaign_variation_for_translation_with_http_info(id, opts = {})
|
|
191
|
+
if @api_client.config.debugging
|
|
192
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_campaign_variation_for_translation ...'
|
|
193
|
+
end
|
|
194
|
+
# verify the required parameter 'id' is set
|
|
195
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
196
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_campaign_variation_for_translation"
|
|
197
|
+
end
|
|
198
|
+
allowable_values = ["created", "definition", "definition.details", "definition.details.action_buttons", "definition.details.add_info_link", "definition.details.add_opt_out_language", "definition.details.add_org_prefix", "definition.details.android_deep_link", "definition.details.badge", "definition.details.badge_config", "definition.details.badge_value", "definition.details.bcc_email", "definition.details.body", "definition.details.cc_email", "definition.details.channel", "definition.details.content_available", "definition.details.cost", "definition.details.dynamic_media_template", "definition.details.from_email", "definition.details.from_label", "definition.details.include_contact_card", "definition.details.ios_deep_link", "definition.details.kv_pairs", "definition.details.message_hierarchy", "definition.details.mms_dynamic_image_template", "definition.details.mms_static_image_asset_id", "definition.details.mutable_content", "definition.details.open_action", "definition.details.preview_text", "definition.details.push_platform_target", "definition.details.push_type", "definition.details.reply_to_email", "definition.details.send_to_inbox", "definition.details.send_to_primary", "definition.details.shorten_links", "definition.details.sound", "definition.details.sound_file_name", "definition.details.static_asset_id", "definition.details.subject", "definition.details.template_id", "definition.details.text_message_type", "definition.details.title", "definition.details.video_asset_id", "definition.details.web_url", "definition.name", "id", "updated"]
|
|
199
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_variation'] && !opts[:'fields_campaign_variation'].all? { |item| allowable_values.include?(item) }
|
|
200
|
+
fail ArgumentError, "invalid value for \"fields_campaign_variation\", must include one of #{allowable_values}"
|
|
201
|
+
end
|
|
202
|
+
# resource path
|
|
203
|
+
local_var_path = '/api/translations/{id}/campaign-variation'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
204
|
+
|
|
205
|
+
# query parameters
|
|
206
|
+
query_params = opts[:query_params] || {}
|
|
207
|
+
query_params[:'fields[campaign-variation]'] = @api_client.build_collection_param(opts[:'fields_campaign_variation'], :csv) if !opts[:'fields_campaign_variation'].nil?
|
|
208
|
+
|
|
209
|
+
# header parameters
|
|
210
|
+
header_params = opts[:header_params] || {}
|
|
211
|
+
# klaviyo api revision
|
|
212
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
213
|
+
# HTTP header 'Accept' (if needed)
|
|
214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
215
|
+
|
|
216
|
+
# form parameters
|
|
217
|
+
form_params = opts[:form_params] || {}
|
|
218
|
+
|
|
219
|
+
# http body (model)
|
|
220
|
+
post_body = opts[:debug_body]
|
|
221
|
+
|
|
222
|
+
# return_type
|
|
223
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
224
|
+
|
|
225
|
+
# auth_names
|
|
226
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
227
|
+
|
|
228
|
+
new_options = opts.merge(
|
|
229
|
+
:operation => :"TranslationsApi.get_campaign_variation_for_translation",
|
|
230
|
+
:header_params => header_params,
|
|
231
|
+
:query_params => query_params,
|
|
232
|
+
:form_params => form_params,
|
|
233
|
+
:body => post_body,
|
|
234
|
+
:auth_names => auth_names,
|
|
235
|
+
:return_type => return_type
|
|
236
|
+
)
|
|
237
|
+
|
|
238
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
239
|
+
if @api_client.config.debugging
|
|
240
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_campaign_variation_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
241
|
+
end
|
|
242
|
+
return data, status_code, headers
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# alias of `get_campaign_variation_for_translation_with_http_info`
|
|
246
|
+
alias get_translation_campaign_variation_with_http_info get_campaign_variation_for_translation_with_http_info
|
|
247
|
+
|
|
248
|
+
# Get Campaign Variation ID for Translation
|
|
249
|
+
# Get the campaign variation for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation_id_for_translation.json)
|
|
250
|
+
# @param id [String] The ID of the translation
|
|
251
|
+
# @param [Hash] opts the optional parameters
|
|
252
|
+
# @return [Hash<String, Object>]
|
|
253
|
+
def get_campaign_variation_id_for_translation(id, opts = {})
|
|
254
|
+
data, _status_code, _headers = get_campaign_variation_id_for_translation_with_http_info(id, opts)
|
|
255
|
+
data
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
# alias of `get_campaign_variation_id_for_translation`
|
|
259
|
+
alias get_translation_relationships_campaign_variation get_campaign_variation_id_for_translation
|
|
260
|
+
|
|
261
|
+
# Get Campaign Variation ID for Translation
|
|
262
|
+
# Get the campaign variation for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_variation_id_for_translation.json)
|
|
263
|
+
# @param id [String] The ID of the translation
|
|
264
|
+
# @param [Hash] opts the optional parameters
|
|
265
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
266
|
+
def get_campaign_variation_id_for_translation_with_http_info(id, opts = {})
|
|
267
|
+
if @api_client.config.debugging
|
|
268
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_campaign_variation_id_for_translation ...'
|
|
269
|
+
end
|
|
270
|
+
# verify the required parameter 'id' is set
|
|
271
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
272
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_campaign_variation_id_for_translation"
|
|
273
|
+
end
|
|
274
|
+
# resource path
|
|
275
|
+
local_var_path = '/api/translations/{id}/relationships/campaign-variation'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
276
|
+
|
|
277
|
+
# query parameters
|
|
278
|
+
query_params = opts[:query_params] || {}
|
|
279
|
+
|
|
280
|
+
# header parameters
|
|
281
|
+
header_params = opts[:header_params] || {}
|
|
282
|
+
# klaviyo api revision
|
|
283
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
284
|
+
# HTTP header 'Accept' (if needed)
|
|
285
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
286
|
+
|
|
287
|
+
# form parameters
|
|
288
|
+
form_params = opts[:form_params] || {}
|
|
289
|
+
|
|
290
|
+
# http body (model)
|
|
291
|
+
post_body = opts[:debug_body]
|
|
292
|
+
|
|
293
|
+
# return_type
|
|
294
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
295
|
+
|
|
296
|
+
# auth_names
|
|
297
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
298
|
+
|
|
299
|
+
new_options = opts.merge(
|
|
300
|
+
:operation => :"TranslationsApi.get_campaign_variation_id_for_translation",
|
|
301
|
+
:header_params => header_params,
|
|
302
|
+
:query_params => query_params,
|
|
303
|
+
:form_params => form_params,
|
|
304
|
+
:body => post_body,
|
|
305
|
+
:auth_names => auth_names,
|
|
306
|
+
:return_type => return_type
|
|
307
|
+
)
|
|
308
|
+
|
|
309
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
310
|
+
if @api_client.config.debugging
|
|
311
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_campaign_variation_id_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
312
|
+
end
|
|
313
|
+
return data, status_code, headers
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
# alias of `get_campaign_variation_id_for_translation_with_http_info`
|
|
317
|
+
alias get_translation_relationships_campaign_variation_with_http_info get_campaign_variation_id_for_translation_with_http_info
|
|
318
|
+
|
|
319
|
+
# Get Flow Message for Translation
|
|
320
|
+
# Get the flow message for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `flows:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message_for_translation.json)
|
|
321
|
+
# @param id [String] The ID of the translation
|
|
322
|
+
# @param [Hash] opts the optional parameters
|
|
323
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
324
|
+
# @return [Hash<String, Object>]
|
|
325
|
+
def get_flow_message_for_translation(id, opts = {})
|
|
326
|
+
data, _status_code, _headers = get_flow_message_for_translation_with_http_info(id, opts)
|
|
327
|
+
data
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
# alias of `get_flow_message_for_translation`
|
|
331
|
+
alias get_translation_flow_message get_flow_message_for_translation
|
|
332
|
+
|
|
333
|
+
# Get Flow Message for Translation
|
|
334
|
+
# Get the flow message for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `flows:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message_for_translation.json)
|
|
335
|
+
# @param id [String] The ID of the translation
|
|
336
|
+
# @param [Hash] opts the optional parameters
|
|
337
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
338
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
339
|
+
def get_flow_message_for_translation_with_http_info(id, opts = {})
|
|
340
|
+
if @api_client.config.debugging
|
|
341
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_flow_message_for_translation ...'
|
|
342
|
+
end
|
|
343
|
+
# verify the required parameter 'id' is set
|
|
344
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
345
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_flow_message_for_translation"
|
|
346
|
+
end
|
|
347
|
+
allowable_values = ["channel", "content", "content.action_buttons", "content.android_link", "content.badge", "content.bcc_email", "content.body", "content.cc_email", "content.dynamic_image", "content.from_email", "content.from_label", "content.ios_link", "content.media_url", "content.on_open", "content.preview_text", "content.push_platform_target", "content.reply_to_email", "content.send_to_primary", "content.sound", "content.subject", "content.title", "content.web_url", "created", "id", "name", "updated"]
|
|
348
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
349
|
+
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
350
|
+
end
|
|
351
|
+
# resource path
|
|
352
|
+
local_var_path = '/api/translations/{id}/flow-message'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
353
|
+
|
|
354
|
+
# query parameters
|
|
355
|
+
query_params = opts[:query_params] || {}
|
|
356
|
+
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
|
357
|
+
|
|
358
|
+
# header parameters
|
|
359
|
+
header_params = opts[:header_params] || {}
|
|
360
|
+
# klaviyo api revision
|
|
361
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
362
|
+
# HTTP header 'Accept' (if needed)
|
|
363
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
364
|
+
|
|
365
|
+
# form parameters
|
|
366
|
+
form_params = opts[:form_params] || {}
|
|
367
|
+
|
|
368
|
+
# http body (model)
|
|
369
|
+
post_body = opts[:debug_body]
|
|
370
|
+
|
|
371
|
+
# return_type
|
|
372
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
373
|
+
|
|
374
|
+
# auth_names
|
|
375
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
376
|
+
|
|
377
|
+
new_options = opts.merge(
|
|
378
|
+
:operation => :"TranslationsApi.get_flow_message_for_translation",
|
|
379
|
+
:header_params => header_params,
|
|
380
|
+
:query_params => query_params,
|
|
381
|
+
:form_params => form_params,
|
|
382
|
+
:body => post_body,
|
|
383
|
+
:auth_names => auth_names,
|
|
384
|
+
:return_type => return_type
|
|
385
|
+
)
|
|
386
|
+
|
|
387
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
388
|
+
if @api_client.config.debugging
|
|
389
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_flow_message_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
390
|
+
end
|
|
391
|
+
return data, status_code, headers
|
|
392
|
+
end
|
|
393
|
+
|
|
394
|
+
# alias of `get_flow_message_for_translation_with_http_info`
|
|
395
|
+
alias get_translation_flow_message_with_http_info get_flow_message_for_translation_with_http_info
|
|
396
|
+
|
|
397
|
+
# Get Flow Message ID for Translation
|
|
398
|
+
# Get the flow message for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `flows:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message_id_for_translation.json)
|
|
399
|
+
# @param id [String] The ID of the translation
|
|
400
|
+
# @param [Hash] opts the optional parameters
|
|
401
|
+
# @return [Hash<String, Object>]
|
|
402
|
+
def get_flow_message_id_for_translation(id, opts = {})
|
|
403
|
+
data, _status_code, _headers = get_flow_message_id_for_translation_with_http_info(id, opts)
|
|
404
|
+
data
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
# alias of `get_flow_message_id_for_translation`
|
|
408
|
+
alias get_translation_relationships_flow_message get_flow_message_id_for_translation
|
|
409
|
+
|
|
410
|
+
# Get Flow Message ID for Translation
|
|
411
|
+
# Get the flow message for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `flows:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message_id_for_translation.json)
|
|
412
|
+
# @param id [String] The ID of the translation
|
|
413
|
+
# @param [Hash] opts the optional parameters
|
|
414
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
415
|
+
def get_flow_message_id_for_translation_with_http_info(id, opts = {})
|
|
416
|
+
if @api_client.config.debugging
|
|
417
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_flow_message_id_for_translation ...'
|
|
418
|
+
end
|
|
419
|
+
# verify the required parameter 'id' is set
|
|
420
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
421
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_flow_message_id_for_translation"
|
|
422
|
+
end
|
|
423
|
+
# resource path
|
|
424
|
+
local_var_path = '/api/translations/{id}/relationships/flow-message'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
425
|
+
|
|
426
|
+
# query parameters
|
|
427
|
+
query_params = opts[:query_params] || {}
|
|
428
|
+
|
|
429
|
+
# header parameters
|
|
430
|
+
header_params = opts[:header_params] || {}
|
|
431
|
+
# klaviyo api revision
|
|
432
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
433
|
+
# HTTP header 'Accept' (if needed)
|
|
434
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
435
|
+
|
|
436
|
+
# form parameters
|
|
437
|
+
form_params = opts[:form_params] || {}
|
|
438
|
+
|
|
439
|
+
# http body (model)
|
|
440
|
+
post_body = opts[:debug_body]
|
|
441
|
+
|
|
442
|
+
# return_type
|
|
443
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
444
|
+
|
|
445
|
+
# auth_names
|
|
446
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
447
|
+
|
|
448
|
+
new_options = opts.merge(
|
|
449
|
+
:operation => :"TranslationsApi.get_flow_message_id_for_translation",
|
|
450
|
+
:header_params => header_params,
|
|
451
|
+
:query_params => query_params,
|
|
452
|
+
:form_params => form_params,
|
|
453
|
+
:body => post_body,
|
|
454
|
+
:auth_names => auth_names,
|
|
455
|
+
:return_type => return_type
|
|
456
|
+
)
|
|
457
|
+
|
|
458
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
459
|
+
if @api_client.config.debugging
|
|
460
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_flow_message_id_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
461
|
+
end
|
|
462
|
+
return data, status_code, headers
|
|
463
|
+
end
|
|
464
|
+
|
|
465
|
+
# alias of `get_flow_message_id_for_translation_with_http_info`
|
|
466
|
+
alias get_translation_relationships_flow_message_with_http_info get_flow_message_id_for_translation_with_http_info
|
|
467
|
+
|
|
468
|
+
# Get Template for Translation
|
|
469
|
+
# Get the template for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_translation.json)
|
|
470
|
+
# @param id [String] The ID of the translation
|
|
471
|
+
# @param [Hash] opts the optional parameters
|
|
472
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
473
|
+
# @return [Hash<String, Object>]
|
|
474
|
+
def get_template_for_translation(id, opts = {})
|
|
475
|
+
data, _status_code, _headers = get_template_for_translation_with_http_info(id, opts)
|
|
476
|
+
data
|
|
477
|
+
end
|
|
478
|
+
|
|
479
|
+
# alias of `get_template_for_translation`
|
|
480
|
+
alias get_translation_template get_template_for_translation
|
|
481
|
+
|
|
482
|
+
# Get Template for Translation
|
|
483
|
+
# Get the template for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_translation.json)
|
|
484
|
+
# @param id [String] The ID of the translation
|
|
485
|
+
# @param [Hash] opts the optional parameters
|
|
486
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
487
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
488
|
+
def get_template_for_translation_with_http_info(id, opts = {})
|
|
489
|
+
if @api_client.config.debugging
|
|
490
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_template_for_translation ...'
|
|
491
|
+
end
|
|
492
|
+
# verify the required parameter 'id' is set
|
|
493
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
494
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_template_for_translation"
|
|
495
|
+
end
|
|
496
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
497
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
498
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
499
|
+
end
|
|
500
|
+
# resource path
|
|
501
|
+
local_var_path = '/api/translations/{id}/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
502
|
+
|
|
503
|
+
# query parameters
|
|
504
|
+
query_params = opts[:query_params] || {}
|
|
505
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
|
506
|
+
|
|
507
|
+
# header parameters
|
|
508
|
+
header_params = opts[:header_params] || {}
|
|
509
|
+
# klaviyo api revision
|
|
510
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
511
|
+
# HTTP header 'Accept' (if needed)
|
|
512
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
513
|
+
|
|
514
|
+
# form parameters
|
|
515
|
+
form_params = opts[:form_params] || {}
|
|
516
|
+
|
|
517
|
+
# http body (model)
|
|
518
|
+
post_body = opts[:debug_body]
|
|
519
|
+
|
|
520
|
+
# return_type
|
|
521
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
522
|
+
|
|
523
|
+
# auth_names
|
|
524
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
525
|
+
|
|
526
|
+
new_options = opts.merge(
|
|
527
|
+
:operation => :"TranslationsApi.get_template_for_translation",
|
|
528
|
+
:header_params => header_params,
|
|
529
|
+
:query_params => query_params,
|
|
530
|
+
:form_params => form_params,
|
|
531
|
+
:body => post_body,
|
|
532
|
+
:auth_names => auth_names,
|
|
533
|
+
:return_type => return_type
|
|
534
|
+
)
|
|
535
|
+
|
|
536
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
537
|
+
if @api_client.config.debugging
|
|
538
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_template_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
539
|
+
end
|
|
540
|
+
return data, status_code, headers
|
|
541
|
+
end
|
|
542
|
+
|
|
543
|
+
# alias of `get_template_for_translation_with_http_info`
|
|
544
|
+
alias get_translation_template_with_http_info get_template_for_translation_with_http_info
|
|
545
|
+
|
|
546
|
+
# Get Template ID for Translation
|
|
547
|
+
# Get the template for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_translation.json)
|
|
548
|
+
# @param id [String] The ID of the translation
|
|
549
|
+
# @param [Hash] opts the optional parameters
|
|
550
|
+
# @return [Hash<String, Object>]
|
|
551
|
+
def get_template_id_for_translation(id, opts = {})
|
|
552
|
+
data, _status_code, _headers = get_template_id_for_translation_with_http_info(id, opts)
|
|
553
|
+
data
|
|
554
|
+
end
|
|
555
|
+
|
|
556
|
+
# alias of `get_template_id_for_translation`
|
|
557
|
+
alias get_translation_relationships_template get_template_id_for_translation
|
|
558
|
+
|
|
559
|
+
# Get Template ID for Translation
|
|
560
|
+
# Get the template for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_translation.json)
|
|
561
|
+
# @param id [String] The ID of the translation
|
|
562
|
+
# @param [Hash] opts the optional parameters
|
|
563
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
564
|
+
def get_template_id_for_translation_with_http_info(id, opts = {})
|
|
565
|
+
if @api_client.config.debugging
|
|
566
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_template_id_for_translation ...'
|
|
567
|
+
end
|
|
568
|
+
# verify the required parameter 'id' is set
|
|
569
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
570
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_template_id_for_translation"
|
|
571
|
+
end
|
|
572
|
+
# resource path
|
|
573
|
+
local_var_path = '/api/translations/{id}/relationships/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
574
|
+
|
|
575
|
+
# query parameters
|
|
576
|
+
query_params = opts[:query_params] || {}
|
|
577
|
+
|
|
578
|
+
# header parameters
|
|
579
|
+
header_params = opts[:header_params] || {}
|
|
580
|
+
# klaviyo api revision
|
|
581
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
582
|
+
# HTTP header 'Accept' (if needed)
|
|
583
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
584
|
+
|
|
585
|
+
# form parameters
|
|
586
|
+
form_params = opts[:form_params] || {}
|
|
587
|
+
|
|
588
|
+
# http body (model)
|
|
589
|
+
post_body = opts[:debug_body]
|
|
590
|
+
|
|
591
|
+
# return_type
|
|
592
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
593
|
+
|
|
594
|
+
# auth_names
|
|
595
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
596
|
+
|
|
597
|
+
new_options = opts.merge(
|
|
598
|
+
:operation => :"TranslationsApi.get_template_id_for_translation",
|
|
599
|
+
:header_params => header_params,
|
|
600
|
+
:query_params => query_params,
|
|
601
|
+
:form_params => form_params,
|
|
602
|
+
:body => post_body,
|
|
603
|
+
:auth_names => auth_names,
|
|
604
|
+
:return_type => return_type
|
|
605
|
+
)
|
|
606
|
+
|
|
607
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
608
|
+
if @api_client.config.debugging
|
|
609
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_template_id_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
610
|
+
end
|
|
611
|
+
return data, status_code, headers
|
|
612
|
+
end
|
|
613
|
+
|
|
614
|
+
# alias of `get_template_id_for_translation_with_http_info`
|
|
615
|
+
alias get_translation_relationships_template_with_http_info get_template_id_for_translation_with_http_info
|
|
616
|
+
|
|
617
|
+
# Get Template Universal Content for Translation
|
|
618
|
+
# Get the template universal content for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_universal_content_for_translation.json)
|
|
619
|
+
# @param id [String] The ID of the translation
|
|
620
|
+
# @param [Hash] opts the optional parameters
|
|
621
|
+
# @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
622
|
+
# @return [Hash<String, Object>]
|
|
623
|
+
def get_template_universal_content_for_translation(id, opts = {})
|
|
624
|
+
data, _status_code, _headers = get_template_universal_content_for_translation_with_http_info(id, opts)
|
|
625
|
+
data
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
# alias of `get_template_universal_content_for_translation`
|
|
629
|
+
alias get_translation_template_universal_content get_template_universal_content_for_translation
|
|
630
|
+
|
|
631
|
+
# Get Template Universal Content for Translation
|
|
632
|
+
# Get the template universal content for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_universal_content_for_translation.json)
|
|
633
|
+
# @param id [String] The ID of the translation
|
|
634
|
+
# @param [Hash] opts the optional parameters
|
|
635
|
+
# @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
636
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
637
|
+
def get_template_universal_content_for_translation_with_http_info(id, opts = {})
|
|
638
|
+
if @api_client.config.debugging
|
|
639
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_template_universal_content_for_translation ...'
|
|
640
|
+
end
|
|
641
|
+
# verify the required parameter 'id' is set
|
|
642
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
643
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_template_universal_content_for_translation"
|
|
644
|
+
end
|
|
645
|
+
allowable_values = ["created", "definition", "definition.content_type", "definition.data", "definition.data.content", "definition.data.display_options", "definition.data.display_options.content_repeat", "definition.data.display_options.content_repeat.item_alias", "definition.data.display_options.content_repeat.repeat_for", "definition.data.display_options.show_on", "definition.data.display_options.visible_check", "definition.data.styles", "definition.data.styles.background_color", "definition.data.styles.block_background_color", "definition.data.styles.block_border_color", "definition.data.styles.block_border_style", "definition.data.styles.block_border_width", "definition.data.styles.block_padding_bottom", "definition.data.styles.block_padding_left", "definition.data.styles.block_padding_right", "definition.data.styles.block_padding_top", "definition.data.styles.color", "definition.data.styles.extra_css_class", "definition.data.styles.font_family", "definition.data.styles.font_size", "definition.data.styles.font_style", "definition.data.styles.font_weight", "definition.data.styles.inner_padding_bottom", "definition.data.styles.inner_padding_left", "definition.data.styles.inner_padding_right", "definition.data.styles.inner_padding_top", "definition.data.styles.letter_spacing", "definition.data.styles.line_height", "definition.data.styles.mobile_stretch_content", "definition.data.styles.text_align", "definition.data.styles.text_decoration", "definition.data.styles.text_table_layout", "definition.type", "id", "name", "screenshot_status", "screenshot_url", "updated"]
|
|
646
|
+
if @api_client.config.client_side_validation && opts[:'fields_template_universal_content'] && !opts[:'fields_template_universal_content'].all? { |item| allowable_values.include?(item) }
|
|
647
|
+
fail ArgumentError, "invalid value for \"fields_template_universal_content\", must include one of #{allowable_values}"
|
|
648
|
+
end
|
|
649
|
+
# resource path
|
|
650
|
+
local_var_path = '/api/translations/{id}/template-universal-content'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
651
|
+
|
|
652
|
+
# query parameters
|
|
653
|
+
query_params = opts[:query_params] || {}
|
|
654
|
+
query_params[:'fields[template-universal-content]'] = @api_client.build_collection_param(opts[:'fields_template_universal_content'], :csv) if !opts[:'fields_template_universal_content'].nil?
|
|
655
|
+
|
|
656
|
+
# header parameters
|
|
657
|
+
header_params = opts[:header_params] || {}
|
|
658
|
+
# klaviyo api revision
|
|
659
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
660
|
+
# HTTP header 'Accept' (if needed)
|
|
661
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
662
|
+
|
|
663
|
+
# form parameters
|
|
664
|
+
form_params = opts[:form_params] || {}
|
|
665
|
+
|
|
666
|
+
# http body (model)
|
|
667
|
+
post_body = opts[:debug_body]
|
|
668
|
+
|
|
669
|
+
# return_type
|
|
670
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
671
|
+
|
|
672
|
+
# auth_names
|
|
673
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
674
|
+
|
|
675
|
+
new_options = opts.merge(
|
|
676
|
+
:operation => :"TranslationsApi.get_template_universal_content_for_translation",
|
|
677
|
+
:header_params => header_params,
|
|
678
|
+
:query_params => query_params,
|
|
679
|
+
:form_params => form_params,
|
|
680
|
+
:body => post_body,
|
|
681
|
+
:auth_names => auth_names,
|
|
682
|
+
:return_type => return_type
|
|
683
|
+
)
|
|
684
|
+
|
|
685
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
686
|
+
if @api_client.config.debugging
|
|
687
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_template_universal_content_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
688
|
+
end
|
|
689
|
+
return data, status_code, headers
|
|
690
|
+
end
|
|
691
|
+
|
|
692
|
+
# alias of `get_template_universal_content_for_translation_with_http_info`
|
|
693
|
+
alias get_translation_template_universal_content_with_http_info get_template_universal_content_for_translation_with_http_info
|
|
694
|
+
|
|
695
|
+
# Get Template Universal Content ID for Translation
|
|
696
|
+
# Get the template universal content for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_universal_content_id_for_translation.json)
|
|
697
|
+
# @param id [String] The ID of the translation
|
|
698
|
+
# @param [Hash] opts the optional parameters
|
|
699
|
+
# @return [Hash<String, Object>]
|
|
700
|
+
def get_template_universal_content_id_for_translation(id, opts = {})
|
|
701
|
+
data, _status_code, _headers = get_template_universal_content_id_for_translation_with_http_info(id, opts)
|
|
702
|
+
data
|
|
703
|
+
end
|
|
704
|
+
|
|
705
|
+
# alias of `get_template_universal_content_id_for_translation`
|
|
706
|
+
alias get_translation_relationships_template_universal_content get_template_universal_content_id_for_translation
|
|
707
|
+
|
|
708
|
+
# Get Template Universal Content ID for Translation
|
|
709
|
+
# Get the template universal content for the given translation ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read` `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_universal_content_id_for_translation.json)
|
|
710
|
+
# @param id [String] The ID of the translation
|
|
711
|
+
# @param [Hash] opts the optional parameters
|
|
712
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
713
|
+
def get_template_universal_content_id_for_translation_with_http_info(id, opts = {})
|
|
714
|
+
if @api_client.config.debugging
|
|
715
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_template_universal_content_id_for_translation ...'
|
|
716
|
+
end
|
|
717
|
+
# verify the required parameter 'id' is set
|
|
718
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
719
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_template_universal_content_id_for_translation"
|
|
720
|
+
end
|
|
721
|
+
# resource path
|
|
722
|
+
local_var_path = '/api/translations/{id}/relationships/template-universal-content'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
723
|
+
|
|
724
|
+
# query parameters
|
|
725
|
+
query_params = opts[:query_params] || {}
|
|
726
|
+
|
|
727
|
+
# header parameters
|
|
728
|
+
header_params = opts[:header_params] || {}
|
|
729
|
+
# klaviyo api revision
|
|
730
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
731
|
+
# HTTP header 'Accept' (if needed)
|
|
732
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
733
|
+
|
|
734
|
+
# form parameters
|
|
735
|
+
form_params = opts[:form_params] || {}
|
|
736
|
+
|
|
737
|
+
# http body (model)
|
|
738
|
+
post_body = opts[:debug_body]
|
|
739
|
+
|
|
740
|
+
# return_type
|
|
741
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
742
|
+
|
|
743
|
+
# auth_names
|
|
744
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
745
|
+
|
|
746
|
+
new_options = opts.merge(
|
|
747
|
+
:operation => :"TranslationsApi.get_template_universal_content_id_for_translation",
|
|
748
|
+
:header_params => header_params,
|
|
749
|
+
:query_params => query_params,
|
|
750
|
+
:form_params => form_params,
|
|
751
|
+
:body => post_body,
|
|
752
|
+
:auth_names => auth_names,
|
|
753
|
+
:return_type => return_type
|
|
754
|
+
)
|
|
755
|
+
|
|
756
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
757
|
+
if @api_client.config.debugging
|
|
758
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_template_universal_content_id_for_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
759
|
+
end
|
|
760
|
+
return data, status_code, headers
|
|
761
|
+
end
|
|
762
|
+
|
|
763
|
+
# alias of `get_template_universal_content_id_for_translation_with_http_info`
|
|
764
|
+
alias get_translation_relationships_template_universal_content_with_http_info get_template_universal_content_id_for_translation_with_http_info
|
|
765
|
+
|
|
766
|
+
# Get Translation
|
|
767
|
+
# Get the translation with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translation.json)
|
|
768
|
+
# @param id [String] The ID of the translation
|
|
769
|
+
# @param [Hash] opts the optional parameters
|
|
770
|
+
# @option opts [Array<String>] :additional_fields_translation Request additional fields not included by default in the response. Supported values: 'values'
|
|
771
|
+
# @option opts [Array<String>] :fields_campaign_variation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
772
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
773
|
+
# @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
774
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
775
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
776
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
777
|
+
# @option opts [String] :page_type Scope returned consent-page values to a single page type. Only applies to consent-page translations.
|
|
778
|
+
# @return [Hash<String, Object>]
|
|
779
|
+
def get_translation(id, opts = {})
|
|
780
|
+
data, _status_code, _headers = get_translation_with_http_info(id, opts)
|
|
781
|
+
data
|
|
782
|
+
end
|
|
783
|
+
|
|
784
|
+
# Get Translation
|
|
785
|
+
# Get the translation with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translation.json)
|
|
786
|
+
# @param id [String] The ID of the translation
|
|
787
|
+
# @param [Hash] opts the optional parameters
|
|
788
|
+
# @option opts [Array<String>] :additional_fields_translation Request additional fields not included by default in the response. Supported values: 'values'
|
|
789
|
+
# @option opts [Array<String>] :fields_campaign_variation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
790
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
791
|
+
# @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
792
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
793
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
794
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
795
|
+
# @option opts [String] :page_type Scope returned consent-page values to a single page type. Only applies to consent-page translations.
|
|
796
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
797
|
+
def get_translation_with_http_info(id, opts = {})
|
|
798
|
+
if @api_client.config.debugging
|
|
799
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_translation ...'
|
|
800
|
+
end
|
|
801
|
+
# verify the required parameter 'id' is set
|
|
802
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
803
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.get_translation"
|
|
804
|
+
end
|
|
805
|
+
allowable_values = ["values"]
|
|
806
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_translation'] && !opts[:'additional_fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
807
|
+
fail ArgumentError, "invalid value for \"additional_fields_translation\", must include one of #{allowable_values}"
|
|
808
|
+
end
|
|
809
|
+
allowable_values = ["created", "definition", "definition.details", "definition.details.action_buttons", "definition.details.add_info_link", "definition.details.add_opt_out_language", "definition.details.add_org_prefix", "definition.details.android_deep_link", "definition.details.badge", "definition.details.badge_config", "definition.details.badge_value", "definition.details.bcc_email", "definition.details.body", "definition.details.cc_email", "definition.details.channel", "definition.details.content_available", "definition.details.cost", "definition.details.dynamic_media_template", "definition.details.from_email", "definition.details.from_label", "definition.details.include_contact_card", "definition.details.ios_deep_link", "definition.details.kv_pairs", "definition.details.message_hierarchy", "definition.details.mms_dynamic_image_template", "definition.details.mms_static_image_asset_id", "definition.details.mutable_content", "definition.details.open_action", "definition.details.preview_text", "definition.details.push_platform_target", "definition.details.push_type", "definition.details.reply_to_email", "definition.details.send_to_inbox", "definition.details.send_to_primary", "definition.details.shorten_links", "definition.details.sound", "definition.details.sound_file_name", "definition.details.static_asset_id", "definition.details.subject", "definition.details.template_id", "definition.details.text_message_type", "definition.details.title", "definition.details.video_asset_id", "definition.details.web_url", "definition.name", "id", "updated"]
|
|
810
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_variation'] && !opts[:'fields_campaign_variation'].all? { |item| allowable_values.include?(item) }
|
|
811
|
+
fail ArgumentError, "invalid value for \"fields_campaign_variation\", must include one of #{allowable_values}"
|
|
812
|
+
end
|
|
813
|
+
allowable_values = ["channel", "content", "content.action_buttons", "content.android_link", "content.badge", "content.bcc_email", "content.body", "content.cc_email", "content.dynamic_image", "content.from_email", "content.from_label", "content.ios_link", "content.media_url", "content.on_open", "content.preview_text", "content.push_platform_target", "content.reply_to_email", "content.send_to_primary", "content.sound", "content.subject", "content.title", "content.web_url", "created", "id", "name", "updated"]
|
|
814
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
815
|
+
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
816
|
+
end
|
|
817
|
+
allowable_values = ["created", "definition", "definition.content_type", "definition.data", "definition.data.content", "definition.data.display_options", "definition.data.display_options.content_repeat", "definition.data.display_options.content_repeat.item_alias", "definition.data.display_options.content_repeat.repeat_for", "definition.data.display_options.show_on", "definition.data.display_options.visible_check", "definition.data.styles", "definition.data.styles.background_color", "definition.data.styles.block_background_color", "definition.data.styles.block_border_color", "definition.data.styles.block_border_style", "definition.data.styles.block_border_width", "definition.data.styles.block_padding_bottom", "definition.data.styles.block_padding_left", "definition.data.styles.block_padding_right", "definition.data.styles.block_padding_top", "definition.data.styles.color", "definition.data.styles.extra_css_class", "definition.data.styles.font_family", "definition.data.styles.font_size", "definition.data.styles.font_style", "definition.data.styles.font_weight", "definition.data.styles.inner_padding_bottom", "definition.data.styles.inner_padding_left", "definition.data.styles.inner_padding_right", "definition.data.styles.inner_padding_top", "definition.data.styles.letter_spacing", "definition.data.styles.line_height", "definition.data.styles.mobile_stretch_content", "definition.data.styles.text_align", "definition.data.styles.text_decoration", "definition.data.styles.text_table_layout", "definition.type", "id", "name", "screenshot_status", "screenshot_url", "updated"]
|
|
818
|
+
if @api_client.config.client_side_validation && opts[:'fields_template_universal_content'] && !opts[:'fields_template_universal_content'].all? { |item| allowable_values.include?(item) }
|
|
819
|
+
fail ArgumentError, "invalid value for \"fields_template_universal_content\", must include one of #{allowable_values}"
|
|
820
|
+
end
|
|
821
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
822
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
823
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
824
|
+
end
|
|
825
|
+
allowable_values = ["channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated", "values"]
|
|
826
|
+
if @api_client.config.client_side_validation && opts[:'fields_translation'] && !opts[:'fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
827
|
+
fail ArgumentError, "invalid value for \"fields_translation\", must include one of #{allowable_values}"
|
|
828
|
+
end
|
|
829
|
+
allowable_values = ["campaign-variation", "flow-message", "template", "template-universal-content"]
|
|
830
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
831
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
832
|
+
end
|
|
833
|
+
allowable_values = ["double-opt-in-confirmation-page", "double-opt-in-email", "preference-page", "preference-success-page", "subscribe-page", "subscribe-success-page", "unsubscribe-page", "unsubscribe-success-page"]
|
|
834
|
+
if @api_client.config.client_side_validation && opts[:'page_type'] && !allowable_values.include?(opts[:'page_type'])
|
|
835
|
+
fail ArgumentError, "invalid value for \"page_type\", must be one of #{allowable_values}"
|
|
836
|
+
end
|
|
837
|
+
# resource path
|
|
838
|
+
local_var_path = '/api/translations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
839
|
+
|
|
840
|
+
# query parameters
|
|
841
|
+
query_params = opts[:query_params] || {}
|
|
842
|
+
query_params[:'additional-fields[translation]'] = @api_client.build_collection_param(opts[:'additional_fields_translation'], :csv) if !opts[:'additional_fields_translation'].nil?
|
|
843
|
+
query_params[:'fields[campaign-variation]'] = @api_client.build_collection_param(opts[:'fields_campaign_variation'], :csv) if !opts[:'fields_campaign_variation'].nil?
|
|
844
|
+
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
|
845
|
+
query_params[:'fields[template-universal-content]'] = @api_client.build_collection_param(opts[:'fields_template_universal_content'], :csv) if !opts[:'fields_template_universal_content'].nil?
|
|
846
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
|
847
|
+
query_params[:'fields[translation]'] = @api_client.build_collection_param(opts[:'fields_translation'], :csv) if !opts[:'fields_translation'].nil?
|
|
848
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
849
|
+
query_params[:'page_type'] = opts[:'page_type'] if !opts[:'page_type'].nil?
|
|
850
|
+
|
|
851
|
+
# header parameters
|
|
852
|
+
header_params = opts[:header_params] || {}
|
|
853
|
+
# klaviyo api revision
|
|
854
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
855
|
+
# HTTP header 'Accept' (if needed)
|
|
856
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
857
|
+
|
|
858
|
+
# form parameters
|
|
859
|
+
form_params = opts[:form_params] || {}
|
|
860
|
+
|
|
861
|
+
# http body (model)
|
|
862
|
+
post_body = opts[:debug_body]
|
|
863
|
+
|
|
864
|
+
# return_type
|
|
865
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
866
|
+
|
|
867
|
+
# auth_names
|
|
868
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
869
|
+
|
|
870
|
+
new_options = opts.merge(
|
|
871
|
+
:operation => :"TranslationsApi.get_translation",
|
|
872
|
+
:header_params => header_params,
|
|
873
|
+
:query_params => query_params,
|
|
874
|
+
:form_params => form_params,
|
|
875
|
+
:body => post_body,
|
|
876
|
+
:auth_names => auth_names,
|
|
877
|
+
:return_type => return_type
|
|
878
|
+
)
|
|
879
|
+
|
|
880
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
881
|
+
if @api_client.config.debugging
|
|
882
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
883
|
+
end
|
|
884
|
+
return data, status_code, headers
|
|
885
|
+
end
|
|
886
|
+
|
|
887
|
+
# Get Translations
|
|
888
|
+
# Get all translations in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translations.json)
|
|
889
|
+
# @param [Hash] opts the optional parameters
|
|
890
|
+
# @option opts [Array<String>] :fields_campaign_variation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
891
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
892
|
+
# @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
893
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
894
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
895
|
+
# @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>`resource_type`: `equals` (string)<br>`channel`: `equals` (allowed values: `'email'`, `'sms'`, `'mobile_push'`, `'whatsapp'`, `'web'`)<br>`related_resource_id`: `equals` (string)
|
|
896
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
897
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
898
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
899
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
900
|
+
# @return [Hash<String, Object>]
|
|
901
|
+
def get_translations(opts = {})
|
|
902
|
+
data, _status_code, _headers = get_translations_with_http_info(opts)
|
|
903
|
+
data
|
|
904
|
+
end
|
|
905
|
+
|
|
906
|
+
# Get Translations
|
|
907
|
+
# Get all translations in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_translations.json)
|
|
908
|
+
# @param [Hash] opts the optional parameters
|
|
909
|
+
# @option opts [Array<String>] :fields_campaign_variation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
910
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
911
|
+
# @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
912
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
913
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
914
|
+
# @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>`resource_type`: `equals` (string)<br>`channel`: `equals` (allowed values: `'email'`, `'sms'`, `'mobile_push'`, `'whatsapp'`, `'web'`)<br>`related_resource_id`: `equals` (string)
|
|
915
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
916
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
917
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
918
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
919
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
920
|
+
def get_translations_with_http_info(opts = {})
|
|
921
|
+
if @api_client.config.debugging
|
|
922
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.get_translations ...'
|
|
923
|
+
end
|
|
924
|
+
allowable_values = ["created", "definition", "definition.details", "definition.details.action_buttons", "definition.details.add_info_link", "definition.details.add_opt_out_language", "definition.details.add_org_prefix", "definition.details.android_deep_link", "definition.details.badge", "definition.details.badge_config", "definition.details.badge_value", "definition.details.bcc_email", "definition.details.body", "definition.details.cc_email", "definition.details.channel", "definition.details.content_available", "definition.details.cost", "definition.details.dynamic_media_template", "definition.details.from_email", "definition.details.from_label", "definition.details.include_contact_card", "definition.details.ios_deep_link", "definition.details.kv_pairs", "definition.details.message_hierarchy", "definition.details.mms_dynamic_image_template", "definition.details.mms_static_image_asset_id", "definition.details.mutable_content", "definition.details.open_action", "definition.details.preview_text", "definition.details.push_platform_target", "definition.details.push_type", "definition.details.reply_to_email", "definition.details.send_to_inbox", "definition.details.send_to_primary", "definition.details.shorten_links", "definition.details.sound", "definition.details.sound_file_name", "definition.details.static_asset_id", "definition.details.subject", "definition.details.template_id", "definition.details.text_message_type", "definition.details.title", "definition.details.video_asset_id", "definition.details.web_url", "definition.name", "id", "updated"]
|
|
925
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_variation'] && !opts[:'fields_campaign_variation'].all? { |item| allowable_values.include?(item) }
|
|
926
|
+
fail ArgumentError, "invalid value for \"fields_campaign_variation\", must include one of #{allowable_values}"
|
|
927
|
+
end
|
|
928
|
+
allowable_values = ["channel", "content", "content.action_buttons", "content.android_link", "content.badge", "content.bcc_email", "content.body", "content.cc_email", "content.dynamic_image", "content.from_email", "content.from_label", "content.ios_link", "content.media_url", "content.on_open", "content.preview_text", "content.push_platform_target", "content.reply_to_email", "content.send_to_primary", "content.sound", "content.subject", "content.title", "content.web_url", "created", "id", "name", "updated"]
|
|
929
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
930
|
+
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
931
|
+
end
|
|
932
|
+
allowable_values = ["created", "definition", "definition.content_type", "definition.data", "definition.data.content", "definition.data.display_options", "definition.data.display_options.content_repeat", "definition.data.display_options.content_repeat.item_alias", "definition.data.display_options.content_repeat.repeat_for", "definition.data.display_options.show_on", "definition.data.display_options.visible_check", "definition.data.styles", "definition.data.styles.background_color", "definition.data.styles.block_background_color", "definition.data.styles.block_border_color", "definition.data.styles.block_border_style", "definition.data.styles.block_border_width", "definition.data.styles.block_padding_bottom", "definition.data.styles.block_padding_left", "definition.data.styles.block_padding_right", "definition.data.styles.block_padding_top", "definition.data.styles.color", "definition.data.styles.extra_css_class", "definition.data.styles.font_family", "definition.data.styles.font_size", "definition.data.styles.font_style", "definition.data.styles.font_weight", "definition.data.styles.inner_padding_bottom", "definition.data.styles.inner_padding_left", "definition.data.styles.inner_padding_right", "definition.data.styles.inner_padding_top", "definition.data.styles.letter_spacing", "definition.data.styles.line_height", "definition.data.styles.mobile_stretch_content", "definition.data.styles.text_align", "definition.data.styles.text_decoration", "definition.data.styles.text_table_layout", "definition.type", "id", "name", "screenshot_status", "screenshot_url", "updated"]
|
|
933
|
+
if @api_client.config.client_side_validation && opts[:'fields_template_universal_content'] && !opts[:'fields_template_universal_content'].all? { |item| allowable_values.include?(item) }
|
|
934
|
+
fail ArgumentError, "invalid value for \"fields_template_universal_content\", must include one of #{allowable_values}"
|
|
935
|
+
end
|
|
936
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
937
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
938
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
939
|
+
end
|
|
940
|
+
allowable_values = ["channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated"]
|
|
941
|
+
if @api_client.config.client_side_validation && opts[:'fields_translation'] && !opts[:'fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
942
|
+
fail ArgumentError, "invalid value for \"fields_translation\", must include one of #{allowable_values}"
|
|
943
|
+
end
|
|
944
|
+
allowable_values = ["campaign-variation", "flow-message", "template", "template-universal-content"]
|
|
945
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
946
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
947
|
+
end
|
|
948
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
|
949
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TranslationsApi.get_translations, must be smaller than or equal to 100.'
|
|
950
|
+
end
|
|
951
|
+
|
|
952
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
953
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TranslationsApi.get_translations, must be greater than or equal to 1.'
|
|
954
|
+
end
|
|
955
|
+
|
|
956
|
+
allowable_values = ["id", "-id"]
|
|
957
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
958
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
959
|
+
end
|
|
960
|
+
# resource path
|
|
961
|
+
local_var_path = '/api/translations'
|
|
962
|
+
|
|
963
|
+
# query parameters
|
|
964
|
+
query_params = opts[:query_params] || {}
|
|
965
|
+
query_params[:'fields[campaign-variation]'] = @api_client.build_collection_param(opts[:'fields_campaign_variation'], :csv) if !opts[:'fields_campaign_variation'].nil?
|
|
966
|
+
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
|
967
|
+
query_params[:'fields[template-universal-content]'] = @api_client.build_collection_param(opts[:'fields_template_universal_content'], :csv) if !opts[:'fields_template_universal_content'].nil?
|
|
968
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
|
969
|
+
query_params[:'fields[translation]'] = @api_client.build_collection_param(opts[:'fields_translation'], :csv) if !opts[:'fields_translation'].nil?
|
|
970
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
971
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
972
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
973
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
974
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
975
|
+
|
|
976
|
+
# header parameters
|
|
977
|
+
header_params = opts[:header_params] || {}
|
|
978
|
+
# klaviyo api revision
|
|
979
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
980
|
+
# HTTP header 'Accept' (if needed)
|
|
981
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
982
|
+
|
|
983
|
+
# form parameters
|
|
984
|
+
form_params = opts[:form_params] || {}
|
|
985
|
+
|
|
986
|
+
# http body (model)
|
|
987
|
+
post_body = opts[:debug_body]
|
|
988
|
+
|
|
989
|
+
# return_type
|
|
990
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
991
|
+
|
|
992
|
+
# auth_names
|
|
993
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
994
|
+
|
|
995
|
+
new_options = opts.merge(
|
|
996
|
+
:operation => :"TranslationsApi.get_translations",
|
|
997
|
+
:header_params => header_params,
|
|
998
|
+
:query_params => query_params,
|
|
999
|
+
:form_params => form_params,
|
|
1000
|
+
:body => post_body,
|
|
1001
|
+
:auth_names => auth_names,
|
|
1002
|
+
:return_type => return_type
|
|
1003
|
+
)
|
|
1004
|
+
|
|
1005
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1006
|
+
if @api_client.config.debugging
|
|
1007
|
+
@api_client.config.logger.debug "API called: TranslationsApi#get_translations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1008
|
+
end
|
|
1009
|
+
return data, status_code, headers
|
|
1010
|
+
end
|
|
1011
|
+
|
|
1012
|
+
# Update Translation
|
|
1013
|
+
# Update the translation with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_translation.json)
|
|
1014
|
+
# @param id [String] The ID of the translation
|
|
1015
|
+
# @param translation_partial_update_query [TranslationPartialUpdateQuery] Update a translation by ID
|
|
1016
|
+
# @param [Hash] opts the optional parameters
|
|
1017
|
+
# @option opts [Array<String>] :additional_fields_translation Request additional fields not included by default in the response. Supported values: 'values'
|
|
1018
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1019
|
+
# @return [Hash<String, Object>]
|
|
1020
|
+
def update_translation(id, translation_partial_update_query, opts = {})
|
|
1021
|
+
data, _status_code, _headers = update_translation_with_http_info(id, translation_partial_update_query, opts)
|
|
1022
|
+
data
|
|
1023
|
+
end
|
|
1024
|
+
|
|
1025
|
+
# Update Translation
|
|
1026
|
+
# Update the translation with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `translations:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_translation.json)
|
|
1027
|
+
# @param id [String] The ID of the translation
|
|
1028
|
+
# @param translation_partial_update_query [TranslationPartialUpdateQuery] Update a translation by ID
|
|
1029
|
+
# @param [Hash] opts the optional parameters
|
|
1030
|
+
# @option opts [Array<String>] :additional_fields_translation Request additional fields not included by default in the response. Supported values: 'values'
|
|
1031
|
+
# @option opts [Array<String>] :fields_translation For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1032
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1033
|
+
def update_translation_with_http_info(id, translation_partial_update_query, opts = {})
|
|
1034
|
+
if @api_client.config.debugging
|
|
1035
|
+
@api_client.config.logger.debug 'Calling API: TranslationsApi.update_translation ...'
|
|
1036
|
+
end
|
|
1037
|
+
# verify the required parameter 'id' is set
|
|
1038
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1039
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.update_translation"
|
|
1040
|
+
end
|
|
1041
|
+
# verify the required parameter 'translation_partial_update_query' is set
|
|
1042
|
+
if @api_client.config.client_side_validation && translation_partial_update_query.nil?
|
|
1043
|
+
fail ArgumentError, "Missing the required parameter 'translation_partial_update_query' when calling TranslationsApi.update_translation"
|
|
1044
|
+
end
|
|
1045
|
+
allowable_values = ["values"]
|
|
1046
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_translation'] && !opts[:'additional_fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
1047
|
+
fail ArgumentError, "invalid value for \"additional_fields_translation\", must include one of #{allowable_values}"
|
|
1048
|
+
end
|
|
1049
|
+
allowable_values = ["channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated", "values"]
|
|
1050
|
+
if @api_client.config.client_side_validation && opts[:'fields_translation'] && !opts[:'fields_translation'].all? { |item| allowable_values.include?(item) }
|
|
1051
|
+
fail ArgumentError, "invalid value for \"fields_translation\", must include one of #{allowable_values}"
|
|
1052
|
+
end
|
|
1053
|
+
# resource path
|
|
1054
|
+
local_var_path = '/api/translations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1055
|
+
|
|
1056
|
+
# query parameters
|
|
1057
|
+
query_params = opts[:query_params] || {}
|
|
1058
|
+
query_params[:'additional-fields[translation]'] = @api_client.build_collection_param(opts[:'additional_fields_translation'], :csv) if !opts[:'additional_fields_translation'].nil?
|
|
1059
|
+
query_params[:'fields[translation]'] = @api_client.build_collection_param(opts[:'fields_translation'], :csv) if !opts[:'fields_translation'].nil?
|
|
1060
|
+
|
|
1061
|
+
# header parameters
|
|
1062
|
+
header_params = opts[:header_params] || {}
|
|
1063
|
+
# klaviyo api revision
|
|
1064
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1065
|
+
# HTTP header 'Accept' (if needed)
|
|
1066
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1067
|
+
# HTTP header 'Content-Type'
|
|
1068
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
1069
|
+
if !content_type.nil?
|
|
1070
|
+
header_params['Content-Type'] = content_type
|
|
1071
|
+
end
|
|
1072
|
+
|
|
1073
|
+
# form parameters
|
|
1074
|
+
form_params = opts[:form_params] || {}
|
|
1075
|
+
|
|
1076
|
+
# http body (model)
|
|
1077
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(translation_partial_update_query)
|
|
1078
|
+
|
|
1079
|
+
# return_type
|
|
1080
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
1081
|
+
|
|
1082
|
+
# auth_names
|
|
1083
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
1084
|
+
|
|
1085
|
+
new_options = opts.merge(
|
|
1086
|
+
:operation => :"TranslationsApi.update_translation",
|
|
1087
|
+
:header_params => header_params,
|
|
1088
|
+
:query_params => query_params,
|
|
1089
|
+
:form_params => form_params,
|
|
1090
|
+
:body => post_body,
|
|
1091
|
+
:auth_names => auth_names,
|
|
1092
|
+
:return_type => return_type
|
|
1093
|
+
)
|
|
1094
|
+
|
|
1095
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
1096
|
+
if @api_client.config.debugging
|
|
1097
|
+
@api_client.config.logger.debug "API called: TranslationsApi#update_translation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1098
|
+
end
|
|
1099
|
+
return data, status_code, headers
|
|
1100
|
+
end
|
|
1101
|
+
end
|
|
1102
|
+
end
|