klaviyo-api-sdk 17.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 +66 -0
- data/README.md +2261 -677
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
- 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 +3334 -629
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
- data/lib/klaviyo-api-sdk/api/client_api.rb +96 -0
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +187 -108
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +2758 -83
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +72 -58
- data/lib/klaviyo-api-sdk/api/flows_api.rb +315 -152
- data/lib/klaviyo-api-sdk/api/forms_api.rb +330 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +48 -27
- data/lib/klaviyo-api-sdk/api/lists_api.rb +113 -88
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -156
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +445 -226
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +76 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +38 -31
- data/lib/klaviyo-api-sdk/api/segments_api.rb +107 -82
- data/lib/klaviyo-api-sdk/api/tags_api.rb +164 -128
- data/lib/klaviyo-api-sdk/api/templates_api.rb +291 -78
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +41 -27
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +73 -31
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/ab_test_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → ab_test_settings.rb} +39 -34
- data/lib/klaviyo-api-sdk/models/action_output_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +78 -195
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters.rb → action_output_split_action_data_action_output_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{action_output_condition_condition_group.rb → action_output_split_action_data_action_output_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → action_output_split_action_link_only.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +20 -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/{drop_shadow_block_v0.rb → api_schema_property.rb} +42 -34
- 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/audience_create_query_resource_object_relationships.rb +232 -0
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/base_style_properties.rb +15 -5
- 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/{metric_property_condition_condition_group.rb → brand_color_partial_update_query_resource_object_attributes.rb} +22 -16
- 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/{mobile_push_content_update.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +20 -26
- 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/{sms_message_definition_create.rb → brand_email_footer_patch_attributes.rb} +43 -35
- data/lib/klaviyo-api-sdk/models/brand_email_header_patch_attributes.rb +253 -0
- 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_on_open.rb → brand_library_text_styles_letter_spacing.rb} +3 -3
- 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/brand_social_group_create_query_resource_object_attributes_social_links_inner.rb +104 -0
- 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 +2 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +34 -3
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → button_styles_height.rb} +3 -4
- 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/campaign_definition.rb +273 -0
- 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/{push_on_open_deep_link.rb → cart_content.rb} +23 -25
- data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_subscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/click_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → code_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +5 -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/{static_tracking_param.rb → constant_property_mapping.rb} +25 -26
- data/lib/klaviyo-api-sdk/models/constant_property_mapping_value.rb +107 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_content_experiment_action_data.rb → content_experiment_action_data.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_current_experiment.rb → content_experiment_action_data_current_experiment.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → content_experiment_action_data_main_action.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop.rb +286 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop_autofill.rb +264 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop_properties.rb +327 -0
- 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 +43 -1
- data/lib/klaviyo-api-sdk/models/coupon_assigner_configuration.rb +285 -0
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → custom_css.rb} +22 -13
- data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +272 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +460 -0
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter.rb → custom_object_date_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters_condition_groups_inner.rb → custom_object_date_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → custom_object_relationship_source.rb} +69 -34
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/display_options.rb +24 -4
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +20 -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/email_header_link.rb +237 -0
- data/lib/klaviyo-api-sdk/models/email_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +22 -9
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +22 -9
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes.rb +292 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes_source_mapping.rb +224 -0
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +15 -2
- 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/events_bulk_create_query_resource_object_attributes.rb +14 -1
- data/lib/klaviyo-api-sdk/models/first_party_social_link.rb +271 -0
- 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/flow_action_insert_query_resource_object_attributes_anchor_action.rb +224 -0
- 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_definition_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +15 -5
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +15 -2
- data/lib/klaviyo-api-sdk/models/flow_sms_message_hierarchy_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/flow_whats_app_with_ac.rb +303 -0
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
- 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/{html_block_data_v0.rb → form_publish_job_create_query_resource_object.rb} +22 -22
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
- data/lib/klaviyo-api-sdk/models/{render_options.rb → iaf_deeplink_to_screen_properties.rb} +32 -37
- data/lib/klaviyo-api-sdk/models/{text_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 +2 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +0 -35
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +20 -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/link_text_styles_letter_spacing.rb +104 -0
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters.rb → low_inventory_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_condition_group.rb → low_inventory_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- 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/marketing_tracking_consent_configuration.rb +272 -0
- 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/{flow_push_notification_additional_filters_condition_groups_inner.rb → message_create_query_resource_object_relationships_campaign_data.rb} +28 -15
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/message_hierarchy_rcs_item.rb +296 -0
- 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/{mobile_push_content_create.rb → message_tracking_options.rb} +25 -32
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +87 -195
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +2 -1
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters.rb → metric_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters_condition_groups_inner.rb → metric_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → multi_branch_split_action_link_only.rb} +7 -33
- 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 +9 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/object_record_bulk_delete_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships_object_records.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → object_record_delete_job_rels_records_data_inner.rb} +27 -31
- data/lib/klaviyo-api-sdk/models/object_record_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_attributes.rb +322 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_meta.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → object_schema_relationship_create_query.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_update_meta.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → object_type_create_query_resource_object_attributes.rb} +59 -62
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes_object_schema.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_type_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → open_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → patch_identifiers.rb} +19 -14
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter.rb → price_drop_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_condition_group.rb → price_drop_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +29 -9
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_has_not_received_push_message_condition_timeframe_filter.rb → profile_has_not_received_email_message_condition_timeframe_filter.rb} +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/profile_relationship_source.rb +330 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → property_filter.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → property_source.rb} +34 -31
- 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} +29 -13
- 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/quote_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +20 -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/{campaign_create_query_resource_object_attributes_send_options.rb → rcs_card_video.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/rcs_rich_content.rb +244 -0
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/redirect_properties.rb +2 -5
- data/lib/klaviyo-api-sdk/models/related_id_path.rb +273 -0
- data/lib/klaviyo-api-sdk/models/review_block_styles.rb +13 -13
- data/lib/klaviyo-api-sdk/models/review_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +3 -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 +20 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → simple_property_mapping.rb} +28 -34
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping_source.rb +105 -0
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_link_text_style.rb +319 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → source_mapping_create_query_resource_object_attributes.rb} +23 -21
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes_property_mappings_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/spacing_styles.rb +265 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/string_phone_operator_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/table_fallback_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/table_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/template_definition.rb +1 -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/{audiences.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +19 -26
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/text_style_overrides.rb +294 -0
- 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_static_count.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/timezone_options.rb +222 -0
- 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/translation_partial_update_query_resource_object_attributes.rb +257 -0
- 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/{action_output_condition_filter2.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -7
- 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/{mobile_push_badge_badge_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/version.rb +39 -4
- data/lib/klaviyo-api-sdk/models/version_properties.rb +14 -4
- data/lib/klaviyo-api-sdk/models/version_styles.rb +15 -6
- data/lib/klaviyo-api-sdk/models/version_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +389 -99
- data/lib/klaviyo-api-sdk.rb.bak +390 -100
- metadata +399 -103
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_definition.rb +0 -106
- 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/custom_object_property_condition_filter.rb +0 -117
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter2.rb +0 -117
- 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,774 @@
|
|
|
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 TextMessagingApi
|
|
16
|
+
attr_accessor :api_client
|
|
17
|
+
|
|
18
|
+
def initialize(api_client = ApiClient.default)
|
|
19
|
+
@api_client = api_client
|
|
20
|
+
end
|
|
21
|
+
# Create Text Messaging Configuration
|
|
22
|
+
# Create the SMS account for the calling company.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_configuration.json)
|
|
23
|
+
# @param text_messaging_configuration_create_query [TextMessagingConfigurationCreateQuery] Create the text messaging configuration for the calling company. Singleton — a company has at most one text messaging configuration.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :fields_text_messaging_configuration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
26
|
+
# @return [Hash<String, Object>]
|
|
27
|
+
def create_text_messaging_configuration(text_messaging_configuration_create_query, opts = {})
|
|
28
|
+
data, _status_code, _headers = create_text_messaging_configuration_with_http_info(text_messaging_configuration_create_query, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Create Text Messaging Configuration
|
|
33
|
+
# Create the SMS account for the calling company.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_configuration.json)
|
|
34
|
+
# @param text_messaging_configuration_create_query [TextMessagingConfigurationCreateQuery] Create the text messaging configuration for the calling company. Singleton — a company has at most one text messaging configuration.
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @option opts [Array<String>] :fields_text_messaging_configuration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
37
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
38
|
+
def create_text_messaging_configuration_with_http_info(text_messaging_configuration_create_query, opts = {})
|
|
39
|
+
if @api_client.config.debugging
|
|
40
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.create_text_messaging_configuration ...'
|
|
41
|
+
end
|
|
42
|
+
# verify the required parameter 'text_messaging_configuration_create_query' is set
|
|
43
|
+
if @api_client.config.client_side_validation && text_messaging_configuration_create_query.nil?
|
|
44
|
+
fail ArgumentError, "Missing the required parameter 'text_messaging_configuration_create_query' when calling TextMessagingApi.create_text_messaging_configuration"
|
|
45
|
+
end
|
|
46
|
+
allowable_values = ["created_at", "id", "opt_out_language", "org_prefix", "status", "updated_at"]
|
|
47
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_configuration'] && !opts[:'fields_text_messaging_configuration'].all? { |item| allowable_values.include?(item) }
|
|
48
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_configuration\", must include one of #{allowable_values}"
|
|
49
|
+
end
|
|
50
|
+
# resource path
|
|
51
|
+
local_var_path = '/api/text-messaging-configurations'
|
|
52
|
+
|
|
53
|
+
# query parameters
|
|
54
|
+
query_params = opts[:query_params] || {}
|
|
55
|
+
query_params[:'fields[text-messaging-configuration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_configuration'], :csv) if !opts[:'fields_text_messaging_configuration'].nil?
|
|
56
|
+
|
|
57
|
+
# header parameters
|
|
58
|
+
header_params = opts[:header_params] || {}
|
|
59
|
+
# klaviyo api revision
|
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
61
|
+
# HTTP header 'Accept' (if needed)
|
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
63
|
+
# HTTP header 'Content-Type'
|
|
64
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
65
|
+
if !content_type.nil?
|
|
66
|
+
header_params['Content-Type'] = content_type
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# form parameters
|
|
70
|
+
form_params = opts[:form_params] || {}
|
|
71
|
+
|
|
72
|
+
# http body (model)
|
|
73
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(text_messaging_configuration_create_query)
|
|
74
|
+
|
|
75
|
+
# return_type
|
|
76
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
77
|
+
|
|
78
|
+
# auth_names
|
|
79
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
80
|
+
|
|
81
|
+
new_options = opts.merge(
|
|
82
|
+
:operation => :"TextMessagingApi.create_text_messaging_configuration",
|
|
83
|
+
:header_params => header_params,
|
|
84
|
+
:query_params => query_params,
|
|
85
|
+
:form_params => form_params,
|
|
86
|
+
:body => post_body,
|
|
87
|
+
:auth_names => auth_names,
|
|
88
|
+
:return_type => return_type
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
92
|
+
if @api_client.config.debugging
|
|
93
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#create_text_messaging_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
94
|
+
end
|
|
95
|
+
return data, status_code, headers
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Create Text Messaging Sender
|
|
99
|
+
# Create a sender and submit its initial registration. A toll-free number is provisioned in all supported regions (US + CA), so the response is the sender for the requested country and the sibling-region sender also appears in list/retrieve.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_sender.json)
|
|
100
|
+
# @param text_messaging_sender_create_query [TextMessagingSenderCreateQuery] Create a text-messaging sender.
|
|
101
|
+
# @param [Hash] opts the optional parameters
|
|
102
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
103
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
104
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
105
|
+
# @return [Hash<String, Object>]
|
|
106
|
+
def create_text_messaging_sender(text_messaging_sender_create_query, opts = {})
|
|
107
|
+
data, _status_code, _headers = create_text_messaging_sender_with_http_info(text_messaging_sender_create_query, opts)
|
|
108
|
+
data
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# Create Text Messaging Sender
|
|
112
|
+
# Create a sender and submit its initial registration. A toll-free number is provisioned in all supported regions (US + CA), so the response is the sender for the requested country and the sibling-region sender also appears in list/retrieve.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_sender.json)
|
|
113
|
+
# @param text_messaging_sender_create_query [TextMessagingSenderCreateQuery] Create a text-messaging sender.
|
|
114
|
+
# @param [Hash] opts the optional parameters
|
|
115
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
116
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
117
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
118
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
119
|
+
def create_text_messaging_sender_with_http_info(text_messaging_sender_create_query, opts = {})
|
|
120
|
+
if @api_client.config.debugging
|
|
121
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.create_text_messaging_sender ...'
|
|
122
|
+
end
|
|
123
|
+
# verify the required parameter 'text_messaging_sender_create_query' is set
|
|
124
|
+
if @api_client.config.client_side_validation && text_messaging_sender_create_query.nil?
|
|
125
|
+
fail ArgumentError, "Missing the required parameter 'text_messaging_sender_create_query' when calling TextMessagingApi.create_text_messaging_sender"
|
|
126
|
+
end
|
|
127
|
+
allowable_values = ["created_at", "decided_at", "failures", "id", "status", "submitted_at", "updated_at"]
|
|
128
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender_registration'] && !opts[:'fields_text_messaging_sender_registration'].all? { |item| allowable_values.include?(item) }
|
|
129
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender_registration\", must include one of #{allowable_values}"
|
|
130
|
+
end
|
|
131
|
+
allowable_values = ["created_at", "forwarding_number", "id", "sender_details", "sender_details.country", "sender_identifier", "sender_type", "status"]
|
|
132
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender'] && !opts[:'fields_text_messaging_sender'].all? { |item| allowable_values.include?(item) }
|
|
133
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender\", must include one of #{allowable_values}"
|
|
134
|
+
end
|
|
135
|
+
allowable_values = ["text-messaging-sender-registration"]
|
|
136
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
137
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
138
|
+
end
|
|
139
|
+
# resource path
|
|
140
|
+
local_var_path = '/api/text-messaging-senders'
|
|
141
|
+
|
|
142
|
+
# query parameters
|
|
143
|
+
query_params = opts[:query_params] || {}
|
|
144
|
+
query_params[:'fields[text-messaging-sender-registration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender_registration'], :csv) if !opts[:'fields_text_messaging_sender_registration'].nil?
|
|
145
|
+
query_params[:'fields[text-messaging-sender]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender'], :csv) if !opts[:'fields_text_messaging_sender'].nil?
|
|
146
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
147
|
+
|
|
148
|
+
# header parameters
|
|
149
|
+
header_params = opts[:header_params] || {}
|
|
150
|
+
# klaviyo api revision
|
|
151
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
152
|
+
# HTTP header 'Accept' (if needed)
|
|
153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
154
|
+
# HTTP header 'Content-Type'
|
|
155
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
156
|
+
if !content_type.nil?
|
|
157
|
+
header_params['Content-Type'] = content_type
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# form parameters
|
|
161
|
+
form_params = opts[:form_params] || {}
|
|
162
|
+
|
|
163
|
+
# http body (model)
|
|
164
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(text_messaging_sender_create_query)
|
|
165
|
+
|
|
166
|
+
# return_type
|
|
167
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
168
|
+
|
|
169
|
+
# auth_names
|
|
170
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
171
|
+
|
|
172
|
+
new_options = opts.merge(
|
|
173
|
+
:operation => :"TextMessagingApi.create_text_messaging_sender",
|
|
174
|
+
:header_params => header_params,
|
|
175
|
+
:query_params => query_params,
|
|
176
|
+
:form_params => form_params,
|
|
177
|
+
:body => post_body,
|
|
178
|
+
:auth_names => auth_names,
|
|
179
|
+
:return_type => return_type
|
|
180
|
+
)
|
|
181
|
+
|
|
182
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
183
|
+
if @api_client.config.debugging
|
|
184
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#create_text_messaging_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
185
|
+
end
|
|
186
|
+
return data, status_code, headers
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# Create Text Messaging Sender Registration
|
|
190
|
+
# Submit a new registration for an existing sender (resubmission).<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_sender_registration.json)
|
|
191
|
+
# @param text_messaging_sender_registration_create_query [TextMessagingSenderRegistrationCreateQuery] Submit a new registration for an existing text-messaging sender.
|
|
192
|
+
# @param [Hash] opts the optional parameters
|
|
193
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
194
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
195
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
196
|
+
# @return [Hash<String, Object>]
|
|
197
|
+
def create_text_messaging_sender_registration(text_messaging_sender_registration_create_query, opts = {})
|
|
198
|
+
data, _status_code, _headers = create_text_messaging_sender_registration_with_http_info(text_messaging_sender_registration_create_query, opts)
|
|
199
|
+
data
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
# Create Text Messaging Sender Registration
|
|
203
|
+
# Submit a new registration for an existing sender (resubmission).<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `sender-config:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_text_messaging_sender_registration.json)
|
|
204
|
+
# @param text_messaging_sender_registration_create_query [TextMessagingSenderRegistrationCreateQuery] Submit a new registration for an existing text-messaging sender.
|
|
205
|
+
# @param [Hash] opts the optional parameters
|
|
206
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
207
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
208
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
209
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
210
|
+
def create_text_messaging_sender_registration_with_http_info(text_messaging_sender_registration_create_query, opts = {})
|
|
211
|
+
if @api_client.config.debugging
|
|
212
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.create_text_messaging_sender_registration ...'
|
|
213
|
+
end
|
|
214
|
+
# verify the required parameter 'text_messaging_sender_registration_create_query' is set
|
|
215
|
+
if @api_client.config.client_side_validation && text_messaging_sender_registration_create_query.nil?
|
|
216
|
+
fail ArgumentError, "Missing the required parameter 'text_messaging_sender_registration_create_query' when calling TextMessagingApi.create_text_messaging_sender_registration"
|
|
217
|
+
end
|
|
218
|
+
allowable_values = ["created_at", "decided_at", "failures", "id", "status", "submitted_at", "updated_at"]
|
|
219
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender_registration'] && !opts[:'fields_text_messaging_sender_registration'].all? { |item| allowable_values.include?(item) }
|
|
220
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender_registration\", must include one of #{allowable_values}"
|
|
221
|
+
end
|
|
222
|
+
allowable_values = ["created_at", "forwarding_number", "id", "sender_details", "sender_details.country", "sender_identifier", "sender_type", "status"]
|
|
223
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender'] && !opts[:'fields_text_messaging_sender'].all? { |item| allowable_values.include?(item) }
|
|
224
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender\", must include one of #{allowable_values}"
|
|
225
|
+
end
|
|
226
|
+
allowable_values = ["text-messaging-sender"]
|
|
227
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
228
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
229
|
+
end
|
|
230
|
+
# resource path
|
|
231
|
+
local_var_path = '/api/text-messaging-sender-registrations'
|
|
232
|
+
|
|
233
|
+
# query parameters
|
|
234
|
+
query_params = opts[:query_params] || {}
|
|
235
|
+
query_params[:'fields[text-messaging-sender-registration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender_registration'], :csv) if !opts[:'fields_text_messaging_sender_registration'].nil?
|
|
236
|
+
query_params[:'fields[text-messaging-sender]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender'], :csv) if !opts[:'fields_text_messaging_sender'].nil?
|
|
237
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
238
|
+
|
|
239
|
+
# header parameters
|
|
240
|
+
header_params = opts[:header_params] || {}
|
|
241
|
+
# klaviyo api revision
|
|
242
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
243
|
+
# HTTP header 'Accept' (if needed)
|
|
244
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
245
|
+
# HTTP header 'Content-Type'
|
|
246
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
247
|
+
if !content_type.nil?
|
|
248
|
+
header_params['Content-Type'] = content_type
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
# form parameters
|
|
252
|
+
form_params = opts[:form_params] || {}
|
|
253
|
+
|
|
254
|
+
# http body (model)
|
|
255
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(text_messaging_sender_registration_create_query)
|
|
256
|
+
|
|
257
|
+
# return_type
|
|
258
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
259
|
+
|
|
260
|
+
# auth_names
|
|
261
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
262
|
+
|
|
263
|
+
new_options = opts.merge(
|
|
264
|
+
:operation => :"TextMessagingApi.create_text_messaging_sender_registration",
|
|
265
|
+
:header_params => header_params,
|
|
266
|
+
:query_params => query_params,
|
|
267
|
+
:form_params => form_params,
|
|
268
|
+
:body => post_body,
|
|
269
|
+
:auth_names => auth_names,
|
|
270
|
+
:return_type => return_type
|
|
271
|
+
)
|
|
272
|
+
|
|
273
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
274
|
+
if @api_client.config.debugging
|
|
275
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#create_text_messaging_sender_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
276
|
+
end
|
|
277
|
+
return data, status_code, headers
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# Get Messaging Sender Registration for Text Messaging Sender
|
|
281
|
+
# Return the most-recent registration for the given sender.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messaging_sender_registration_for_text_messaging_sender.json)
|
|
282
|
+
# @param id [String] The unique identifier of the text-messaging sender.
|
|
283
|
+
# @param [Hash] opts the optional parameters
|
|
284
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
285
|
+
# @return [Hash<String, Object>]
|
|
286
|
+
def get_messaging_sender_registration_for_text_messaging_sender(id, opts = {})
|
|
287
|
+
data, _status_code, _headers = get_messaging_sender_registration_for_text_messaging_sender_with_http_info(id, opts)
|
|
288
|
+
data
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# alias of `get_messaging_sender_registration_for_text_messaging_sender`
|
|
292
|
+
alias get_text_messaging_sender_messaging_sender_registration get_messaging_sender_registration_for_text_messaging_sender
|
|
293
|
+
|
|
294
|
+
# Get Messaging Sender Registration for Text Messaging Sender
|
|
295
|
+
# Return the most-recent registration for the given sender.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messaging_sender_registration_for_text_messaging_sender.json)
|
|
296
|
+
# @param id [String] The unique identifier of the text-messaging sender.
|
|
297
|
+
# @param [Hash] opts the optional parameters
|
|
298
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
299
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
300
|
+
def get_messaging_sender_registration_for_text_messaging_sender_with_http_info(id, opts = {})
|
|
301
|
+
if @api_client.config.debugging
|
|
302
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.get_messaging_sender_registration_for_text_messaging_sender ...'
|
|
303
|
+
end
|
|
304
|
+
# verify the required parameter 'id' is set
|
|
305
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
306
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TextMessagingApi.get_messaging_sender_registration_for_text_messaging_sender"
|
|
307
|
+
end
|
|
308
|
+
allowable_values = ["created_at", "decided_at", "failures", "id", "status", "submitted_at", "updated_at"]
|
|
309
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender_registration'] && !opts[:'fields_text_messaging_sender_registration'].all? { |item| allowable_values.include?(item) }
|
|
310
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender_registration\", must include one of #{allowable_values}"
|
|
311
|
+
end
|
|
312
|
+
# resource path
|
|
313
|
+
local_var_path = '/api/text-messaging-senders/{id}/text-messaging-sender-registration'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
314
|
+
|
|
315
|
+
# query parameters
|
|
316
|
+
query_params = opts[:query_params] || {}
|
|
317
|
+
query_params[:'fields[text-messaging-sender-registration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender_registration'], :csv) if !opts[:'fields_text_messaging_sender_registration'].nil?
|
|
318
|
+
|
|
319
|
+
# header parameters
|
|
320
|
+
header_params = opts[:header_params] || {}
|
|
321
|
+
# klaviyo api revision
|
|
322
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
323
|
+
# HTTP header 'Accept' (if needed)
|
|
324
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
325
|
+
|
|
326
|
+
# form parameters
|
|
327
|
+
form_params = opts[:form_params] || {}
|
|
328
|
+
|
|
329
|
+
# http body (model)
|
|
330
|
+
post_body = opts[:debug_body]
|
|
331
|
+
|
|
332
|
+
# return_type
|
|
333
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
334
|
+
|
|
335
|
+
# auth_names
|
|
336
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
337
|
+
|
|
338
|
+
new_options = opts.merge(
|
|
339
|
+
:operation => :"TextMessagingApi.get_messaging_sender_registration_for_text_messaging_sender",
|
|
340
|
+
:header_params => header_params,
|
|
341
|
+
:query_params => query_params,
|
|
342
|
+
:form_params => form_params,
|
|
343
|
+
:body => post_body,
|
|
344
|
+
:auth_names => auth_names,
|
|
345
|
+
:return_type => return_type
|
|
346
|
+
)
|
|
347
|
+
|
|
348
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
349
|
+
if @api_client.config.debugging
|
|
350
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#get_messaging_sender_registration_for_text_messaging_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
351
|
+
end
|
|
352
|
+
return data, status_code, headers
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
# alias of `get_messaging_sender_registration_for_text_messaging_sender_with_http_info`
|
|
356
|
+
alias get_text_messaging_sender_messaging_sender_registration_with_http_info get_messaging_sender_registration_for_text_messaging_sender_with_http_info
|
|
357
|
+
|
|
358
|
+
# Get Messaging Sender Registration ID for Text Messaging Sender
|
|
359
|
+
# Return the most-recent registration for the given sender.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messaging_sender_registration_id_for_text_messaging_sender.json)
|
|
360
|
+
# @param id [String] The unique identifier of the text-messaging sender.
|
|
361
|
+
# @param [Hash] opts the optional parameters
|
|
362
|
+
# @return [Hash<String, Object>]
|
|
363
|
+
def get_messaging_sender_registration_id_for_text_messaging_sender(id, opts = {})
|
|
364
|
+
data, _status_code, _headers = get_messaging_sender_registration_id_for_text_messaging_sender_with_http_info(id, opts)
|
|
365
|
+
data
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
# alias of `get_messaging_sender_registration_id_for_text_messaging_sender`
|
|
369
|
+
alias get_text_messaging_sender_relationships_messaging_sender_registration get_messaging_sender_registration_id_for_text_messaging_sender
|
|
370
|
+
|
|
371
|
+
# Get Messaging Sender Registration ID for Text Messaging Sender
|
|
372
|
+
# Return the most-recent registration for the given sender.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messaging_sender_registration_id_for_text_messaging_sender.json)
|
|
373
|
+
# @param id [String] The unique identifier of the text-messaging sender.
|
|
374
|
+
# @param [Hash] opts the optional parameters
|
|
375
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
376
|
+
def get_messaging_sender_registration_id_for_text_messaging_sender_with_http_info(id, opts = {})
|
|
377
|
+
if @api_client.config.debugging
|
|
378
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.get_messaging_sender_registration_id_for_text_messaging_sender ...'
|
|
379
|
+
end
|
|
380
|
+
# verify the required parameter 'id' is set
|
|
381
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
382
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TextMessagingApi.get_messaging_sender_registration_id_for_text_messaging_sender"
|
|
383
|
+
end
|
|
384
|
+
# resource path
|
|
385
|
+
local_var_path = '/api/text-messaging-senders/{id}/relationships/text-messaging-sender-registration'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
386
|
+
|
|
387
|
+
# query parameters
|
|
388
|
+
query_params = opts[:query_params] || {}
|
|
389
|
+
|
|
390
|
+
# header parameters
|
|
391
|
+
header_params = opts[:header_params] || {}
|
|
392
|
+
# klaviyo api revision
|
|
393
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
394
|
+
# HTTP header 'Accept' (if needed)
|
|
395
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
396
|
+
|
|
397
|
+
# form parameters
|
|
398
|
+
form_params = opts[:form_params] || {}
|
|
399
|
+
|
|
400
|
+
# http body (model)
|
|
401
|
+
post_body = opts[:debug_body]
|
|
402
|
+
|
|
403
|
+
# return_type
|
|
404
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
405
|
+
|
|
406
|
+
# auth_names
|
|
407
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
408
|
+
|
|
409
|
+
new_options = opts.merge(
|
|
410
|
+
:operation => :"TextMessagingApi.get_messaging_sender_registration_id_for_text_messaging_sender",
|
|
411
|
+
:header_params => header_params,
|
|
412
|
+
:query_params => query_params,
|
|
413
|
+
:form_params => form_params,
|
|
414
|
+
:body => post_body,
|
|
415
|
+
:auth_names => auth_names,
|
|
416
|
+
:return_type => return_type
|
|
417
|
+
)
|
|
418
|
+
|
|
419
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
420
|
+
if @api_client.config.debugging
|
|
421
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#get_messaging_sender_registration_id_for_text_messaging_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
422
|
+
end
|
|
423
|
+
return data, status_code, headers
|
|
424
|
+
end
|
|
425
|
+
|
|
426
|
+
# alias of `get_messaging_sender_registration_id_for_text_messaging_sender_with_http_info`
|
|
427
|
+
alias get_text_messaging_sender_relationships_messaging_sender_registration_with_http_info get_messaging_sender_registration_id_for_text_messaging_sender_with_http_info
|
|
428
|
+
|
|
429
|
+
# Get Text Messaging Configuration
|
|
430
|
+
# Retrieve the SMS account for the calling company.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_configuration.json)
|
|
431
|
+
# @param id [String] The unique identifier for this text messaging configuration (must equal the caller's company id).
|
|
432
|
+
# @param [Hash] opts the optional parameters
|
|
433
|
+
# @option opts [Array<String>] :fields_text_messaging_configuration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
434
|
+
# @return [Hash<String, Object>]
|
|
435
|
+
def get_text_messaging_configuration(id, opts = {})
|
|
436
|
+
data, _status_code, _headers = get_text_messaging_configuration_with_http_info(id, opts)
|
|
437
|
+
data
|
|
438
|
+
end
|
|
439
|
+
|
|
440
|
+
# Get Text Messaging Configuration
|
|
441
|
+
# Retrieve the SMS account for the calling company.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_configuration.json)
|
|
442
|
+
# @param id [String] The unique identifier for this text messaging configuration (must equal the caller's company id).
|
|
443
|
+
# @param [Hash] opts the optional parameters
|
|
444
|
+
# @option opts [Array<String>] :fields_text_messaging_configuration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
445
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
446
|
+
def get_text_messaging_configuration_with_http_info(id, opts = {})
|
|
447
|
+
if @api_client.config.debugging
|
|
448
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.get_text_messaging_configuration ...'
|
|
449
|
+
end
|
|
450
|
+
# verify the required parameter 'id' is set
|
|
451
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
452
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TextMessagingApi.get_text_messaging_configuration"
|
|
453
|
+
end
|
|
454
|
+
allowable_values = ["created_at", "id", "opt_out_language", "org_prefix", "status", "updated_at"]
|
|
455
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_configuration'] && !opts[:'fields_text_messaging_configuration'].all? { |item| allowable_values.include?(item) }
|
|
456
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_configuration\", must include one of #{allowable_values}"
|
|
457
|
+
end
|
|
458
|
+
# resource path
|
|
459
|
+
local_var_path = '/api/text-messaging-configurations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
460
|
+
|
|
461
|
+
# query parameters
|
|
462
|
+
query_params = opts[:query_params] || {}
|
|
463
|
+
query_params[:'fields[text-messaging-configuration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_configuration'], :csv) if !opts[:'fields_text_messaging_configuration'].nil?
|
|
464
|
+
|
|
465
|
+
# header parameters
|
|
466
|
+
header_params = opts[:header_params] || {}
|
|
467
|
+
# klaviyo api revision
|
|
468
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
469
|
+
# HTTP header 'Accept' (if needed)
|
|
470
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
471
|
+
|
|
472
|
+
# form parameters
|
|
473
|
+
form_params = opts[:form_params] || {}
|
|
474
|
+
|
|
475
|
+
# http body (model)
|
|
476
|
+
post_body = opts[:debug_body]
|
|
477
|
+
|
|
478
|
+
# return_type
|
|
479
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
480
|
+
|
|
481
|
+
# auth_names
|
|
482
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
483
|
+
|
|
484
|
+
new_options = opts.merge(
|
|
485
|
+
:operation => :"TextMessagingApi.get_text_messaging_configuration",
|
|
486
|
+
:header_params => header_params,
|
|
487
|
+
:query_params => query_params,
|
|
488
|
+
:form_params => form_params,
|
|
489
|
+
:body => post_body,
|
|
490
|
+
:auth_names => auth_names,
|
|
491
|
+
:return_type => return_type
|
|
492
|
+
)
|
|
493
|
+
|
|
494
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
495
|
+
if @api_client.config.debugging
|
|
496
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#get_text_messaging_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
497
|
+
end
|
|
498
|
+
return data, status_code, headers
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# Get Text Messaging Sender
|
|
502
|
+
# Retrieve a single text-messaging sender by ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_sender.json)
|
|
503
|
+
# @param id [String] The unique identifier for the text-messaging sender.
|
|
504
|
+
# @param [Hash] opts the optional parameters
|
|
505
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
506
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
507
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
508
|
+
# @return [Hash<String, Object>]
|
|
509
|
+
def get_text_messaging_sender(id, opts = {})
|
|
510
|
+
data, _status_code, _headers = get_text_messaging_sender_with_http_info(id, opts)
|
|
511
|
+
data
|
|
512
|
+
end
|
|
513
|
+
|
|
514
|
+
# Get Text Messaging Sender
|
|
515
|
+
# Retrieve a single text-messaging sender by ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_sender.json)
|
|
516
|
+
# @param id [String] The unique identifier for the text-messaging sender.
|
|
517
|
+
# @param [Hash] opts the optional parameters
|
|
518
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
519
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
520
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
521
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
522
|
+
def get_text_messaging_sender_with_http_info(id, opts = {})
|
|
523
|
+
if @api_client.config.debugging
|
|
524
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.get_text_messaging_sender ...'
|
|
525
|
+
end
|
|
526
|
+
# verify the required parameter 'id' is set
|
|
527
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
528
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TextMessagingApi.get_text_messaging_sender"
|
|
529
|
+
end
|
|
530
|
+
allowable_values = ["created_at", "decided_at", "failures", "id", "status", "submitted_at", "updated_at"]
|
|
531
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender_registration'] && !opts[:'fields_text_messaging_sender_registration'].all? { |item| allowable_values.include?(item) }
|
|
532
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender_registration\", must include one of #{allowable_values}"
|
|
533
|
+
end
|
|
534
|
+
allowable_values = ["created_at", "forwarding_number", "id", "sender_details", "sender_details.country", "sender_identifier", "sender_type", "status"]
|
|
535
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender'] && !opts[:'fields_text_messaging_sender'].all? { |item| allowable_values.include?(item) }
|
|
536
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender\", must include one of #{allowable_values}"
|
|
537
|
+
end
|
|
538
|
+
allowable_values = ["text-messaging-sender-registration"]
|
|
539
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
540
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
541
|
+
end
|
|
542
|
+
# resource path
|
|
543
|
+
local_var_path = '/api/text-messaging-senders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
544
|
+
|
|
545
|
+
# query parameters
|
|
546
|
+
query_params = opts[:query_params] || {}
|
|
547
|
+
query_params[:'fields[text-messaging-sender-registration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender_registration'], :csv) if !opts[:'fields_text_messaging_sender_registration'].nil?
|
|
548
|
+
query_params[:'fields[text-messaging-sender]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender'], :csv) if !opts[:'fields_text_messaging_sender'].nil?
|
|
549
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
550
|
+
|
|
551
|
+
# header parameters
|
|
552
|
+
header_params = opts[:header_params] || {}
|
|
553
|
+
# klaviyo api revision
|
|
554
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
555
|
+
# HTTP header 'Accept' (if needed)
|
|
556
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
557
|
+
|
|
558
|
+
# form parameters
|
|
559
|
+
form_params = opts[:form_params] || {}
|
|
560
|
+
|
|
561
|
+
# http body (model)
|
|
562
|
+
post_body = opts[:debug_body]
|
|
563
|
+
|
|
564
|
+
# return_type
|
|
565
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
566
|
+
|
|
567
|
+
# auth_names
|
|
568
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
569
|
+
|
|
570
|
+
new_options = opts.merge(
|
|
571
|
+
:operation => :"TextMessagingApi.get_text_messaging_sender",
|
|
572
|
+
:header_params => header_params,
|
|
573
|
+
:query_params => query_params,
|
|
574
|
+
:form_params => form_params,
|
|
575
|
+
:body => post_body,
|
|
576
|
+
:auth_names => auth_names,
|
|
577
|
+
:return_type => return_type
|
|
578
|
+
)
|
|
579
|
+
|
|
580
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
581
|
+
if @api_client.config.debugging
|
|
582
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#get_text_messaging_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
583
|
+
end
|
|
584
|
+
return data, status_code, headers
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
# Get Text Messaging Sender Registration
|
|
588
|
+
# Retrieve a sender registration by ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_sender_registration.json)
|
|
589
|
+
# @param id [String] The unique identifier of the sender registration.
|
|
590
|
+
# @param [Hash] opts the optional parameters
|
|
591
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
592
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
593
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
594
|
+
# @return [Hash<String, Object>]
|
|
595
|
+
def get_text_messaging_sender_registration(id, opts = {})
|
|
596
|
+
data, _status_code, _headers = get_text_messaging_sender_registration_with_http_info(id, opts)
|
|
597
|
+
data
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# Get Text Messaging Sender Registration
|
|
601
|
+
# Retrieve a sender registration by ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_sender_registration.json)
|
|
602
|
+
# @param id [String] The unique identifier of the sender registration.
|
|
603
|
+
# @param [Hash] opts the optional parameters
|
|
604
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
605
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
606
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
607
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
608
|
+
def get_text_messaging_sender_registration_with_http_info(id, opts = {})
|
|
609
|
+
if @api_client.config.debugging
|
|
610
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.get_text_messaging_sender_registration ...'
|
|
611
|
+
end
|
|
612
|
+
# verify the required parameter 'id' is set
|
|
613
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
614
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TextMessagingApi.get_text_messaging_sender_registration"
|
|
615
|
+
end
|
|
616
|
+
allowable_values = ["created_at", "decided_at", "failures", "id", "status", "submitted_at", "updated_at"]
|
|
617
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender_registration'] && !opts[:'fields_text_messaging_sender_registration'].all? { |item| allowable_values.include?(item) }
|
|
618
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender_registration\", must include one of #{allowable_values}"
|
|
619
|
+
end
|
|
620
|
+
allowable_values = ["created_at", "forwarding_number", "id", "sender_details", "sender_details.country", "sender_identifier", "sender_type", "status"]
|
|
621
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender'] && !opts[:'fields_text_messaging_sender'].all? { |item| allowable_values.include?(item) }
|
|
622
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender\", must include one of #{allowable_values}"
|
|
623
|
+
end
|
|
624
|
+
allowable_values = ["text-messaging-sender"]
|
|
625
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
626
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
627
|
+
end
|
|
628
|
+
# resource path
|
|
629
|
+
local_var_path = '/api/text-messaging-sender-registrations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
630
|
+
|
|
631
|
+
# query parameters
|
|
632
|
+
query_params = opts[:query_params] || {}
|
|
633
|
+
query_params[:'fields[text-messaging-sender-registration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender_registration'], :csv) if !opts[:'fields_text_messaging_sender_registration'].nil?
|
|
634
|
+
query_params[:'fields[text-messaging-sender]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender'], :csv) if !opts[:'fields_text_messaging_sender'].nil?
|
|
635
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
636
|
+
|
|
637
|
+
# header parameters
|
|
638
|
+
header_params = opts[:header_params] || {}
|
|
639
|
+
# klaviyo api revision
|
|
640
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
641
|
+
# HTTP header 'Accept' (if needed)
|
|
642
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
643
|
+
|
|
644
|
+
# form parameters
|
|
645
|
+
form_params = opts[:form_params] || {}
|
|
646
|
+
|
|
647
|
+
# http body (model)
|
|
648
|
+
post_body = opts[:debug_body]
|
|
649
|
+
|
|
650
|
+
# return_type
|
|
651
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
652
|
+
|
|
653
|
+
# auth_names
|
|
654
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
655
|
+
|
|
656
|
+
new_options = opts.merge(
|
|
657
|
+
:operation => :"TextMessagingApi.get_text_messaging_sender_registration",
|
|
658
|
+
:header_params => header_params,
|
|
659
|
+
:query_params => query_params,
|
|
660
|
+
:form_params => form_params,
|
|
661
|
+
:body => post_body,
|
|
662
|
+
:auth_names => auth_names,
|
|
663
|
+
:return_type => return_type
|
|
664
|
+
)
|
|
665
|
+
|
|
666
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
667
|
+
if @api_client.config.debugging
|
|
668
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#get_text_messaging_sender_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
669
|
+
end
|
|
670
|
+
return data, status_code, headers
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
# Get Text Messaging Senders
|
|
674
|
+
# List the calling company's text-messaging senders.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_senders.json)
|
|
675
|
+
# @param [Hash] opts the optional parameters
|
|
676
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
677
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
678
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
679
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
680
|
+
# @option opts [Integer] :page_size Default: 10. Min: 1. Max: 20. (default to 10)
|
|
681
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
682
|
+
# @return [Hash<String, Object>]
|
|
683
|
+
def get_text_messaging_senders(opts = {})
|
|
684
|
+
data, _status_code, _headers = get_text_messaging_senders_with_http_info(opts)
|
|
685
|
+
data
|
|
686
|
+
end
|
|
687
|
+
|
|
688
|
+
# Get Text Messaging Senders
|
|
689
|
+
# List the calling company's text-messaging senders.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `sender-config:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_text_messaging_senders.json)
|
|
690
|
+
# @param [Hash] opts the optional parameters
|
|
691
|
+
# @option opts [Array<String>] :fields_text_messaging_sender_registration For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
692
|
+
# @option opts [Array<String>] :fields_text_messaging_sender For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
693
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
694
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
695
|
+
# @option opts [Integer] :page_size Default: 10. Min: 1. Max: 20. (default to 10)
|
|
696
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
697
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
698
|
+
def get_text_messaging_senders_with_http_info(opts = {})
|
|
699
|
+
if @api_client.config.debugging
|
|
700
|
+
@api_client.config.logger.debug 'Calling API: TextMessagingApi.get_text_messaging_senders ...'
|
|
701
|
+
end
|
|
702
|
+
allowable_values = ["created_at", "decided_at", "failures", "id", "status", "submitted_at", "updated_at"]
|
|
703
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender_registration'] && !opts[:'fields_text_messaging_sender_registration'].all? { |item| allowable_values.include?(item) }
|
|
704
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender_registration\", must include one of #{allowable_values}"
|
|
705
|
+
end
|
|
706
|
+
allowable_values = ["created_at", "forwarding_number", "id", "sender_details", "sender_details.country", "sender_identifier", "sender_type", "status"]
|
|
707
|
+
if @api_client.config.client_side_validation && opts[:'fields_text_messaging_sender'] && !opts[:'fields_text_messaging_sender'].all? { |item| allowable_values.include?(item) }
|
|
708
|
+
fail ArgumentError, "invalid value for \"fields_text_messaging_sender\", must include one of #{allowable_values}"
|
|
709
|
+
end
|
|
710
|
+
allowable_values = ["text-messaging-sender-registration"]
|
|
711
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
712
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
713
|
+
end
|
|
714
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 20
|
|
715
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TextMessagingApi.get_text_messaging_senders, must be smaller than or equal to 20.'
|
|
716
|
+
end
|
|
717
|
+
|
|
718
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
719
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TextMessagingApi.get_text_messaging_senders, must be greater than or equal to 1.'
|
|
720
|
+
end
|
|
721
|
+
|
|
722
|
+
allowable_values = ["created_at", "-created_at"]
|
|
723
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
724
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
725
|
+
end
|
|
726
|
+
# resource path
|
|
727
|
+
local_var_path = '/api/text-messaging-senders'
|
|
728
|
+
|
|
729
|
+
# query parameters
|
|
730
|
+
query_params = opts[:query_params] || {}
|
|
731
|
+
query_params[:'fields[text-messaging-sender-registration]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender_registration'], :csv) if !opts[:'fields_text_messaging_sender_registration'].nil?
|
|
732
|
+
query_params[:'fields[text-messaging-sender]'] = @api_client.build_collection_param(opts[:'fields_text_messaging_sender'], :csv) if !opts[:'fields_text_messaging_sender'].nil?
|
|
733
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
734
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
735
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
736
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
737
|
+
|
|
738
|
+
# header parameters
|
|
739
|
+
header_params = opts[:header_params] || {}
|
|
740
|
+
# klaviyo api revision
|
|
741
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
742
|
+
# HTTP header 'Accept' (if needed)
|
|
743
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
744
|
+
|
|
745
|
+
# form parameters
|
|
746
|
+
form_params = opts[:form_params] || {}
|
|
747
|
+
|
|
748
|
+
# http body (model)
|
|
749
|
+
post_body = opts[:debug_body]
|
|
750
|
+
|
|
751
|
+
# return_type
|
|
752
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
753
|
+
|
|
754
|
+
# auth_names
|
|
755
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
756
|
+
|
|
757
|
+
new_options = opts.merge(
|
|
758
|
+
:operation => :"TextMessagingApi.get_text_messaging_senders",
|
|
759
|
+
:header_params => header_params,
|
|
760
|
+
:query_params => query_params,
|
|
761
|
+
:form_params => form_params,
|
|
762
|
+
:body => post_body,
|
|
763
|
+
:auth_names => auth_names,
|
|
764
|
+
:return_type => return_type
|
|
765
|
+
)
|
|
766
|
+
|
|
767
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
768
|
+
if @api_client.config.debugging
|
|
769
|
+
@api_client.config.logger.debug "API called: TextMessagingApi#get_text_messaging_senders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
770
|
+
end
|
|
771
|
+
return data, status_code, headers
|
|
772
|
+
end
|
|
773
|
+
end
|
|
774
|
+
end
|