klaviyo-api-sdk 16.0.0 → 18.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 +33 -0
- data/README.md +975 -411
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +215 -155
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
- data/lib/klaviyo-api-sdk/api/client_api.rb +100 -0
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +91 -0
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +187 -108
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +2755 -83
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +83 -58
- data/lib/klaviyo-api-sdk/api/flows_api.rb +238 -152
- data/lib/klaviyo-api-sdk/api/forms_api.rb +81 -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 +589 -221
- 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 +159 -78
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
- 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.rb +36 -2
- data/lib/klaviyo-api-sdk/models/ab_test_action_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/ab_test_action_data_current_experiment.rb +1 -0
- data/lib/klaviyo-api-sdk/models/action_output_condition.rb +36 -2
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +78 -195
- data/lib/klaviyo-api-sdk/models/action_output_split_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +2 -6
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data_action_output_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data_action_output_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/after_close_timeout.rb +36 -1
- data/lib/klaviyo-api-sdk/models/age_gate.rb +14 -1
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +26 -2
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +301 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock.rb +36 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_drop_shadow_styles.rb +37 -4
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_text_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox.rb +36 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +26 -2
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +48 -2
- 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.rb +295 -0
- data/lib/klaviyo-api-sdk/models/base_style_properties.rb +269 -0
- data/lib/klaviyo-api-sdk/models/base_style_styles.rb +420 -0
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/body.rb +259 -0
- data/lib/klaviyo-api-sdk/models/body_properties.rb +229 -0
- data/lib/klaviyo-api-sdk/models/body_styles.rb +229 -0
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/button.rb +36 -1
- data/lib/klaviyo-api-sdk/models/button_action.rb +2 -0
- data/lib/klaviyo-api-sdk/models/button_block_data.rb +261 -0
- data/lib/klaviyo-api-sdk/models/button_block_properties.rb +219 -0
- data/lib/klaviyo-api-sdk/models/button_block_styles.rb +520 -0
- data/lib/klaviyo-api-sdk/models/button_block_v0.rb +293 -0
- data/lib/klaviyo-api-sdk/models/button_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/button_drop_shadow_styles.rb +264 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +39 -8
- data/lib/klaviyo-api-sdk/models/button_styles_height.rb +104 -0
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +14 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +36 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/cart_content.rb +277 -0
- data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
- data/lib/klaviyo-api-sdk/models/cart_item_count.rb +36 -1
- data/lib/klaviyo-api-sdk/models/cart_product.rb +36 -1
- data/lib/klaviyo-api-sdk/models/cart_value.rb +36 -1
- data/lib/klaviyo-api-sdk/models/channel.rb +36 -1
- data/lib/klaviyo-api-sdk/models/checkboxes.rb +36 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/close.rb +36 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/column_v0.rb +240 -0
- data/lib/klaviyo-api-sdk/models/column_v1.rb +256 -0
- data/lib/klaviyo-api-sdk/models/column_v1_blocks_inner.rb +117 -0
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +6 -0
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +49 -3
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/constant_property_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/constant_property_mapping_value.rb +107 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +42 -4
- data/lib/klaviyo-api-sdk/models/content_experiment_action_data.rb +302 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_data_current_experiment.rb +311 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_data_main_action.rb +104 -0
- data/lib/klaviyo-api-sdk/models/content_repeat_v0.rb +237 -0
- data/lib/klaviyo-api-sdk/models/content_repeat_v1.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conversation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_relationships_conversation.rb +218 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_relationships_conversation_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/countdown_timer.rb +36 -1
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/countdown_timer_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon.rb +36 -1
- data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +265 -0
- data/lib/klaviyo-api-sdk/models/coupon_block_properties.rb +249 -0
- data/lib/klaviyo-api-sdk/models/coupon_block_styles.rb +570 -0
- data/lib/klaviyo-api-sdk/models/coupon_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/coupon_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_css.rb +231 -0
- data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +263 -0
- data/lib/klaviyo-api-sdk/models/custom_javascript.rb +36 -1
- data/lib/klaviyo-api-sdk/models/custom_metric_condition_filter.rb +5 -5
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +450 -0
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +299 -0
- data/lib/klaviyo-api-sdk/models/custom_object_relationship_source.rb +328 -0
- data/lib/klaviyo-api-sdk/models/custom_object_trigger_condition.rb +285 -0
- data/lib/klaviyo-api-sdk/models/custom_object_trigger_condition_filter.rb +113 -0
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object_attributes.rb +22 -10
- data/lib/klaviyo-api-sdk/models/data_warehouse_import_method_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/date.rb +36 -1
- data/lib/klaviyo-api-sdk/models/date_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/delay.rb +36 -1
- data/lib/klaviyo-api-sdk/models/device.rb +36 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +2 -2
- data/lib/klaviyo-api-sdk/models/display_options.rb +292 -0
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_styles.rb +314 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +293 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/dropdown.rb +36 -1
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/dynamic_button.rb +1 -0
- data/lib/klaviyo-api-sdk/models/dynamic_image_block_properties.rb +287 -0
- data/lib/klaviyo-api-sdk/models/dynamic_product_block_properties.rb +407 -0
- data/lib/klaviyo-api-sdk/models/dynamic_review_block_properties.rb +469 -0
- data/lib/klaviyo-api-sdk/models/dynamic_table_block_properties.rb +306 -0
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +14 -1
- data/lib/klaviyo-api-sdk/models/effective_date_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/email.rb +36 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/email_properties.rb +26 -2
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -9
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -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/equals_string_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +14 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_existence_filter.rb +284 -0
- data/lib/klaviyo-api-sdk/models/exit_intent.rb +36 -1
- data/lib/klaviyo-api-sdk/models/explicitly_reachable.rb +35 -1
- data/lib/klaviyo-api-sdk/models/explicitly_unreachable.rb +35 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/fixed_timer_configuration.rb +13 -1
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -2
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +14 -5
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -2
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +6 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +2 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +71 -4
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +26 -2
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +14 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +36 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +2 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +13 -1
- data/lib/klaviyo-api-sdk/models/flows_profile_metric_condition.rb +14 -2
- data/lib/klaviyo-api-sdk/models/flows_profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/form_subscribe_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/go_to_inbox.rb +14 -1
- data/lib/klaviyo-api-sdk/models/greater_than_positive_numeric_filter.rb +49 -3
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +35 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +13 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +35 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +13 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +13 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/header_block_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/header_block_styles.rb +635 -0
- data/lib/klaviyo-api-sdk/models/header_block_v1.rb +339 -0
- data/lib/klaviyo-api-sdk/models/header_block_v1_subblocks_inner.rb +105 -0
- data/lib/klaviyo-api-sdk/models/header_image_sub_block.rb +370 -0
- data/lib/klaviyo-api-sdk/models/header_link_sub_block.rb +330 -0
- data/lib/klaviyo-api-sdk/models/header_logo_sub_block.rb +360 -0
- data/lib/klaviyo-api-sdk/models/heading1_style.rb +281 -0
- data/lib/klaviyo-api-sdk/models/heading2_style.rb +281 -0
- data/lib/klaviyo-api-sdk/models/heading3_style.rb +281 -0
- data/lib/klaviyo-api-sdk/models/heading4_style.rb +281 -0
- data/lib/klaviyo-api-sdk/models/heading_style_styles.rb +377 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block_styles.rb +334 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block_v0.rb +293 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/html_block_data_v0.rb +237 -0
- data/lib/klaviyo-api-sdk/models/html_block_data_v1.rb +237 -0
- data/lib/klaviyo-api-sdk/models/html_block_v0.rb +297 -0
- data/lib/klaviyo-api-sdk/models/html_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/html_text.rb +36 -1
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/identified_profiles.rb +36 -1
- data/lib/klaviyo-api-sdk/models/image.rb +36 -1
- data/lib/klaviyo-api-sdk/models/image_action.rb +2 -0
- data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +279 -0
- data/lib/klaviyo-api-sdk/models/image_block_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/image_block_data_properties.rb +104 -0
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +447 -0
- data/lib/klaviyo-api-sdk/models/image_block_v0.rb +293 -0
- data/lib/klaviyo-api-sdk/models/image_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/image_drop_shadow_styles.rb +264 -0
- data/lib/klaviyo-api-sdk/models/image_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +35 -1
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_reachable.rb +35 -1
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_unreachable.rb +35 -1
- data/lib/klaviyo-api-sdk/models/implicitly_reachable.rb +35 -1
- data/lib/klaviyo-api-sdk/models/implicitly_unreachable.rb +35 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +26 -2
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/increment.rb +35 -1
- data/lib/klaviyo-api-sdk/models/input_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integer_filter.rb +298 -0
- data/lib/klaviyo-api-sdk/models/internal_scheduled_report_builder_report_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/internal_scheduled_report_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action.rb +37 -4
- data/lib/klaviyo-api-sdk/models/internal_service_action_data.rb +265 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action_data_service_configuration.rb +106 -0
- data/lib/klaviyo-api-sdk/models/internal_track_event_data.rb +287 -0
- data/lib/klaviyo-api-sdk/models/internal_unknown_service_data.rb +257 -0
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/less_than_positive_numeric_filter.rb +49 -3
- data/lib/klaviyo-api-sdk/models/link_style.rb +281 -0
- data/lib/klaviyo-api-sdk/models/link_style_styles.rb +284 -0
- data/lib/klaviyo-api-sdk/models/link_styles.rb +37 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_list_contains_filter.rb +294 -0
- data/lib/klaviyo-api-sdk/models/list_contains_operator_list_contains_filter_value.rb +104 -0
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/list_regex_operator_list_contains_filter.rb +294 -0
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +35 -1
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/lists_and_segments.rb +36 -1
- data/lib/klaviyo-api-sdk/models/location.rb +36 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +36 -2
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +15 -7
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/manual_add_manual_method_filter.rb +292 -0
- data/lib/klaviyo-api-sdk/models/manual_import_manual_method_filter.rb +292 -0
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +50 -13
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/method_filter.rb +13 -1
- 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 +36 -2
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +87 -195
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +37 -2
- data/lib/klaviyo-api-sdk/models/metric_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/metric_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_message_silent_definition_create.rb +51 -2
- data/lib/klaviyo-api-sdk/models/mobile_push_message_silent_definition_update.rb +51 -2
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +51 -2
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_update.rb +51 -2
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +2 -1
- data/lib/klaviyo-api-sdk/models/mobile_style.rb +295 -0
- data/lib/klaviyo-api-sdk/models/mobile_style_properties.rb +219 -0
- data/lib/klaviyo-api-sdk/models/mobile_style_styles.rb +279 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action.rb +298 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch.rb +273 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +122 -0
- data/lib/klaviyo-api-sdk/models/next_step.rb +36 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +13 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +13 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +13 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +35 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +2 -2
- data/lib/klaviyo-api-sdk/models/numeric_operator_numeric_filter.rb +298 -0
- data/lib/klaviyo-api-sdk/models/numeric_operator_numeric_filter_value.rb +104 -0
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +15 -3
- 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/object_record_delete_job_rels_records_data_inner.rb +238 -0
- 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/object_schema_relationship_create_query.rb +225 -0
- 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/object_type_create_query_resource_object_attributes.rb +307 -0
- 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/one_click_unsubscribe_method_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/open_form.rb +14 -1
- data/lib/klaviyo-api-sdk/models/open_tracking_subscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code.rb +36 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +26 -2
- data/lib/klaviyo-api-sdk/models/page_visits.rb +36 -1
- data/lib/klaviyo-api-sdk/models/patch_identifiers.rb +227 -0
- data/lib/klaviyo-api-sdk/models/phone_number.rb +36 -1
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/previously_submitted.rb +36 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +36 -2
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +16 -8
- data/lib/klaviyo-api-sdk/models/price_drop_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/price_drop_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/product_block_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/product_block_data_properties.rb +104 -0
- data/lib/klaviyo-api-sdk/models/product_block_styles.rb +1154 -0
- data/lib/klaviyo-api-sdk/models/product_block_v1.rb +339 -0
- data/lib/klaviyo-api-sdk/models/product_sub_block.rb +397 -0
- data/lib/klaviyo-api-sdk/models/profile_event_tracked.rb +36 -1
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +19 -9
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_condition.rb +315 -0
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +113 -0
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +4 -4
- data/lib/klaviyo-api-sdk/models/profile_modification_method_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +35 -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_operation_update_or_create_boolean.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +14 -2
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +28 -4
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +28 -4
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_date_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +14 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +7 -7
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +26 -2
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +35 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/profile_relationship_source.rb +330 -0
- data/lib/klaviyo-api-sdk/models/promotional_sms_subscription.rb +14 -1
- data/lib/klaviyo-api-sdk/models/property.rb +35 -1
- data/lib/klaviyo-api-sdk/models/property_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/property_source.rb +254 -0
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/push_action_button.rb +312 -0
- data/lib/klaviyo-api-sdk/models/push_action_button_definition.rb +261 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +35 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +35 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_web_url.rb +268 -0
- data/lib/klaviyo-api-sdk/models/push_subscription_parameters.rb +247 -0
- data/lib/klaviyo-api-sdk/models/push_token_device_metadata.rb +399 -0
- data/lib/klaviyo-api-sdk/models/push_token_entry.rb +355 -0
- data/lib/klaviyo-api-sdk/models/push_unsubscription_parameters.rb +240 -0
- data/lib/klaviyo-api-sdk/models/quote_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons.rb +36 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/recorded_date_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/redirect.rb +36 -1
- data/lib/klaviyo-api-sdk/models/redirect_properties.rb +2 -5
- data/lib/klaviyo-api-sdk/models/reentry_criteria.rb +237 -0
- data/lib/klaviyo-api-sdk/models/reentry_criteria_unit.rb +103 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +36 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +36 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +36 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +36 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +36 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +36 -1
- data/lib/klaviyo-api-sdk/models/related_id_path.rb +273 -0
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_relative_date_filter.rb +325 -0
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/resend_opt_in_code.rb +14 -1
- data/lib/klaviyo-api-sdk/models/review.rb +36 -1
- data/lib/klaviyo-api-sdk/models/review_block_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/review_block_data_properties.rb +104 -0
- data/lib/klaviyo-api-sdk/models/review_block_styles.rb +966 -0
- data/lib/klaviyo-api-sdk/models/review_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/review_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +36 -1
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +36 -1
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +36 -1
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +36 -1
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +36 -1
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/rich_text_margin.rb +9 -9
- data/lib/klaviyo-api-sdk/models/rich_text_style.rb +22 -2
- data/lib/klaviyo-api-sdk/models/row_data.rb +223 -0
- data/lib/klaviyo-api-sdk/models/row_styles.rb +254 -0
- data/lib/klaviyo-api-sdk/models/row_v0.rb +236 -0
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +123 -0
- data/lib/klaviyo-api-sdk/models/row_v1.rb +255 -0
- data/lib/klaviyo-api-sdk/models/scroll.rb +36 -1
- data/lib/klaviyo-api-sdk/models/section_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/section_properties.rb +229 -0
- data/lib/klaviyo-api-sdk/models/section_styles.rb +499 -0
- data/lib/klaviyo-api-sdk/models/section_v1.rb +339 -0
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +16 -5
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +35 -1
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_condition.rb +14 -2
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_funnel_condition.rb +13 -1
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_funnel_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +49 -3
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/signup_counter.rb +36 -1
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/simple_property_mapping.rb +287 -0
- 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/since_flow_start_date_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/skip_to_success.rb +315 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +35 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox.rb +36 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +26 -2
- data/lib/klaviyo-api-sdk/models/sms_disclosure.rb +36 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_account_default.rb +35 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_custom.rb +35 -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 +11 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_text_style.rb +26 -6
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +35 -1
- data/lib/klaviyo-api-sdk/models/social_block_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/social_block_properties.rb +219 -0
- data/lib/klaviyo-api-sdk/models/social_block_styles.rb +443 -0
- data/lib/klaviyo-api-sdk/models/social_block_v1.rb +339 -0
- data/lib/klaviyo-api-sdk/models/social_block_v1_subblocks_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/social_icon_sub_block.rb +340 -0
- data/lib/klaviyo-api-sdk/models/social_spacer_sub_block.rb +277 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes.rb +235 -0
- 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/spacer_block_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/spacer_block_styles.rb +229 -0
- data/lib/klaviyo-api-sdk/models/spacer_block_v0.rb +293 -0
- data/lib/klaviyo-api-sdk/models/spacer_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/spin_to_win.rb +36 -1
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/spin_to_win_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/split_block_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/split_block_styles.rb +324 -0
- data/lib/klaviyo-api-sdk/models/split_block_v1.rb +339 -0
- data/lib/klaviyo-api-sdk/models/split_block_v1_subblocks_inner.rb +105 -0
- data/lib/klaviyo-api-sdk/models/static_count.rb +35 -1
- data/lib/klaviyo-api-sdk/models/static_coupon_config.rb +35 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +13 -1
- data/lib/klaviyo-api-sdk/models/static_image_block_properties.rb +302 -0
- data/lib/klaviyo-api-sdk/models/static_product_block_properties.rb +403 -0
- data/lib/klaviyo-api-sdk/models/static_review_block_properties.rb +426 -0
- data/lib/klaviyo-api-sdk/models/static_send_strategy.rb +35 -1
- data/lib/klaviyo-api-sdk/models/static_table_block_properties.rb +273 -0
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +36 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/step.rb +2 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_string_array_filter.rb +300 -0
- data/lib/klaviyo-api-sdk/models/string_in_array_filter.rb +48 -2
- data/lib/klaviyo-api-sdk/models/string_operator_string_filter.rb +294 -0
- data/lib/klaviyo-api-sdk/models/string_phone_operator_string_array_filter.rb +300 -0
- data/lib/klaviyo-api-sdk/models/submit_back_in_stock.rb +14 -1
- data/lib/klaviyo-api-sdk/models/submit_opt_in_code.rb +14 -1
- data/lib/klaviyo-api-sdk/models/subscribe_via_sms.rb +14 -1
- data/lib/klaviyo-api-sdk/models/subscribe_via_whats_app.rb +14 -1
- data/lib/klaviyo-api-sdk/models/subscribed_smsis_rcs_capable_filter.rb +35 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +13 -4
- data/lib/klaviyo-api-sdk/models/table_block_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/table_block_data_properties.rb +104 -0
- data/lib/klaviyo-api-sdk/models/table_block_styles.rb +689 -0
- data/lib/klaviyo-api-sdk/models/table_block_v1.rb +339 -0
- data/lib/klaviyo-api-sdk/models/table_block_v1_subblocks_inner.rb +109 -0
- data/lib/klaviyo-api-sdk/models/table_fallback_html_sub_block.rb +300 -0
- data/lib/klaviyo-api-sdk/models/table_fallback_image_sub_block.rb +496 -0
- data/lib/klaviyo-api-sdk/models/table_fallback_text_sub_block.rb +416 -0
- data/lib/klaviyo-api-sdk/models/table_header_sub_block.rb +416 -0
- data/lib/klaviyo-api-sdk/models/table_html_sub_block.rb +300 -0
- data/lib/klaviyo-api-sdk/models/table_image_sub_block.rb +496 -0
- data/lib/klaviyo-api-sdk/models/table_text_sub_block.rb +416 -0
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/teaser.rb +1 -0
- data/lib/klaviyo-api-sdk/models/template_create_html_or_dnd_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/template_create_html_or_dnd_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/template_create_html_or_dnd_query_resource_object_attributes.rb +281 -0
- data/lib/klaviyo-api-sdk/models/template_definition.rb +260 -0
- data/lib/klaviyo-api-sdk/models/template_definition_styles_inner.rb +110 -0
- data/lib/klaviyo-api-sdk/models/template_update_html_or_dnd_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/template_update_html_or_dnd_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/template_update_html_or_dnd_query_resource_object_attributes.rb +262 -0
- data/lib/klaviyo-api-sdk/models/text.rb +36 -1
- data/lib/klaviyo-api-sdk/models/text_block_data_v0.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_block_data_v1.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +533 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles_v1.rb +533 -0
- data/lib/klaviyo-api-sdk/models/text_block_v0.rb +297 -0
- data/lib/klaviyo-api-sdk/models/text_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/text_style_styles.rb +367 -0
- data/lib/klaviyo-api-sdk/models/text_style_v0.rb +319 -0
- data/lib/klaviyo-api-sdk/models/text_style_v0_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_style_v1.rb +281 -0
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +13 -1
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +2 -6
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner_conditions_inner.rb +107 -0
- data/lib/klaviyo-api-sdk/models/unidentified_profiles.rb +36 -1
- data/lib/klaviyo-api-sdk/models/unique_coupon_config.rb +13 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +7 -7
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +7 -7
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +13 -4
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +36 -2
- data/lib/klaviyo-api-sdk/models/url_patterns.rb +36 -1
- data/lib/klaviyo-api-sdk/models/variable_timer_configuration.rb +35 -1
- data/lib/klaviyo-api-sdk/models/version.rb +40 -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/video_block_data.rb +251 -0
- data/lib/klaviyo-api-sdk/models/video_block_properties.rb +279 -0
- data/lib/klaviyo-api-sdk/models/video_block_styles.rb +447 -0
- data/lib/klaviyo-api-sdk/models/video_block_v1.rb +327 -0
- data/lib/klaviyo-api-sdk/models/visibility.rb +239 -0
- data/lib/klaviyo-api-sdk.rb +273 -237
- data/lib/klaviyo-api-sdk.rb.bak +274 -238
- metadata +279 -1346
- data/Gemfile +0 -9
- data/Rakefile +0 -10
- data/docs/APIMethodFilter.md +0 -22
- data/docs/AccountsApi.md +0 -157
- data/docs/AlltimeDateFilter.md +0 -20
- data/docs/AnniversaryDateFilter.md +0 -20
- data/docs/AnyEnum.md +0 -15
- data/docs/ApiEnum.md +0 -15
- data/docs/AudiencesSubObject.md +0 -20
- data/docs/BackInStockEnum.md +0 -15
- data/docs/BackInStockMethodFilter.md +0 -20
- data/docs/BackInStockSubscriptionEnum.md +0 -15
- data/docs/BaseEventCreateQueryResourceObject.md +0 -20
- data/docs/BaseEventCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/BooleanEnum.md +0 -15
- data/docs/BooleanFilter.md +0 -22
- data/docs/BounceDateEnum.md +0 -15
- data/docs/BounceDateFilter.md +0 -20
- data/docs/BounceDateFilterFilter.md +0 -61
- data/docs/BulkRemoveEnum.md +0 -15
- data/docs/BulkRemoveMethodFilter.md +0 -20
- data/docs/CalendarDateFilter.md +0 -22
- data/docs/CampaignCloneQuery.md +0 -18
- data/docs/CampaignCloneQueryResourceObject.md +0 -22
- data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignCreateQuery.md +0 -18
- data/docs/CampaignCreateQueryResourceObject.md +0 -20
- data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
- data/docs/CampaignCreateQueryResourceObjectAttributesCampaignMessages.md +0 -18
- data/docs/CampaignCreateQueryResourceObjectAttributesSendOptions.md +0 -49
- data/docs/CampaignCreateQueryResourceObjectAttributesTrackingOptions.md +0 -49
- data/docs/CampaignEnum.md +0 -15
- data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -22
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +0 -18
- data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +0 -20
- data/docs/CampaignMessageCreateQueryResourceObject.md +0 -20
- data/docs/CampaignMessageCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CampaignMessageCreateQueryResourceObjectAttributesContent.md +0 -49
- data/docs/CampaignMessageEnum.md +0 -15
- data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
- data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -22
- data/docs/CampaignPartialUpdateQuery.md +0 -18
- data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
- data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
- data/docs/CampaignSendJobCreateQuery.md +0 -18
- data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
- data/docs/CampaignSendJobEnum.md +0 -15
- data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
- data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
- data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CampaignValuesReportEnum.md +0 -15
- data/docs/CampaignValuesRequestDTO.md +0 -18
- data/docs/CampaignValuesRequestDTOResourceObject.md +0 -20
- data/docs/CampaignValuesRequestDTOResourceObjectAttributes.md +0 -24
- data/docs/CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md +0 -49
- data/docs/CampaignsApi.md +0 -1735
- data/docs/CarrierDeactivationEnum.md +0 -15
- data/docs/CarrierDeactivationMethodFilter.md +0 -20
- data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.md +0 -18
- data/docs/CatalogCategoryCreateQuery.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
- data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +0 -18
- data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.md +0 -18
- data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryEnum.md +0 -15
- data/docs/CatalogCategoryItemOp.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.md +0 -18
- data/docs/CatalogCategoryUpdateQuery.md +0 -18
- data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
- data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogItemCategoryOp.md +0 -18
- data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.md +0 -18
- data/docs/CatalogItemCreateQuery.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
- data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
- data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.md +0 -18
- data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogItemEnum.md +0 -15
- data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.md +0 -18
- data/docs/CatalogItemUpdateQuery.md +0 -18
- data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
- data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
- data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
- data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
- data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
- data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.md +0 -18
- data/docs/CatalogVariantCreateQuery.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
- data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +0 -18
- data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md +0 -18
- data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
- data/docs/CatalogVariantEnum.md +0 -15
- data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md +0 -18
- data/docs/CatalogVariantUpdateQuery.md +0 -18
- data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
- data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
- data/docs/CatalogsApi.md +0 -4103
- data/docs/CheckoutEnum.md +0 -15
- data/docs/CheckoutMethodFilter.md +0 -20
- data/docs/ConditionGroup.md +0 -18
- data/docs/ConditionGroupConditionsInner.md +0 -63
- data/docs/ConstantContactEnum.md +0 -15
- data/docs/ConstantContactIntegrationFilter.md +0 -22
- data/docs/ConstantContactIntegrationMethodFilter.md +0 -22
- data/docs/CouponCodeBulkCreateJobEnum.md +0 -15
- data/docs/CouponCodeCreateJobCreateQuery.md +0 -18
- data/docs/CouponCodeCreateJobCreateQueryResourceObject.md +0 -20
- data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributesCouponCodes.md +0 -18
- data/docs/CouponCodeCreateQuery.md +0 -18
- data/docs/CouponCodeCreateQueryResourceObject.md +0 -22
- data/docs/CouponCodeCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCoupon.md +0 -18
- data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCouponData.md +0 -20
- data/docs/CouponCodeEnum.md +0 -15
- data/docs/CouponCodeUpdateQuery.md +0 -18
- data/docs/CouponCodeUpdateQueryResourceObject.md +0 -22
- data/docs/CouponCodeUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/CouponCreateQuery.md +0 -18
- data/docs/CouponCreateQueryResourceObject.md +0 -20
- data/docs/CouponCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/CouponEnum.md +0 -15
- data/docs/CouponUpdateQuery.md +0 -18
- data/docs/CouponUpdateQueryResourceObject.md +0 -22
- data/docs/CouponUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/CouponsApi.md +0 -1289
- data/docs/CustomSourceEnum.md +0 -15
- data/docs/CustomSourceFilter.md +0 -20
- data/docs/CustomTimeframe.md +0 -20
- data/docs/DataPrivacyApi.md +0 -78
- data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -18
- data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md +0 -18
- data/docs/DataPrivacyDeletionJobEnum.md +0 -15
- data/docs/DataPrivacyProfileQueryResourceObject.md +0 -22
- data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md +0 -20
- data/docs/DateEnum.md +0 -15
- data/docs/DeviceMetadata.md +0 -40
- data/docs/DoubleOptinFilter.md +0 -20
- data/docs/EmailContentSubObject.md +0 -30
- data/docs/EmailEnum.md +0 -15
- data/docs/EmailSendOptionsSubObject.md +0 -18
- data/docs/EmailSubscriptionParameters.md +0 -18
- data/docs/EmailTrackingOptionsSubObject.md +0 -24
- data/docs/EqualsEnum.md +0 -15
- data/docs/EqualsStringFilter.md +0 -22
- data/docs/EventBulkCreateEnum.md +0 -15
- data/docs/EventBulkCreateJobEnum.md +0 -15
- data/docs/EventCreateQueryV2.md +0 -18
- data/docs/EventCreateQueryV2ResourceObject.md +0 -20
- data/docs/EventCreateQueryV2ResourceObjectAttributes.md +0 -30
- data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md +0 -18
- data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +0 -18
- data/docs/EventEnum.md +0 -15
- data/docs/EventProfileCreateQueryResourceObject.md +0 -22
- data/docs/EventProfileCreateQueryResourceObjectAttributes.md +0 -42
- data/docs/EventsApi.md +0 -615
- data/docs/EventsBulkCreateJob.md +0 -18
- data/docs/EventsBulkCreateJobResourceObject.md +0 -20
- data/docs/EventsBulkCreateJobResourceObjectAttributes.md +0 -18
- data/docs/EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate.md +0 -18
- data/docs/EventsBulkCreateQueryResourceObject.md +0 -20
- data/docs/EventsBulkCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/EventsBulkCreateQueryResourceObjectAttributesEvents.md +0 -18
- data/docs/EventsBulkCreateQueryResourceObjectAttributesProfile.md +0 -18
- data/docs/ExistenceEnum.md +0 -15
- data/docs/ExistenceOperatorFilter.md +0 -20
- data/docs/FailedAgeGateEnum.md +0 -15
- data/docs/FailedAgeGateMethodFilter.md +0 -20
- data/docs/FlowEnum.md +0 -15
- data/docs/FlowSeriesReportEnum.md +0 -15
- data/docs/FlowSeriesRequestDTO.md +0 -18
- data/docs/FlowSeriesRequestDTOResourceObject.md +0 -20
- data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md +0 -26
- data/docs/FlowUpdateQuery.md +0 -18
- data/docs/FlowUpdateQueryResourceObject.md +0 -22
- data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
- data/docs/FlowValuesReportEnum.md +0 -15
- data/docs/FlowValuesRequestDTO.md +0 -18
- data/docs/FlowValuesRequestDTOResourceObject.md +0 -20
- data/docs/FlowValuesRequestDTOResourceObjectAttributes.md +0 -24
- data/docs/FlowsApi.md +0 -1406
- data/docs/FormEnum.md +0 -15
- data/docs/FormMethodFilter.md +0 -22
- data/docs/FormsApi.md +0 -549
- data/docs/GetAccounts4XXResponse.md +0 -18
- data/docs/GetAccounts4XXResponseErrorsInner.md +0 -26
- data/docs/GetAccounts4XXResponseErrorsInnerSource.md +0 -20
- data/docs/GreaterThanEnum.md +0 -15
- data/docs/HasEmailMarketing.md +0 -18
- data/docs/HasEmailMarketingConsent.md +0 -22
- data/docs/HasEmailMarketingConsentConsentStatus.md +0 -51
- data/docs/HasEmailMarketingNeverSubscribed.md +0 -18
- data/docs/HasEmailMarketingSubscribed.md +0 -20
- data/docs/HasEmailMarketingSubscribedFiltersInner.md +0 -69
- data/docs/HasPushMarketing.md +0 -20
- data/docs/HasPushMarketingConsent.md +0 -22
- data/docs/HasSMSMarketingConsent.md +0 -22
- data/docs/HasSMSMarketingSubscribed.md +0 -20
- data/docs/HasSMSMarketingSubscribedFiltersInner.md +0 -63
- data/docs/ImageCreateQuery.md +0 -18
- data/docs/ImageCreateQueryResourceObject.md +0 -20
- data/docs/ImageCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/ImageEnum.md +0 -15
- data/docs/ImagePartialUpdateQuery.md +0 -18
- data/docs/ImagePartialUpdateQueryResourceObject.md +0 -22
- data/docs/ImagePartialUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/ImagesApi.md +0 -389
- data/docs/InEnum.md +0 -15
- data/docs/InStringArrayFilter.md +0 -22
- data/docs/InboundMessageEnum.md +0 -15
- data/docs/InboundMessageMethodFilter.md +0 -20
- data/docs/IntegrationEnum.md +0 -15
- data/docs/InvalidEmailDateEnum.md +0 -15
- data/docs/InvalidEmailDateFilter.md +0 -20
- data/docs/IsDoubleOptInEnum.md +0 -15
- data/docs/IsSetEnum.md +0 -15
- data/docs/IsSetExistenceFilter.md +0 -20
- data/docs/LessThanEnum.md +0 -15
- data/docs/ListContainsOperatorFilter.md +0 -22
- data/docs/ListContainsOperatorFilterValue.md +0 -49
- data/docs/ListCreateQuery.md +0 -18
- data/docs/ListCreateQueryResourceObject.md +0 -20
- data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ListEnum.md +0 -15
- data/docs/ListLengthFilter.md +0 -22
- data/docs/ListMembersAddQuery.md +0 -18
- data/docs/ListMembersAddQueryDataInner.md +0 -20
- data/docs/ListMembersDeleteQuery.md +0 -18
- data/docs/ListPartialUpdateQuery.md +0 -18
- data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
- data/docs/ListSetFilter.md +0 -22
- data/docs/ListsApi.md +0 -852
- data/docs/MailboxProviderEnum.md +0 -15
- data/docs/MailboxProviderMethodFilter.md +0 -20
- data/docs/ManualAddEnum.md +0 -15
- data/docs/ManualAddMethodFilter.md +0 -22
- data/docs/ManualImportEnum.md +0 -15
- data/docs/ManualImportMethodFilter.md +0 -22
- data/docs/ManualRemoveEnum.md +0 -15
- data/docs/ManualRemoveMethodFilter.md +0 -20
- data/docs/ManualSuppressionDateEnum.md +0 -15
- data/docs/ManualSuppressionDateFilter.md +0 -20
- data/docs/MarketingSubscriptionParameters.md +0 -20
- data/docs/MessageBlockedEnum.md +0 -15
- data/docs/MessageBlockedMethodFilter.md +0 -20
- data/docs/MethodEnum.md +0 -15
- data/docs/MetricAggregateEnum.md +0 -15
- data/docs/MetricAggregateQuery.md +0 -18
- data/docs/MetricAggregateQueryResourceObject.md +0 -20
- data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
- data/docs/MetricCreateQueryResourceObject.md +0 -20
- data/docs/MetricCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/MetricEnum.md +0 -15
- data/docs/MetricsApi.md +0 -233
- data/docs/NeverSubscribedEnum.md +0 -15
- data/docs/NoEmailMarketing.md +0 -20
- data/docs/NoEmailMarketingConsent.md +0 -22
- data/docs/NoEmailMarketingConsentConsentStatus.md +0 -53
- data/docs/NoEmailMarketingFiltersInner.md +0 -51
- data/docs/NoEmailMarketingNeverSubscribed.md +0 -20
- data/docs/NoEmailMarketingSubscribed.md +0 -20
- data/docs/NoEmailMarketingUnsubscribed.md +0 -20
- data/docs/NoEmailMarketingUnsubscribedFilters.md +0 -49
- data/docs/NoEmailMarketingUnsubscribedFiltersOneOfInner.md +0 -61
- data/docs/NoPushMarketing.md +0 -18
- data/docs/NoPushMarketingConsent.md +0 -22
- data/docs/NoSMSMarketing.md +0 -18
- data/docs/NoSMSMarketingConsent.md +0 -22
- data/docs/NoSMSMarketingConsentConsentStatus.md +0 -51
- data/docs/NoSMSMarketingNeverSubscribed.md +0 -18
- data/docs/NoSMSMarketingUnsubscribed.md +0 -20
- data/docs/NoSMSMarketingUnsubscribedFiltersInner.md +0 -77
- data/docs/NotEqualsEnum.md +0 -15
- data/docs/NumericEnum.md +0 -15
- data/docs/NumericOperatorFilter.md +0 -22
- data/docs/NumericOperatorFilterValue.md +0 -49
- data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -24
- data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -40
- data/docs/OnsiteProfileMeta.md +0 -18
- data/docs/PreferencePageEnum.md +0 -15
- data/docs/PreferencePageFilter.md +0 -22
- data/docs/PreferencePageMethodFilter.md +0 -20
- data/docs/ProfileBulkImportJobEnum.md +0 -15
- data/docs/ProfileCreateQuery.md +0 -18
- data/docs/ProfileCreateQueryResourceObject.md +0 -20
- data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
- data/docs/ProfileEnum.md +0 -15
- data/docs/ProfileGroupMembershipEnum.md +0 -15
- data/docs/ProfileHasGroupMembershipCondition.md +0 -24
- data/docs/ProfileHasGroupMembershipConditionTimeframeFilter.md +0 -53
- data/docs/ProfileIdentifierDTOResourceObject.md +0 -22
- data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +0 -24
- data/docs/ProfileImportJobCreateQuery.md +0 -18
- data/docs/ProfileImportJobCreateQueryResourceObject.md +0 -22
- data/docs/ProfileImportJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ProfileImportJobCreateQueryResourceObjectAttributesProfiles.md +0 -18
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsLists.md +0 -18
- data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner.md +0 -20
- data/docs/ProfileLocation.md +0 -36
- data/docs/ProfileLocationLatitude.md +0 -49
- data/docs/ProfileLocationLongitude.md +0 -49
- data/docs/ProfileMarketingConsentCondition.md +0 -20
- data/docs/ProfileMarketingConsentConditionConsent.md +0 -57
- data/docs/ProfileMarketingConsentEnum.md +0 -15
- data/docs/ProfileMergeEnum.md +0 -15
- data/docs/ProfileMergeQuery.md +0 -18
- data/docs/ProfileMergeQueryResourceObject.md +0 -22
- data/docs/ProfileMergeQueryResourceObjectRelationships.md +0 -18
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md +0 -18
- data/docs/ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.md +0 -20
- data/docs/ProfileMeta.md +0 -18
- data/docs/ProfileMetaPatchProperties.md +0 -22
- data/docs/ProfileMetaPatchPropertiesUnset.md +0 -49
- data/docs/ProfileMetricCondition.md +0 -28
- data/docs/ProfileMetricConditionTimeframeFilter.md +0 -57
- data/docs/ProfileMetricEnum.md +0 -15
- data/docs/ProfileMetricPropertyFilter.md +0 -20
- data/docs/ProfileMetricPropertyFilterFilter.md +0 -49
- data/docs/ProfileNoGroupMembershipCondition.md +0 -22
- data/docs/ProfilePartialUpdateQuery.md +0 -18
- data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -24
- data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +0 -38
- data/docs/ProfilePostalCodeDistanceCondition.md +0 -26
- data/docs/ProfilePostalCodeDistanceEnum.md +0 -15
- data/docs/ProfilePredictiveAnalyticsEnum.md +0 -15
- data/docs/ProfilePredictiveAnalyticsNumericCondition.md +0 -22
- data/docs/ProfilePredictiveAnalyticsStringCondition.md +0 -22
- data/docs/ProfilePredictiveAnalyticsStringFilter.md +0 -22
- data/docs/ProfilePredictiveAnalyticsStringFilterOperator.md +0 -49
- data/docs/ProfilePropertyCondition.md +0 -22
- data/docs/ProfilePropertyConditionFilter.md +0 -75
- data/docs/ProfilePropertyEnum.md +0 -15
- data/docs/ProfileRegionCondition.md +0 -22
- data/docs/ProfileRegionEnum.md +0 -15
- data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSubscriptionBulkDeleteJobEnum.md +0 -15
- data/docs/ProfileSubscriptionCreateQueryResourceObject.md +0 -22
- data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/ProfileSubscriptionDeleteQueryResourceObject.md +0 -20
- data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +0 -20
- data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
- data/docs/ProfileSuppressionBulkDeleteJobEnum.md +0 -15
- data/docs/ProfileSuppressionCreateQueryResourceObject.md +0 -20
- data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/ProfileSuppressionDeleteQueryResourceObject.md +0 -20
- data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +0 -18
- data/docs/ProfileUpsertQuery.md +0 -18
- data/docs/ProfileUpsertQueryResourceObject.md +0 -24
- data/docs/ProfileUpsertQueryResourceObjectAttributes.md +0 -40
- data/docs/ProfilesApi.md +0 -1738
- data/docs/ProvidedLandlineEnum.md +0 -15
- data/docs/ProvidedLandlineMethodFilter.md +0 -20
- data/docs/ProvidedNoAgeEnum.md +0 -15
- data/docs/ProvidedNoAgeMethodFilter.md +0 -20
- data/docs/PushEnum.md +0 -15
- data/docs/PushProfileUpsertQueryResourceObject.md +0 -22
- data/docs/PushProfileUpsertQueryResourceObjectAttributes.md +0 -42
- data/docs/PushTokenCreateQuery.md +0 -18
- data/docs/PushTokenCreateQueryResourceObject.md +0 -20
- data/docs/PushTokenCreateQueryResourceObjectAttributes.md +0 -30
- data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +0 -18
- data/docs/PushTokenEnum.md +0 -15
- data/docs/RelativeAnniversaryDateFilter.md +0 -24
- data/docs/RelativeDateOperatorBaseFilter.md +0 -24
- data/docs/RelativeDateRangeFilter.md +0 -26
- data/docs/RenderOptionsSubObject.md +0 -24
- data/docs/ReportingApi.md +0 -235
- data/docs/SMSContentSubObjectCreate.md +0 -18
- data/docs/SMSSendOptionsSubObject.md +0 -18
- data/docs/SMSSubscriptionParameters.md +0 -18
- data/docs/SMSTrackingOptionsSubObject.md +0 -20
- data/docs/STOScheduleOptions.md +0 -18
- data/docs/SegmentCreateQuery.md +0 -18
- data/docs/SegmentCreateQueryResourceObject.md +0 -20
- data/docs/SegmentCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SegmentDefinition.md +0 -18
- data/docs/SegmentEnum.md +0 -15
- data/docs/SegmentPartialUpdateQuery.md +0 -18
- data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
- data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -22
- data/docs/SegmentsApi.md +0 -706
- data/docs/SendStrategySubObject.md +0 -24
- data/docs/ServerBISSubscriptionCreateQuery.md +0 -18
- data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +0 -22
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md +0 -18
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +0 -18
- data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +0 -20
- data/docs/SftpEnum.md +0 -15
- data/docs/SftpMethodFilter.md +0 -20
- data/docs/ShopifyEnum.md +0 -15
- data/docs/ShopifyIntegrationFilter.md +0 -22
- data/docs/ShopifyIntegrationMethodFilter.md +0 -22
- data/docs/SmsEnum.md +0 -15
- data/docs/SpamComplaintEnum.md +0 -15
- data/docs/SpamComplaintMethodFilter.md +0 -20
- data/docs/StaticDateFilter.md +0 -22
- data/docs/StaticDateRangeFilter.md +0 -24
- data/docs/StaticScheduleOptions.md +0 -22
- data/docs/StatusDateEnum.md +0 -15
- data/docs/StatusDateFilter.md +0 -20
- data/docs/StatusDateFilterFilter.md +0 -59
- data/docs/StringArrayOperatorFilter.md +0 -22
- data/docs/StringEnum.md +0 -15
- data/docs/StringOperatorFilter.md +0 -22
- data/docs/StringPhoneOperatorArrayFilter.md +0 -22
- data/docs/SubscribedEnum.md +0 -15
- data/docs/SubscriptionChannels.md +0 -20
- data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -22
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +0 -18
- data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +0 -20
- data/docs/SubscriptionDeleteJobCreateQuery.md +0 -18
- data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +0 -22
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +0 -18
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +0 -18
- data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +0 -20
- data/docs/SuppressionCreateJobCreateQuery.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -22
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationships.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsList.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsListData.md +0 -20
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsSegment.md +0 -18
- data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsSegmentData.md +0 -20
- data/docs/SuppressionDeleteJobCreateQuery.md +0 -18
- data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +0 -22
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +0 -18
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationships.md +0 -20
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsList.md +0 -18
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +0 -20
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsSegment.md +0 -18
- data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsSegmentData.md +0 -20
- data/docs/TagCampaignOp.md +0 -18
- data/docs/TagCampaignOpDataInner.md +0 -20
- data/docs/TagCreateQuery.md +0 -18
- data/docs/TagCreateQueryResourceObject.md +0 -22
- data/docs/TagCreateQueryResourceObjectAttributes.md +0 -18
- data/docs/TagCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +0 -18
- data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.md +0 -20
- data/docs/TagEnum.md +0 -15
- data/docs/TagFlowOp.md +0 -18
- data/docs/TagFlowOpDataInner.md +0 -20
- data/docs/TagGroupCreateQuery.md +0 -18
- data/docs/TagGroupCreateQueryResourceObject.md +0 -20
- data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagGroupEnum.md +0 -15
- data/docs/TagGroupUpdateQuery.md +0 -18
- data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
- data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
- data/docs/TagListOp.md +0 -18
- data/docs/TagListOpDataInner.md +0 -20
- data/docs/TagSegmentOp.md +0 -18
- data/docs/TagSegmentOpDataInner.md +0 -20
- data/docs/TagUpdateQuery.md +0 -18
- data/docs/TagUpdateQueryResourceObject.md +0 -22
- data/docs/TagsApi.md +0 -1929
- data/docs/TemplateCloneQuery.md +0 -18
- data/docs/TemplateCloneQueryResourceObject.md +0 -22
- data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -18
- data/docs/TemplateCreateQuery.md +0 -18
- data/docs/TemplateCreateQueryResourceObject.md +0 -20
- data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -30
- data/docs/TemplateEnum.md +0 -15
- data/docs/TemplateRenderQuery.md +0 -18
- data/docs/TemplateRenderQueryResourceObject.md +0 -22
- data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -18
- data/docs/TemplateUpdateQuery.md +0 -18
- data/docs/TemplateUpdateQueryResourceObject.md +0 -22
- data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -28
- data/docs/TemplatesApi.md +0 -524
- data/docs/ThrottledScheduleOptions.md +0 -20
- data/docs/Timeframe.md +0 -18
- data/docs/UTMParamsSubObject.md +0 -20
- data/docs/UnionPositiveNumericFilter.md +0 -22
- data/docs/UnionPositiveNumericFilterOperator.md +0 -49
- data/docs/UnsubscribedEnum.md +0 -15
- data/docs/WebhookCreateQuery.md +0 -18
- data/docs/WebhookCreateQueryResourceObject.md +0 -22
- data/docs/WebhookCreateQueryResourceObjectAttributes.md +0 -24
- data/docs/WebhookCreateQueryResourceObjectRelationships.md +0 -18
- data/docs/WebhookCreateQueryResourceObjectRelationshipsWebhookTopics.md +0 -18
- data/docs/WebhookCreateQueryResourceObjectRelationshipsWebhookTopicsDataInner.md +0 -20
- data/docs/WebhookEnum.md +0 -15
- data/docs/WebhookPartialUpdateQuery.md +0 -18
- data/docs/WebhookPartialUpdateQueryResourceObject.md +0 -24
- data/docs/WebhookPartialUpdateQueryResourceObjectAttributes.md +0 -26
- data/docs/WebhookTopicEnum.md +0 -15
- data/docs/WebhooksApi.md +0 -519
- data/git_push.sh +0 -57
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/account_default_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter2.rb +0 -108
- data/lib/klaviyo-api-sdk/models/action_output_condition_group.rb +0 -225
- data/lib/klaviyo-api-sdk/models/action_output_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/action_output_split_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/after_close_or_submit_timeout_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/age_gate_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/any_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/api_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/bis_promotional_email_checkbox_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/block_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/branch_action.rb +0 -264
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/button_block.rb +0 -247
- data/lib/klaviyo-api-sdk/models/button_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/cart_item_count_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/cart_product_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/cart_value_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/channel_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/checkboxes_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/close_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/code_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/column.rb +0 -239
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/content_experiment_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +0 -237
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/countdown_timer_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/custom_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/custom_javascript_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/delay_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/device_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/dollar_sign_age_gated_date_of_birth_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/dollar_sign_email_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/drop_shadow_block.rb +0 -247
- data/lib/klaviyo-api-sdk/models/drop_shadow_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/dropdown_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/effective_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/email_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +0 -272
- data/lib/klaviyo-api-sdk/models/exit_intent_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/explicitly_reachable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/explicitly_unreachable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/fixed_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters.rb +0 -225
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner.rb +0 -225
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +0 -115
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters.rb +0 -225
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner.rb +0 -225
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +0 -115
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters.rb +0 -225
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner.rb +0 -225
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +0 -115
- data/lib/klaviyo-api-sdk/models/go_to_inbox_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block.rb +0 -247
- data/lib/klaviyo-api-sdk/models/horizontal_rule_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/html_block.rb +0 -251
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +0 -237
- data/lib/klaviyo-api-sdk/models/html_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/html_text_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/identified_profiles_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/image_block.rb +0 -247
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_reachable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_unreachable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/implicitly_reachable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/implicitly_unreachable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/in_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/increment_one_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/is_rcs_capable_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +0 -282
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +0 -104
- data/lib/klaviyo-api-sdk/models/list_regex_operator_contains_filter.rb +0 -282
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/lists_and_segments_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/location_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +0 -225
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +0 -225
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +0 -246
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/method_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +0 -225
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/next_step_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +0 -286
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +0 -104
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/open_form_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/opt_in_code_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/opt_in_promotional_email_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/opt_in_promotional_sms_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/other_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/page_visits_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/phone_number_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/previously_submitted_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +0 -225
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +0 -225
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/priority_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_metric_funnel_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_not_sent_email_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_not_sent_push_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_not_sent_sms_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_permissions_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/promotional_sms_checkbox_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/promotional_sms_subscription_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/published_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/push_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/radio_buttons_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/rank_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/recorded_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/redirect_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +0 -313
- data/lib/klaviyo-api-sdk/models/resend_opt_in_code_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/row.rb +0 -235
- data/lib/klaviyo-api-sdk/models/row_blocks_inner.rb +0 -122
- data/lib/klaviyo-api-sdk/models/scroll_percentage_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/set_count_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/set_property_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/signup_counter_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/silent_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/sms_disclosure_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/spacer_block.rb +0 -247
- data/lib/klaviyo-api-sdk/models/spacer_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/spin_to_win_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/split_action.rb +0 -254
- data/lib/klaviyo-api-sdk/models/split_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/split_links.rb +0 -225
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/static_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +0 -288
- data/lib/klaviyo-api-sdk/models/string_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +0 -282
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +0 -288
- data/lib/klaviyo-api-sdk/models/submit_back_in_stock_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/submit_opt_in_code_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/subscribe_method_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/subscribe_via_sms_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/subscribe_via_whatsapp_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +0 -223
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +0 -237
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +0 -272
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +0 -223
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +0 -252
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +0 -253
- data/lib/klaviyo-api-sdk/models/text_block.rb +0 -251
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +0 -251
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +0 -533
- data/lib/klaviyo-api-sdk/models/text_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/text_style.rb +0 -299
- data/lib/klaviyo-api-sdk/models/text_style_font_family.rb +0 -103
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/underline_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/unidentified_profiles_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/unique_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/url_patterns_enum.rb +0 -35
- data/lib/klaviyo-api-sdk/models/variable_enum.rb +0 -35
- data/spec/.DS_Store +0 -0
- data/spec/api/accounts_api_spec.rb +0 -60
- data/spec/api/campaigns_api_spec.rb +0 -338
- data/spec/api/catalogs_api_spec.rb +0 -763
- data/spec/api/coupons_api_spec.rb +0 -260
- data/spec/api/data_privacy_api_spec.rb +0 -47
- data/spec/api/events_api_spec.rb +0 -144
- data/spec/api/flows_api_spec.rb +0 -291
- data/spec/api/forms_api_spec.rb +0 -133
- data/spec/api/images_api_spec.rb +0 -103
- data/spec/api/lists_api_spec.rb +0 -190
- data/spec/api/metrics_api_spec.rb +0 -74
- data/spec/api/profiles_api_spec.rb +0 -341
- data/spec/api/reporting_api_spec.rb +0 -74
- data/spec/api/segments_api_spec.rb +0 -164
- data/spec/api/tags_api_spec.rb +0 -371
- data/spec/api/templates_api_spec.rb +0 -124
- data/spec/api/webhooks_api_spec.rb +0 -122
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/alltime_date_filter_spec.rb +0 -44
- data/spec/models/anniversary_date_filter_spec.rb +0 -44
- data/spec/models/any_enum_spec.rb +0 -28
- data/spec/models/api_enum_spec.rb +0 -28
- data/spec/models/api_method_filter_spec.rb +0 -46
- data/spec/models/audiences_sub_object_spec.rb +0 -40
- data/spec/models/back_in_stock_enum_spec.rb +0 -28
- data/spec/models/back_in_stock_method_filter_spec.rb +0 -40
- data/spec/models/back_in_stock_subscription_enum_spec.rb +0 -28
- data/spec/models/base_event_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/base_event_create_query_resource_object_spec.rb +0 -40
- data/spec/models/boolean_enum_spec.rb +0 -28
- data/spec/models/boolean_filter_spec.rb +0 -50
- data/spec/models/bounce_date_enum_spec.rb +0 -28
- data/spec/models/bounce_date_filter_filter_spec.rb +0 -31
- data/spec/models/bounce_date_filter_spec.rb +0 -40
- data/spec/models/bulk_remove_enum_spec.rb +0 -28
- data/spec/models/bulk_remove_method_filter_spec.rb +0 -40
- data/spec/models/calendar_date_filter_spec.rb +0 -50
- data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_clone_query_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +0 -34
- data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +0 -31
- data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
- data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +0 -31
- data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_create_query_spec.rb +0 -34
- data/spec/models/campaign_enum_spec.rb +0 -28
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +0 -40
- data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +0 -34
- data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
- data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +0 -31
- data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/campaign_message_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_message_enum_spec.rb +0 -28
- data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
- data/spec/models/campaign_send_job_enum_spec.rb +0 -28
- data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
- data/spec/models/campaign_values_report_enum_spec.rb +0 -28
- data/spec/models/campaign_values_request_dto_resource_object_attributes_spec.rb +0 -56
- data/spec/models/campaign_values_request_dto_resource_object_attributes_timeframe_spec.rb +0 -31
- data/spec/models/campaign_values_request_dto_resource_object_spec.rb +0 -40
- data/spec/models/campaign_values_request_dto_spec.rb +0 -34
- data/spec/models/carrier_deactivation_enum_spec.rb +0 -28
- data/spec/models/carrier_deactivation_method_filter_spec.rb +0 -40
- data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -40
- data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_category_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_enum_spec.rb +0 -28
- data/spec/models/catalog_category_item_op_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_category_update_query_spec.rb +0 -34
- data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_item_category_op_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -40
- data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_item_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_enum_spec.rb +0 -28
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
- data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
- data/spec/models/catalog_item_update_query_spec.rb +0 -34
- data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +0 -34
- data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +0 -40
- data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_enum_spec.rb +0 -28
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +0 -34
- data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
- data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
- data/spec/models/catalog_variant_update_query_spec.rb +0 -34
- data/spec/models/checkout_enum_spec.rb +0 -28
- data/spec/models/checkout_method_filter_spec.rb +0 -40
- data/spec/models/condition_group_conditions_inner_spec.rb +0 -31
- data/spec/models/condition_group_spec.rb +0 -34
- data/spec/models/constant_contact_enum_spec.rb +0 -28
- data/spec/models/constant_contact_integration_filter_spec.rb +0 -46
- data/spec/models/constant_contact_integration_method_filter_spec.rb +0 -46
- data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +0 -34
- data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +0 -40
- data/spec/models/coupon_code_create_job_create_query_spec.rb +0 -34
- data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +0 -40
- data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +0 -34
- data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/coupon_code_create_query_resource_object_spec.rb +0 -46
- data/spec/models/coupon_code_create_query_spec.rb +0 -34
- data/spec/models/coupon_code_enum_spec.rb +0 -28
- data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +0 -44
- data/spec/models/coupon_code_update_query_resource_object_spec.rb +0 -46
- data/spec/models/coupon_code_update_query_spec.rb +0 -34
- data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/coupon_create_query_resource_object_spec.rb +0 -40
- data/spec/models/coupon_create_query_spec.rb +0 -34
- data/spec/models/coupon_enum_spec.rb +0 -28
- data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/coupon_update_query_resource_object_spec.rb +0 -46
- data/spec/models/coupon_update_query_spec.rb +0 -34
- data/spec/models/custom_source_enum_spec.rb +0 -28
- data/spec/models/custom_source_filter_spec.rb +0 -40
- data/spec/models/custom_timeframe_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +0 -34
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
- data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
- data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
- data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/data_privacy_profile_query_resource_object_spec.rb +0 -46
- data/spec/models/date_enum_spec.rb +0 -28
- data/spec/models/device_metadata_spec.rb +0 -112
- data/spec/models/double_optin_filter_spec.rb +0 -40
- data/spec/models/email_content_sub_object_spec.rb +0 -70
- data/spec/models/email_enum_spec.rb +0 -28
- data/spec/models/email_send_options_sub_object_spec.rb +0 -34
- data/spec/models/email_subscription_parameters_spec.rb +0 -34
- data/spec/models/email_tracking_options_sub_object_spec.rb +0 -52
- data/spec/models/equals_enum_spec.rb +0 -28
- data/spec/models/equals_string_filter_spec.rb +0 -46
- data/spec/models/event_bulk_create_enum_spec.rb +0 -28
- data/spec/models/event_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +0 -34
- data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +0 -34
- data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +0 -70
- data/spec/models/event_create_query_v2_resource_object_spec.rb +0 -40
- data/spec/models/event_create_query_v2_spec.rb +0 -34
- data/spec/models/event_enum_spec.rb +0 -28
- data/spec/models/event_profile_create_query_resource_object_attributes_spec.rb +0 -106
- data/spec/models/event_profile_create_query_resource_object_spec.rb +0 -46
- data/spec/models/events_bulk_create_job_resource_object_attributes_events_bulk_create_spec.rb +0 -34
- data/spec/models/events_bulk_create_job_resource_object_attributes_spec.rb +0 -34
- data/spec/models/events_bulk_create_job_resource_object_spec.rb +0 -40
- data/spec/models/events_bulk_create_job_spec.rb +0 -34
- data/spec/models/events_bulk_create_query_resource_object_attributes_events_spec.rb +0 -34
- data/spec/models/events_bulk_create_query_resource_object_attributes_profile_spec.rb +0 -34
- data/spec/models/events_bulk_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/events_bulk_create_query_resource_object_spec.rb +0 -40
- data/spec/models/existence_enum_spec.rb +0 -28
- data/spec/models/existence_operator_filter_spec.rb +0 -44
- data/spec/models/failed_age_gate_enum_spec.rb +0 -28
- data/spec/models/failed_age_gate_method_filter_spec.rb +0 -40
- data/spec/models/flow_enum_spec.rb +0 -28
- data/spec/models/flow_series_report_enum_spec.rb +0 -28
- data/spec/models/flow_series_request_dto_resource_object_attributes_spec.rb +0 -66
- data/spec/models/flow_series_request_dto_resource_object_spec.rb +0 -40
- data/spec/models/flow_series_request_dto_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
- data/spec/models/flow_update_query_spec.rb +0 -34
- data/spec/models/flow_values_report_enum_spec.rb +0 -28
- data/spec/models/flow_values_request_dto_resource_object_attributes_spec.rb +0 -56
- data/spec/models/flow_values_request_dto_resource_object_spec.rb +0 -40
- data/spec/models/flow_values_request_dto_spec.rb +0 -34
- data/spec/models/form_enum_spec.rb +0 -28
- data/spec/models/form_method_filter_spec.rb +0 -46
- data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +0 -40
- data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +0 -58
- data/spec/models/get_accounts4_xx_response_spec.rb +0 -34
- data/spec/models/greater_than_enum_spec.rb +0 -28
- data/spec/models/has_email_marketing_consent_consent_status_spec.rb +0 -31
- data/spec/models/has_email_marketing_consent_spec.rb +0 -50
- data/spec/models/has_email_marketing_never_subscribed_spec.rb +0 -34
- data/spec/models/has_email_marketing_spec.rb +0 -34
- data/spec/models/has_email_marketing_subscribed_filters_inner_spec.rb +0 -31
- data/spec/models/has_email_marketing_subscribed_spec.rb +0 -40
- data/spec/models/has_push_marketing_consent_spec.rb +0 -50
- data/spec/models/has_push_marketing_spec.rb +0 -40
- data/spec/models/has_sms_marketing_consent_spec.rb +0 -50
- data/spec/models/has_sms_marketing_subscribed_filters_inner_spec.rb +0 -31
- data/spec/models/has_sms_marketing_subscribed_spec.rb +0 -40
- data/spec/models/image_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/image_create_query_resource_object_spec.rb +0 -40
- data/spec/models/image_create_query_spec.rb +0 -34
- data/spec/models/image_enum_spec.rb +0 -28
- data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/image_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/image_partial_update_query_spec.rb +0 -34
- data/spec/models/in_enum_spec.rb +0 -28
- data/spec/models/in_string_array_filter_spec.rb +0 -46
- data/spec/models/inbound_message_enum_spec.rb +0 -28
- data/spec/models/inbound_message_method_filter_spec.rb +0 -40
- data/spec/models/integration_enum_spec.rb +0 -28
- data/spec/models/invalid_email_date_enum_spec.rb +0 -28
- data/spec/models/invalid_email_date_filter_spec.rb +0 -40
- data/spec/models/is_double_opt_in_enum_spec.rb +0 -28
- data/spec/models/is_set_enum_spec.rb +0 -28
- data/spec/models/is_set_existence_filter_spec.rb +0 -40
- data/spec/models/less_than_enum_spec.rb +0 -28
- data/spec/models/list_contains_operator_filter_spec.rb +0 -50
- data/spec/models/list_contains_operator_filter_value_spec.rb +0 -31
- data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/list_create_query_resource_object_spec.rb +0 -40
- data/spec/models/list_create_query_spec.rb +0 -34
- data/spec/models/list_enum_spec.rb +0 -28
- data/spec/models/list_length_filter_spec.rb +0 -50
- data/spec/models/list_members_add_query_data_inner_spec.rb +0 -40
- data/spec/models/list_members_add_query_spec.rb +0 -34
- data/spec/models/list_members_delete_query_spec.rb +0 -34
- data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/list_partial_update_query_spec.rb +0 -34
- data/spec/models/list_set_filter_spec.rb +0 -50
- data/spec/models/mailbox_provider_enum_spec.rb +0 -28
- data/spec/models/mailbox_provider_method_filter_spec.rb +0 -40
- data/spec/models/manual_add_enum_spec.rb +0 -28
- data/spec/models/manual_add_method_filter_spec.rb +0 -46
- data/spec/models/manual_import_enum_spec.rb +0 -28
- data/spec/models/manual_import_method_filter_spec.rb +0 -46
- data/spec/models/manual_remove_enum_spec.rb +0 -28
- data/spec/models/manual_remove_method_filter_spec.rb +0 -40
- data/spec/models/manual_suppression_date_enum_spec.rb +0 -28
- data/spec/models/manual_suppression_date_filter_spec.rb +0 -40
- data/spec/models/marketing_subscription_parameters_spec.rb +0 -44
- data/spec/models/message_blocked_enum_spec.rb +0 -28
- data/spec/models/message_blocked_method_filter_spec.rb +0 -40
- data/spec/models/method_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_enum_spec.rb +0 -28
- data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
- data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_aggregate_query_spec.rb +0 -34
- data/spec/models/metric_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/metric_create_query_resource_object_spec.rb +0 -40
- data/spec/models/metric_enum_spec.rb +0 -28
- data/spec/models/never_subscribed_enum_spec.rb +0 -28
- data/spec/models/no_email_marketing_consent_consent_status_spec.rb +0 -31
- data/spec/models/no_email_marketing_consent_spec.rb +0 -50
- data/spec/models/no_email_marketing_filters_inner_spec.rb +0 -31
- data/spec/models/no_email_marketing_never_subscribed_spec.rb +0 -40
- data/spec/models/no_email_marketing_spec.rb +0 -40
- data/spec/models/no_email_marketing_subscribed_spec.rb +0 -40
- data/spec/models/no_email_marketing_unsubscribed_filters_one_of_inner_spec.rb +0 -31
- data/spec/models/no_email_marketing_unsubscribed_filters_spec.rb +0 -31
- data/spec/models/no_email_marketing_unsubscribed_spec.rb +0 -40
- data/spec/models/no_push_marketing_consent_spec.rb +0 -50
- data/spec/models/no_push_marketing_spec.rb +0 -34
- data/spec/models/no_sms_marketing_consent_consent_status_spec.rb +0 -31
- data/spec/models/no_sms_marketing_consent_spec.rb +0 -50
- data/spec/models/no_sms_marketing_never_subscribed_spec.rb +0 -34
- data/spec/models/no_sms_marketing_spec.rb +0 -34
- data/spec/models/no_sms_marketing_unsubscribed_filters_inner_spec.rb +0 -31
- data/spec/models/no_sms_marketing_unsubscribed_spec.rb +0 -40
- data/spec/models/not_equals_enum_spec.rb +0 -28
- data/spec/models/numeric_enum_spec.rb +0 -28
- data/spec/models/numeric_operator_filter_spec.rb +0 -50
- data/spec/models/numeric_operator_filter_value_spec.rb +0 -31
- data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -100
- data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -52
- data/spec/models/onsite_profile_meta_spec.rb +0 -34
- data/spec/models/preference_page_enum_spec.rb +0 -28
- data/spec/models/preference_page_filter_spec.rb +0 -46
- data/spec/models/preference_page_method_filter_spec.rb +0 -40
- data/spec/models/profile_bulk_import_job_enum_spec.rb +0 -28
- data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
- data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_create_query_spec.rb +0 -34
- data/spec/models/profile_enum_spec.rb +0 -28
- data/spec/models/profile_group_membership_enum_spec.rb +0 -28
- data/spec/models/profile_has_group_membership_condition_spec.rb +0 -56
- data/spec/models/profile_has_group_membership_condition_timeframe_filter_spec.rb +0 -31
- data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +0 -52
- data/spec/models/profile_identifier_dto_resource_object_spec.rb +0 -46
- data/spec/models/profile_import_job_create_query_resource_object_attributes_profiles_spec.rb +0 -34
- data/spec/models/profile_import_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner_spec.rb +0 -40
- data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_spec.rb +0 -34
- data/spec/models/profile_import_job_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/profile_import_job_create_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_import_job_create_query_spec.rb +0 -34
- data/spec/models/profile_location_latitude_spec.rb +0 -31
- data/spec/models/profile_location_longitude_spec.rb +0 -31
- data/spec/models/profile_location_spec.rb +0 -88
- data/spec/models/profile_marketing_consent_condition_consent_spec.rb +0 -31
- data/spec/models/profile_marketing_consent_condition_spec.rb +0 -40
- data/spec/models/profile_marketing_consent_enum_spec.rb +0 -28
- data/spec/models/profile_merge_enum_spec.rb +0 -28
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +0 -40
- data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +0 -34
- data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/profile_merge_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_merge_query_spec.rb +0 -34
- data/spec/models/profile_meta_patch_properties_spec.rb +0 -46
- data/spec/models/profile_meta_patch_properties_unset_spec.rb +0 -31
- data/spec/models/profile_meta_spec.rb +0 -34
- data/spec/models/profile_metric_condition_spec.rb +0 -68
- data/spec/models/profile_metric_condition_timeframe_filter_spec.rb +0 -31
- data/spec/models/profile_metric_enum_spec.rb +0 -28
- data/spec/models/profile_metric_property_filter_filter_spec.rb +0 -31
- data/spec/models/profile_metric_property_filter_spec.rb +0 -40
- data/spec/models/profile_no_group_membership_condition_spec.rb +0 -50
- data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +0 -94
- data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -52
- data/spec/models/profile_partial_update_query_spec.rb +0 -34
- data/spec/models/profile_postal_code_distance_condition_spec.rb +0 -62
- data/spec/models/profile_postal_code_distance_enum_spec.rb +0 -28
- data/spec/models/profile_predictive_analytics_enum_spec.rb +0 -28
- data/spec/models/profile_predictive_analytics_numeric_condition_spec.rb +0 -50
- data/spec/models/profile_predictive_analytics_string_condition_spec.rb +0 -50
- data/spec/models/profile_predictive_analytics_string_filter_operator_spec.rb +0 -31
- data/spec/models/profile_predictive_analytics_string_filter_spec.rb +0 -50
- data/spec/models/profile_property_condition_filter_spec.rb +0 -31
- data/spec/models/profile_property_condition_spec.rb +0 -46
- data/spec/models/profile_property_enum_spec.rb +0 -28
- data/spec/models/profile_region_condition_spec.rb +0 -50
- data/spec/models/profile_region_enum_spec.rb +0 -28
- data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/profile_subscription_create_query_resource_object_spec.rb +0 -46
- data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +0 -28
- data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/profile_suppression_create_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +0 -40
- data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +0 -100
- data/spec/models/profile_upsert_query_resource_object_spec.rb +0 -52
- data/spec/models/profile_upsert_query_spec.rb +0 -34
- data/spec/models/provided_landline_enum_spec.rb +0 -28
- data/spec/models/provided_landline_method_filter_spec.rb +0 -40
- data/spec/models/provided_no_age_enum_spec.rb +0 -28
- data/spec/models/provided_no_age_method_filter_spec.rb +0 -40
- data/spec/models/push_enum_spec.rb +0 -28
- data/spec/models/push_profile_upsert_query_resource_object_attributes_spec.rb +0 -106
- data/spec/models/push_profile_upsert_query_resource_object_spec.rb +0 -46
- data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +0 -34
- data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +0 -86
- data/spec/models/push_token_create_query_resource_object_spec.rb +0 -40
- data/spec/models/push_token_create_query_spec.rb +0 -34
- data/spec/models/push_token_enum_spec.rb +0 -28
- data/spec/models/relative_anniversary_date_filter_spec.rb +0 -60
- data/spec/models/relative_date_operator_base_filter_spec.rb +0 -60
- data/spec/models/relative_date_range_filter_spec.rb +0 -66
- data/spec/models/render_options_sub_object_spec.rb +0 -52
- data/spec/models/segment_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/segment_create_query_resource_object_spec.rb +0 -40
- data/spec/models/segment_create_query_spec.rb +0 -34
- data/spec/models/segment_definition_spec.rb +0 -34
- data/spec/models/segment_enum_spec.rb +0 -28
- data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
- data/spec/models/segment_partial_update_query_spec.rb +0 -34
- data/spec/models/send_strategy_sub_object_spec.rb +0 -52
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +0 -34
- data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +0 -44
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +0 -40
- data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +0 -34
- data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +0 -46
- data/spec/models/server_bis_subscription_create_query_spec.rb +0 -34
- data/spec/models/sftp_enum_spec.rb +0 -28
- data/spec/models/sftp_method_filter_spec.rb +0 -40
- data/spec/models/shopify_enum_spec.rb +0 -28
- data/spec/models/shopify_integration_filter_spec.rb +0 -46
- data/spec/models/shopify_integration_method_filter_spec.rb +0 -46
- data/spec/models/sms_content_sub_object_create_spec.rb +0 -34
- data/spec/models/sms_enum_spec.rb +0 -28
- data/spec/models/sms_send_options_sub_object_spec.rb +0 -34
- data/spec/models/sms_subscription_parameters_spec.rb +0 -34
- data/spec/models/sms_tracking_options_sub_object_spec.rb +0 -40
- data/spec/models/spam_complaint_enum_spec.rb +0 -28
- data/spec/models/spam_complaint_method_filter_spec.rb +0 -40
- data/spec/models/static_date_filter_spec.rb +0 -50
- data/spec/models/static_date_range_filter_spec.rb +0 -56
- data/spec/models/static_schedule_options_spec.rb +0 -46
- data/spec/models/status_date_enum_spec.rb +0 -28
- data/spec/models/status_date_filter_filter_spec.rb +0 -31
- data/spec/models/status_date_filter_spec.rb +0 -40
- data/spec/models/sto_schedule_options_spec.rb +0 -34
- data/spec/models/string_array_operator_filter_spec.rb +0 -50
- data/spec/models/string_enum_spec.rb +0 -28
- data/spec/models/string_operator_filter_spec.rb +0 -50
- data/spec/models/string_phone_operator_array_filter_spec.rb +0 -50
- data/spec/models/subscribed_enum_spec.rb +0 -28
- data/spec/models/subscription_channels_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +0 -34
- data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +0 -40
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +0 -34
- data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -46
- data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +0 -34
- data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +0 -40
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +0 -34
- data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +0 -46
- data/spec/models/subscription_delete_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_list_data_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_list_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_segment_data_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_segment_spec.rb +0 -34
- data/spec/models/suppression_create_job_create_query_resource_object_relationships_spec.rb +0 -40
- data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -46
- data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +0 -34
- data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_list_data_spec.rb +0 -40
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_list_spec.rb +0 -34
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_segment_data_spec.rb +0 -40
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_segment_spec.rb +0 -34
- data/spec/models/suppression_delete_job_create_query_resource_object_relationships_spec.rb +0 -40
- data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +0 -46
- data/spec/models/suppression_delete_job_create_query_spec.rb +0 -34
- data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -40
- data/spec/models/tag_campaign_op_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +0 -40
- data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +0 -34
- data/spec/models/tag_create_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_create_query_spec.rb +0 -34
- data/spec/models/tag_enum_spec.rb +0 -28
- data/spec/models/tag_flow_op_data_inner_spec.rb +0 -40
- data/spec/models/tag_flow_op_spec.rb +0 -34
- data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
- data/spec/models/tag_group_create_query_spec.rb +0 -34
- data/spec/models/tag_group_enum_spec.rb +0 -28
- data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
- data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_group_update_query_spec.rb +0 -34
- data/spec/models/tag_list_op_data_inner_spec.rb +0 -40
- data/spec/models/tag_list_op_spec.rb +0 -34
- data/spec/models/tag_segment_op_data_inner_spec.rb +0 -40
- data/spec/models/tag_segment_op_spec.rb +0 -34
- data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
- data/spec/models/tag_update_query_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/template_clone_query_resource_object_spec.rb +0 -46
- data/spec/models/template_clone_query_spec.rb +0 -34
- data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/template_create_query_resource_object_spec.rb +0 -40
- data/spec/models/template_create_query_spec.rb +0 -34
- data/spec/models/template_enum_spec.rb +0 -28
- data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -34
- data/spec/models/template_render_query_resource_object_spec.rb +0 -46
- data/spec/models/template_render_query_spec.rb +0 -34
- data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -46
- data/spec/models/template_update_query_resource_object_spec.rb +0 -46
- data/spec/models/template_update_query_spec.rb +0 -34
- data/spec/models/throttled_schedule_options_spec.rb +0 -40
- data/spec/models/timeframe_spec.rb +0 -38
- data/spec/models/union_positive_numeric_filter_operator_spec.rb +0 -31
- data/spec/models/union_positive_numeric_filter_spec.rb +0 -46
- data/spec/models/unsubscribed_enum_spec.rb +0 -28
- data/spec/models/utm_params_sub_object_spec.rb +0 -40
- data/spec/models/webhook_create_query_resource_object_attributes_spec.rb +0 -52
- data/spec/models/webhook_create_query_resource_object_relationships_spec.rb +0 -34
- data/spec/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner_spec.rb +0 -40
- data/spec/models/webhook_create_query_resource_object_relationships_webhook_topics_spec.rb +0 -34
- data/spec/models/webhook_create_query_resource_object_spec.rb +0 -46
- data/spec/models/webhook_create_query_spec.rb +0 -34
- data/spec/models/webhook_enum_spec.rb +0 -28
- data/spec/models/webhook_partial_update_query_resource_object_attributes_spec.rb +0 -58
- data/spec/models/webhook_partial_update_query_resource_object_spec.rb +0 -52
- data/spec/models/webhook_partial_update_query_spec.rb +0 -34
- data/spec/models/webhook_topic_enum_spec.rb +0 -28
- data/spec/spec_helper.rb +0 -111
|
@@ -19,9 +19,10 @@ module KlaviyoAPI
|
|
|
19
19
|
@api_client = api_client
|
|
20
20
|
end
|
|
21
21
|
# Bulk Import Profiles
|
|
22
|
-
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
|
22
|
+
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)
|
|
23
23
|
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
25
26
|
# @return [Hash<String, Object>]
|
|
26
27
|
def bulk_import_profiles(profile_import_job_create_query, opts = {})
|
|
27
28
|
data, _status_code, _headers = bulk_import_profiles_with_http_info(profile_import_job_create_query, opts)
|
|
@@ -35,9 +36,10 @@ module KlaviyoAPI
|
|
|
35
36
|
alias create_profile_bulk_import_job bulk_import_profiles
|
|
36
37
|
|
|
37
38
|
# Bulk Import Profiles
|
|
38
|
-
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
|
39
|
+
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)
|
|
39
40
|
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
|
40
41
|
# @param [Hash] opts the optional parameters
|
|
42
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
41
43
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
42
44
|
def bulk_import_profiles_with_http_info(profile_import_job_create_query, opts = {})
|
|
43
45
|
if @api_client.config.debugging
|
|
@@ -47,16 +49,21 @@ module KlaviyoAPI
|
|
|
47
49
|
if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
|
|
48
50
|
fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.bulk_import_profiles"
|
|
49
51
|
end
|
|
52
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "expires_at", "failed_count", "id", "started_at", "status", "total_count"]
|
|
53
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
|
54
|
+
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
|
55
|
+
end
|
|
50
56
|
# resource path
|
|
51
57
|
local_var_path = '/api/profile-bulk-import-jobs'
|
|
52
58
|
|
|
53
59
|
# query parameters
|
|
54
60
|
query_params = opts[:query_params] || {}
|
|
61
|
+
query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
|
|
55
62
|
|
|
56
63
|
# header parameters
|
|
57
64
|
header_params = opts[:header_params] || {}
|
|
58
65
|
# klaviyo api revision
|
|
59
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
66
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
60
67
|
# HTTP header 'Accept' (if needed)
|
|
61
68
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
62
69
|
# HTTP header 'Content-Type'
|
|
@@ -101,8 +108,8 @@ module KlaviyoAPI
|
|
|
101
108
|
alias create_profile_bulk_import_job_with_http_info bulk_import_profiles_with_http_info
|
|
102
109
|
|
|
103
110
|
# Bulk Subscribe Profiles
|
|
104
|
-
# Subscribe one or more profiles to email marketing, SMS marketing, or
|
|
105
|
-
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing
|
|
111
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past. Push tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)
|
|
112
|
+
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing, with support for push channel and push tokens. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
|
106
113
|
# @param [Hash] opts the optional parameters
|
|
107
114
|
# @return [nil]
|
|
108
115
|
def bulk_subscribe_profiles(subscription_create_job_create_query, opts = {})
|
|
@@ -117,8 +124,8 @@ module KlaviyoAPI
|
|
|
117
124
|
alias create_profile_subscription_bulk_create_job bulk_subscribe_profiles
|
|
118
125
|
|
|
119
126
|
# Bulk Subscribe Profiles
|
|
120
|
-
# Subscribe one or more profiles to email marketing, SMS marketing, or
|
|
121
|
-
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing
|
|
127
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past. Push tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)
|
|
128
|
+
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing, with support for push channel and push tokens. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
|
122
129
|
# @param [Hash] opts the optional parameters
|
|
123
130
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
124
131
|
def bulk_subscribe_profiles_with_http_info(subscription_create_job_create_query, opts = {})
|
|
@@ -138,7 +145,7 @@ module KlaviyoAPI
|
|
|
138
145
|
# header parameters
|
|
139
146
|
header_params = opts[:header_params] || {}
|
|
140
147
|
# klaviyo api revision
|
|
141
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
148
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
142
149
|
# HTTP header 'Accept' (if needed)
|
|
143
150
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
144
151
|
# HTTP header 'Content-Type'
|
|
@@ -183,9 +190,10 @@ module KlaviyoAPI
|
|
|
183
190
|
alias create_profile_subscription_bulk_create_job_with_http_info bulk_subscribe_profiles_with_http_info
|
|
184
191
|
|
|
185
192
|
# Bulk Suppress Profiles
|
|
186
|
-
# Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
193
|
+
# Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)
|
|
187
194
|
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
|
188
195
|
# @param [Hash] opts the optional parameters
|
|
196
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
189
197
|
# @return [Hash<String, Object>]
|
|
190
198
|
def bulk_suppress_profiles(suppression_create_job_create_query, opts = {})
|
|
191
199
|
data, _status_code, _headers = bulk_suppress_profiles_with_http_info(suppression_create_job_create_query, opts)
|
|
@@ -199,9 +207,10 @@ module KlaviyoAPI
|
|
|
199
207
|
alias create_profile_suppression_bulk_create_job bulk_suppress_profiles
|
|
200
208
|
|
|
201
209
|
# Bulk Suppress Profiles
|
|
202
|
-
# Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
210
|
+
# Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)
|
|
203
211
|
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
|
204
212
|
# @param [Hash] opts the optional parameters
|
|
213
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
205
214
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
206
215
|
def bulk_suppress_profiles_with_http_info(suppression_create_job_create_query, opts = {})
|
|
207
216
|
if @api_client.config.debugging
|
|
@@ -211,16 +220,21 @@ module KlaviyoAPI
|
|
|
211
220
|
if @api_client.config.client_side_validation && suppression_create_job_create_query.nil?
|
|
212
221
|
fail ArgumentError, "Missing the required parameter 'suppression_create_job_create_query' when calling ProfilesApi.bulk_suppress_profiles"
|
|
213
222
|
end
|
|
223
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "id", "skipped_count", "status", "total_count"]
|
|
224
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
225
|
+
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
|
|
226
|
+
end
|
|
214
227
|
# resource path
|
|
215
228
|
local_var_path = '/api/profile-suppression-bulk-create-jobs'
|
|
216
229
|
|
|
217
230
|
# query parameters
|
|
218
231
|
query_params = opts[:query_params] || {}
|
|
232
|
+
query_params[:'fields[profile-suppression-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_create_job'], :csv) if !opts[:'fields_profile_suppression_bulk_create_job'].nil?
|
|
219
233
|
|
|
220
234
|
# header parameters
|
|
221
235
|
header_params = opts[:header_params] || {}
|
|
222
236
|
# klaviyo api revision
|
|
223
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
237
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
224
238
|
# HTTP header 'Accept' (if needed)
|
|
225
239
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
226
240
|
# HTTP header 'Content-Type'
|
|
@@ -265,8 +279,8 @@ module KlaviyoAPI
|
|
|
265
279
|
alias create_profile_suppression_bulk_create_job_with_http_info bulk_suppress_profiles_with_http_info
|
|
266
280
|
|
|
267
281
|
# Bulk Unsubscribe Profiles
|
|
268
|
-
# > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles
|
|
269
|
-
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing.
|
|
282
|
+
# > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Push tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles. To remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list). Maximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)
|
|
283
|
+
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Supports email, SMS, WhatsApp, and push channels. All profiles will be removed from the provided list. Either email or phone number is required for email/SMS/WhatsApp channels. Push tokens can be removed by providing token strings directly. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
|
270
284
|
# @param [Hash] opts the optional parameters
|
|
271
285
|
# @return [nil]
|
|
272
286
|
def bulk_unsubscribe_profiles(subscription_delete_job_create_query, opts = {})
|
|
@@ -281,8 +295,8 @@ module KlaviyoAPI
|
|
|
281
295
|
alias create_profile_subscription_bulk_delete_job bulk_unsubscribe_profiles
|
|
282
296
|
|
|
283
297
|
# Bulk Unsubscribe Profiles
|
|
284
|
-
# > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles
|
|
285
|
-
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing.
|
|
298
|
+
# > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Push tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles. To remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list). Maximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)
|
|
299
|
+
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Supports email, SMS, WhatsApp, and push channels. All profiles will be removed from the provided list. Either email or phone number is required for email/SMS/WhatsApp channels. Push tokens can be removed by providing token strings directly. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
|
286
300
|
# @param [Hash] opts the optional parameters
|
|
287
301
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
288
302
|
def bulk_unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts = {})
|
|
@@ -302,7 +316,7 @@ module KlaviyoAPI
|
|
|
302
316
|
# header parameters
|
|
303
317
|
header_params = opts[:header_params] || {}
|
|
304
318
|
# klaviyo api revision
|
|
305
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
319
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
306
320
|
# HTTP header 'Accept' (if needed)
|
|
307
321
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
308
322
|
# HTTP header 'Content-Type'
|
|
@@ -347,9 +361,10 @@ module KlaviyoAPI
|
|
|
347
361
|
alias create_profile_subscription_bulk_delete_job_with_http_info bulk_unsubscribe_profiles_with_http_info
|
|
348
362
|
|
|
349
363
|
# Bulk Unsuppress Profiles
|
|
350
|
-
# Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
364
|
+
# Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)
|
|
351
365
|
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
|
352
366
|
# @param [Hash] opts the optional parameters
|
|
367
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
353
368
|
# @return [Hash<String, Object>]
|
|
354
369
|
def bulk_unsuppress_profiles(suppression_delete_job_create_query, opts = {})
|
|
355
370
|
data, _status_code, _headers = bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts)
|
|
@@ -363,9 +378,10 @@ module KlaviyoAPI
|
|
|
363
378
|
alias create_profile_suppression_bulk_delete_job bulk_unsuppress_profiles
|
|
364
379
|
|
|
365
380
|
# Bulk Unsuppress Profiles
|
|
366
|
-
# Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
381
|
+
# Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)
|
|
367
382
|
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
|
368
383
|
# @param [Hash] opts the optional parameters
|
|
384
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
369
385
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
370
386
|
def bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts = {})
|
|
371
387
|
if @api_client.config.debugging
|
|
@@ -375,16 +391,21 @@ module KlaviyoAPI
|
|
|
375
391
|
if @api_client.config.client_side_validation && suppression_delete_job_create_query.nil?
|
|
376
392
|
fail ArgumentError, "Missing the required parameter 'suppression_delete_job_create_query' when calling ProfilesApi.bulk_unsuppress_profiles"
|
|
377
393
|
end
|
|
394
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "id", "skipped_count", "status", "total_count"]
|
|
395
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
396
|
+
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
|
|
397
|
+
end
|
|
378
398
|
# resource path
|
|
379
399
|
local_var_path = '/api/profile-suppression-bulk-delete-jobs'
|
|
380
400
|
|
|
381
401
|
# query parameters
|
|
382
402
|
query_params = opts[:query_params] || {}
|
|
403
|
+
query_params[:'fields[profile-suppression-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_delete_job'], :csv) if !opts[:'fields_profile_suppression_bulk_delete_job'].nil?
|
|
383
404
|
|
|
384
405
|
# header parameters
|
|
385
406
|
header_params = opts[:header_params] || {}
|
|
386
407
|
# klaviyo api revision
|
|
387
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
408
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
388
409
|
# HTTP header 'Accept' (if needed)
|
|
389
410
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
390
411
|
# HTTP header 'Content-Type'
|
|
@@ -429,10 +450,11 @@ module KlaviyoAPI
|
|
|
429
450
|
alias create_profile_suppression_bulk_delete_job_with_http_info bulk_unsuppress_profiles_with_http_info
|
|
430
451
|
|
|
431
452
|
# Create or Update Profile
|
|
432
|
-
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
453
|
+
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)
|
|
433
454
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
|
434
455
|
# @param [Hash] opts the optional parameters
|
|
435
456
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
457
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
436
458
|
# @return [Hash<String, Object>]
|
|
437
459
|
def create_or_update_profile(profile_upsert_query, opts = {})
|
|
438
460
|
data, _status_code, _headers = create_or_update_profile_with_http_info(profile_upsert_query, opts)
|
|
@@ -443,10 +465,11 @@ module KlaviyoAPI
|
|
|
443
465
|
alias create_profile_import create_or_update_profile
|
|
444
466
|
|
|
445
467
|
# Create or Update Profile
|
|
446
|
-
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
468
|
+
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)
|
|
447
469
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
|
448
470
|
# @param [Hash] opts the optional parameters
|
|
449
471
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
472
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
450
473
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
451
474
|
def create_or_update_profile_with_http_info(profile_upsert_query, opts = {})
|
|
452
475
|
if @api_client.config.debugging
|
|
@@ -460,17 +483,22 @@ module KlaviyoAPI
|
|
|
460
483
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
461
484
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
462
485
|
end
|
|
486
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
487
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
488
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
489
|
+
end
|
|
463
490
|
# resource path
|
|
464
491
|
local_var_path = '/api/profile-import'
|
|
465
492
|
|
|
466
493
|
# query parameters
|
|
467
494
|
query_params = opts[:query_params] || {}
|
|
468
495
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
|
496
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
|
469
497
|
|
|
470
498
|
# header parameters
|
|
471
499
|
header_params = opts[:header_params] || {}
|
|
472
500
|
# klaviyo api revision
|
|
473
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
501
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
474
502
|
# HTTP header 'Accept' (if needed)
|
|
475
503
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
476
504
|
# HTTP header 'Content-Type'
|
|
@@ -512,10 +540,11 @@ module KlaviyoAPI
|
|
|
512
540
|
alias create_profile_import_with_http_info create_or_update_profile_with_http_info
|
|
513
541
|
|
|
514
542
|
# Create Profile
|
|
515
|
-
# Create a new profile. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
543
|
+
# Create a new profile. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)
|
|
516
544
|
# @param profile_create_query [ProfileCreateQuery]
|
|
517
545
|
# @param [Hash] opts the optional parameters
|
|
518
546
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
547
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
519
548
|
# @return [Hash<String, Object>]
|
|
520
549
|
def create_profile(profile_create_query, opts = {})
|
|
521
550
|
data, _status_code, _headers = create_profile_with_http_info(profile_create_query, opts)
|
|
@@ -523,10 +552,11 @@ module KlaviyoAPI
|
|
|
523
552
|
end
|
|
524
553
|
|
|
525
554
|
# Create Profile
|
|
526
|
-
# Create a new profile. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
555
|
+
# Create a new profile. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)
|
|
527
556
|
# @param profile_create_query [ProfileCreateQuery]
|
|
528
557
|
# @param [Hash] opts the optional parameters
|
|
529
558
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
559
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
530
560
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
531
561
|
def create_profile_with_http_info(profile_create_query, opts = {})
|
|
532
562
|
if @api_client.config.debugging
|
|
@@ -540,17 +570,22 @@ module KlaviyoAPI
|
|
|
540
570
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
541
571
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
542
572
|
end
|
|
573
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
574
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
575
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
576
|
+
end
|
|
543
577
|
# resource path
|
|
544
578
|
local_var_path = '/api/profiles'
|
|
545
579
|
|
|
546
580
|
# query parameters
|
|
547
581
|
query_params = opts[:query_params] || {}
|
|
548
582
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
|
583
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
|
549
584
|
|
|
550
585
|
# header parameters
|
|
551
586
|
header_params = opts[:header_params] || {}
|
|
552
587
|
# klaviyo api revision
|
|
553
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
588
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
554
589
|
# HTTP header 'Accept' (if needed)
|
|
555
590
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
556
591
|
# HTTP header 'Content-Type'
|
|
@@ -589,7 +624,7 @@ module KlaviyoAPI
|
|
|
589
624
|
end
|
|
590
625
|
|
|
591
626
|
# Create or Update Push Token
|
|
592
|
-
# Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
627
|
+
# Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` `push-tokens:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)
|
|
593
628
|
# @param push_token_create_query [PushTokenCreateQuery]
|
|
594
629
|
# @param [Hash] opts the optional parameters
|
|
595
630
|
# @return [nil]
|
|
@@ -599,7 +634,7 @@ module KlaviyoAPI
|
|
|
599
634
|
end
|
|
600
635
|
|
|
601
636
|
# Create or Update Push Token
|
|
602
|
-
# Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
637
|
+
# Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` `push-tokens:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)
|
|
603
638
|
# @param push_token_create_query [PushTokenCreateQuery]
|
|
604
639
|
# @param [Hash] opts the optional parameters
|
|
605
640
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -620,7 +655,7 @@ module KlaviyoAPI
|
|
|
620
655
|
# header parameters
|
|
621
656
|
header_params = opts[:header_params] || {}
|
|
622
657
|
# klaviyo api revision
|
|
623
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
658
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
624
659
|
# HTTP header 'Accept' (if needed)
|
|
625
660
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
626
661
|
# HTTP header 'Content-Type'
|
|
@@ -659,7 +694,7 @@ module KlaviyoAPI
|
|
|
659
694
|
end
|
|
660
695
|
|
|
661
696
|
# Delete Push Token
|
|
662
|
-
# Delete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `push-tokens:write`
|
|
697
|
+
# Delete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `push-tokens:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)
|
|
663
698
|
# @param id [String] The value of the push token to delete
|
|
664
699
|
# @param [Hash] opts the optional parameters
|
|
665
700
|
# @return [nil]
|
|
@@ -669,7 +704,7 @@ module KlaviyoAPI
|
|
|
669
704
|
end
|
|
670
705
|
|
|
671
706
|
# Delete Push Token
|
|
672
|
-
# Delete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `push-tokens:write`
|
|
707
|
+
# Delete a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `push-tokens:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)
|
|
673
708
|
# @param id [String] The value of the push token to delete
|
|
674
709
|
# @param [Hash] opts the optional parameters
|
|
675
710
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -690,7 +725,7 @@ module KlaviyoAPI
|
|
|
690
725
|
# header parameters
|
|
691
726
|
header_params = opts[:header_params] || {}
|
|
692
727
|
# klaviyo api revision
|
|
693
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
728
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
694
729
|
# HTTP header 'Accept' (if needed)
|
|
695
730
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
696
731
|
|
|
@@ -724,12 +759,12 @@ module KlaviyoAPI
|
|
|
724
759
|
end
|
|
725
760
|
|
|
726
761
|
# Get Bulk Import Profiles Job
|
|
727
|
-
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
|
762
|
+
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)
|
|
728
763
|
# @param job_id [String] ID of the job to retrieve.
|
|
729
764
|
# @param [Hash] opts the optional parameters
|
|
730
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
731
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
732
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
765
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
766
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
767
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
733
768
|
# @return [Hash<String, Object>]
|
|
734
769
|
def get_bulk_import_profiles_job(job_id, opts = {})
|
|
735
770
|
data, _status_code, _headers = get_bulk_import_profiles_job_with_http_info(job_id, opts)
|
|
@@ -743,12 +778,12 @@ module KlaviyoAPI
|
|
|
743
778
|
alias get_profile_bulk_import_job get_bulk_import_profiles_job
|
|
744
779
|
|
|
745
780
|
# Get Bulk Import Profiles Job
|
|
746
|
-
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
|
781
|
+
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)
|
|
747
782
|
# @param job_id [String] ID of the job to retrieve.
|
|
748
783
|
# @param [Hash] opts the optional parameters
|
|
749
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
750
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
751
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
784
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
785
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
786
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
752
787
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
753
788
|
def get_bulk_import_profiles_job_with_http_info(job_id, opts = {})
|
|
754
789
|
if @api_client.config.debugging
|
|
@@ -758,11 +793,11 @@ module KlaviyoAPI
|
|
|
758
793
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
759
794
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_import_profiles_job"
|
|
760
795
|
end
|
|
761
|
-
allowable_values = ["
|
|
796
|
+
allowable_values = ["created", "id", "name", "opt_in_process", "updated"]
|
|
762
797
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
|
763
798
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
|
764
799
|
end
|
|
765
|
-
allowable_values = ["
|
|
800
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "expires_at", "failed_count", "id", "started_at", "status", "total_count"]
|
|
766
801
|
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
|
767
802
|
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
|
768
803
|
end
|
|
@@ -782,7 +817,7 @@ module KlaviyoAPI
|
|
|
782
817
|
# header parameters
|
|
783
818
|
header_params = opts[:header_params] || {}
|
|
784
819
|
# klaviyo api revision
|
|
785
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
820
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
786
821
|
# HTTP header 'Accept' (if needed)
|
|
787
822
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
788
823
|
|
|
@@ -822,13 +857,13 @@ module KlaviyoAPI
|
|
|
822
857
|
alias get_profile_bulk_import_job_with_http_info get_bulk_import_profiles_job_with_http_info
|
|
823
858
|
|
|
824
859
|
# Get Bulk Import Profiles Jobs
|
|
825
|
-
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
|
860
|
+
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)
|
|
826
861
|
# @param [Hash] opts the optional parameters
|
|
827
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
828
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
829
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
862
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
863
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
|
864
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
830
865
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
831
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
866
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
832
867
|
# @return [Hash<String, Object>]
|
|
833
868
|
def get_bulk_import_profiles_jobs(opts = {})
|
|
834
869
|
data, _status_code, _headers = get_bulk_import_profiles_jobs_with_http_info(opts)
|
|
@@ -842,19 +877,19 @@ module KlaviyoAPI
|
|
|
842
877
|
alias get_profile_bulk_import_jobs get_bulk_import_profiles_jobs
|
|
843
878
|
|
|
844
879
|
# Get Bulk Import Profiles Jobs
|
|
845
|
-
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
|
880
|
+
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)
|
|
846
881
|
# @param [Hash] opts the optional parameters
|
|
847
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
848
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
849
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
882
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
883
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
|
884
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
850
885
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
851
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
886
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
852
887
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
853
888
|
def get_bulk_import_profiles_jobs_with_http_info(opts = {})
|
|
854
889
|
if @api_client.config.debugging
|
|
855
890
|
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_import_profiles_jobs ...'
|
|
856
891
|
end
|
|
857
|
-
allowable_values = ["
|
|
892
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "expires_at", "failed_count", "id", "started_at", "status", "total_count"]
|
|
858
893
|
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
|
859
894
|
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
|
860
895
|
end
|
|
@@ -884,7 +919,7 @@ module KlaviyoAPI
|
|
|
884
919
|
# header parameters
|
|
885
920
|
header_params = opts[:header_params] || {}
|
|
886
921
|
# klaviyo api revision
|
|
887
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
922
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
888
923
|
# HTTP header 'Accept' (if needed)
|
|
889
924
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
890
925
|
|
|
@@ -924,10 +959,10 @@ module KlaviyoAPI
|
|
|
924
959
|
alias get_profile_bulk_import_jobs_with_http_info get_bulk_import_profiles_jobs_with_http_info
|
|
925
960
|
|
|
926
961
|
# Get Bulk Suppress Profiles Job
|
|
927
|
-
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
962
|
+
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)
|
|
928
963
|
# @param job_id [String] ID of the job to retrieve.
|
|
929
964
|
# @param [Hash] opts the optional parameters
|
|
930
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
965
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
931
966
|
# @return [Hash<String, Object>]
|
|
932
967
|
def get_bulk_suppress_profiles_job(job_id, opts = {})
|
|
933
968
|
data, _status_code, _headers = get_bulk_suppress_profiles_job_with_http_info(job_id, opts)
|
|
@@ -938,10 +973,10 @@ module KlaviyoAPI
|
|
|
938
973
|
alias get_profile_suppression_bulk_create_job get_bulk_suppress_profiles_job
|
|
939
974
|
|
|
940
975
|
# Get Bulk Suppress Profiles Job
|
|
941
|
-
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
976
|
+
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)
|
|
942
977
|
# @param job_id [String] ID of the job to retrieve.
|
|
943
978
|
# @param [Hash] opts the optional parameters
|
|
944
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
979
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
945
980
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
946
981
|
def get_bulk_suppress_profiles_job_with_http_info(job_id, opts = {})
|
|
947
982
|
if @api_client.config.debugging
|
|
@@ -951,7 +986,7 @@ module KlaviyoAPI
|
|
|
951
986
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
952
987
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_suppress_profiles_job"
|
|
953
988
|
end
|
|
954
|
-
allowable_values = ["
|
|
989
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "id", "skipped_count", "status", "total_count"]
|
|
955
990
|
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
956
991
|
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
|
|
957
992
|
end
|
|
@@ -965,7 +1000,7 @@ module KlaviyoAPI
|
|
|
965
1000
|
# header parameters
|
|
966
1001
|
header_params = opts[:header_params] || {}
|
|
967
1002
|
# klaviyo api revision
|
|
968
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1003
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
969
1004
|
# HTTP header 'Accept' (if needed)
|
|
970
1005
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
971
1006
|
|
|
@@ -1002,12 +1037,12 @@ module KlaviyoAPI
|
|
|
1002
1037
|
alias get_profile_suppression_bulk_create_job_with_http_info get_bulk_suppress_profiles_job_with_http_info
|
|
1003
1038
|
|
|
1004
1039
|
# Get Bulk Suppress Profiles Jobs
|
|
1005
|
-
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
1040
|
+
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)
|
|
1006
1041
|
# @param [Hash] opts the optional parameters
|
|
1007
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1008
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1009
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1010
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1042
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1043
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
|
1044
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1045
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1011
1046
|
# @return [Hash<String, Object>]
|
|
1012
1047
|
def get_bulk_suppress_profiles_jobs(opts = {})
|
|
1013
1048
|
data, _status_code, _headers = get_bulk_suppress_profiles_jobs_with_http_info(opts)
|
|
@@ -1018,18 +1053,18 @@ module KlaviyoAPI
|
|
|
1018
1053
|
alias get_profile_suppression_bulk_create_jobs get_bulk_suppress_profiles_jobs
|
|
1019
1054
|
|
|
1020
1055
|
# Get Bulk Suppress Profiles Jobs
|
|
1021
|
-
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
1056
|
+
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)
|
|
1022
1057
|
# @param [Hash] opts the optional parameters
|
|
1023
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1024
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1025
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1026
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1058
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1059
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
|
1060
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1061
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1027
1062
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1028
1063
|
def get_bulk_suppress_profiles_jobs_with_http_info(opts = {})
|
|
1029
1064
|
if @api_client.config.debugging
|
|
1030
1065
|
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_suppress_profiles_jobs ...'
|
|
1031
1066
|
end
|
|
1032
|
-
allowable_values = ["
|
|
1067
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "id", "skipped_count", "status", "total_count"]
|
|
1033
1068
|
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
|
1034
1069
|
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
|
|
1035
1070
|
end
|
|
@@ -1050,7 +1085,7 @@ module KlaviyoAPI
|
|
|
1050
1085
|
# header parameters
|
|
1051
1086
|
header_params = opts[:header_params] || {}
|
|
1052
1087
|
# klaviyo api revision
|
|
1053
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1088
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1054
1089
|
# HTTP header 'Accept' (if needed)
|
|
1055
1090
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1056
1091
|
|
|
@@ -1087,10 +1122,10 @@ module KlaviyoAPI
|
|
|
1087
1122
|
alias get_profile_suppression_bulk_create_jobs_with_http_info get_bulk_suppress_profiles_jobs_with_http_info
|
|
1088
1123
|
|
|
1089
1124
|
# Get Bulk Unsuppress Profiles Job
|
|
1090
|
-
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
1125
|
+
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)
|
|
1091
1126
|
# @param job_id [String] ID of the job to retrieve.
|
|
1092
1127
|
# @param [Hash] opts the optional parameters
|
|
1093
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1128
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1094
1129
|
# @return [Hash<String, Object>]
|
|
1095
1130
|
def get_bulk_unsuppress_profiles_job(job_id, opts = {})
|
|
1096
1131
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts)
|
|
@@ -1101,10 +1136,10 @@ module KlaviyoAPI
|
|
|
1101
1136
|
alias get_profile_suppression_bulk_delete_job get_bulk_unsuppress_profiles_job
|
|
1102
1137
|
|
|
1103
1138
|
# Get Bulk Unsuppress Profiles Job
|
|
1104
|
-
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
1139
|
+
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)
|
|
1105
1140
|
# @param job_id [String] ID of the job to retrieve.
|
|
1106
1141
|
# @param [Hash] opts the optional parameters
|
|
1107
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1142
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1108
1143
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1109
1144
|
def get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts = {})
|
|
1110
1145
|
if @api_client.config.debugging
|
|
@@ -1114,7 +1149,7 @@ module KlaviyoAPI
|
|
|
1114
1149
|
if @api_client.config.client_side_validation && job_id.nil?
|
|
1115
1150
|
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_unsuppress_profiles_job"
|
|
1116
1151
|
end
|
|
1117
|
-
allowable_values = ["
|
|
1152
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "id", "skipped_count", "status", "total_count"]
|
|
1118
1153
|
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
1119
1154
|
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
|
|
1120
1155
|
end
|
|
@@ -1128,7 +1163,7 @@ module KlaviyoAPI
|
|
|
1128
1163
|
# header parameters
|
|
1129
1164
|
header_params = opts[:header_params] || {}
|
|
1130
1165
|
# klaviyo api revision
|
|
1131
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1166
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1132
1167
|
# HTTP header 'Accept' (if needed)
|
|
1133
1168
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1134
1169
|
|
|
@@ -1165,12 +1200,12 @@ module KlaviyoAPI
|
|
|
1165
1200
|
alias get_profile_suppression_bulk_delete_job_with_http_info get_bulk_unsuppress_profiles_job_with_http_info
|
|
1166
1201
|
|
|
1167
1202
|
# Get Bulk Unsuppress Profiles Jobs
|
|
1168
|
-
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
1203
|
+
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)
|
|
1169
1204
|
# @param [Hash] opts the optional parameters
|
|
1170
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1171
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1172
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1173
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1205
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1206
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
|
1207
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1208
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1174
1209
|
# @return [Hash<String, Object>]
|
|
1175
1210
|
def get_bulk_unsuppress_profiles_jobs(opts = {})
|
|
1176
1211
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_jobs_with_http_info(opts)
|
|
@@ -1181,18 +1216,18 @@ module KlaviyoAPI
|
|
|
1181
1216
|
alias get_profile_suppression_bulk_delete_jobs get_bulk_unsuppress_profiles_jobs
|
|
1182
1217
|
|
|
1183
1218
|
# Get Bulk Unsuppress Profiles Jobs
|
|
1184
|
-
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
1219
|
+
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `subscriptions:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)
|
|
1185
1220
|
# @param [Hash] opts the optional parameters
|
|
1186
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1187
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1188
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1189
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1221
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1222
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
|
1223
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1224
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1190
1225
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1191
1226
|
def get_bulk_unsuppress_profiles_jobs_with_http_info(opts = {})
|
|
1192
1227
|
if @api_client.config.debugging
|
|
1193
1228
|
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_unsuppress_profiles_jobs ...'
|
|
1194
1229
|
end
|
|
1195
|
-
allowable_values = ["
|
|
1230
|
+
allowable_values = ["completed_at", "completed_count", "created_at", "id", "skipped_count", "status", "total_count"]
|
|
1196
1231
|
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
|
1197
1232
|
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
|
|
1198
1233
|
end
|
|
@@ -1213,7 +1248,7 @@ module KlaviyoAPI
|
|
|
1213
1248
|
# header parameters
|
|
1214
1249
|
header_params = opts[:header_params] || {}
|
|
1215
1250
|
# klaviyo api revision
|
|
1216
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1251
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1217
1252
|
# HTTP header 'Accept' (if needed)
|
|
1218
1253
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1219
1254
|
|
|
@@ -1249,12 +1284,310 @@ module KlaviyoAPI
|
|
|
1249
1284
|
# alias of `get_bulk_unsuppress_profiles_jobs_with_http_info`
|
|
1250
1285
|
alias get_profile_suppression_bulk_delete_jobs_with_http_info get_bulk_unsuppress_profiles_jobs_with_http_info
|
|
1251
1286
|
|
|
1287
|
+
# Get Conversation for Profile
|
|
1288
|
+
# Get the conversation for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)
|
|
1289
|
+
# @param id [String]
|
|
1290
|
+
# @param [Hash] opts the optional parameters
|
|
1291
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1292
|
+
# @return [Hash<String, Object>]
|
|
1293
|
+
def get_conversation_for_profile(id, opts = {})
|
|
1294
|
+
data, _status_code, _headers = get_conversation_for_profile_with_http_info(id, opts)
|
|
1295
|
+
data
|
|
1296
|
+
end
|
|
1297
|
+
|
|
1298
|
+
# alias of `get_conversation_for_profile`
|
|
1299
|
+
alias get_profile_conversation get_conversation_for_profile
|
|
1300
|
+
|
|
1301
|
+
# Get Conversation for Profile
|
|
1302
|
+
# Get the conversation for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)
|
|
1303
|
+
# @param id [String]
|
|
1304
|
+
# @param [Hash] opts the optional parameters
|
|
1305
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1306
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1307
|
+
def get_conversation_for_profile_with_http_info(id, opts = {})
|
|
1308
|
+
if @api_client.config.debugging
|
|
1309
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_conversation_for_profile ...'
|
|
1310
|
+
end
|
|
1311
|
+
# verify the required parameter 'id' is set
|
|
1312
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1313
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_conversation_for_profile"
|
|
1314
|
+
end
|
|
1315
|
+
allowable_values = ["channel", "id"]
|
|
1316
|
+
if @api_client.config.client_side_validation && opts[:'fields_conversation'] && !opts[:'fields_conversation'].all? { |item| allowable_values.include?(item) }
|
|
1317
|
+
fail ArgumentError, "invalid value for \"fields_conversation\", must include one of #{allowable_values}"
|
|
1318
|
+
end
|
|
1319
|
+
# resource path
|
|
1320
|
+
local_var_path = '/api/profiles/{id}/conversation'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1321
|
+
|
|
1322
|
+
# query parameters
|
|
1323
|
+
query_params = opts[:query_params] || {}
|
|
1324
|
+
query_params[:'fields[conversation]'] = @api_client.build_collection_param(opts[:'fields_conversation'], :csv) if !opts[:'fields_conversation'].nil?
|
|
1325
|
+
|
|
1326
|
+
# header parameters
|
|
1327
|
+
header_params = opts[:header_params] || {}
|
|
1328
|
+
# klaviyo api revision
|
|
1329
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1330
|
+
# HTTP header 'Accept' (if needed)
|
|
1331
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1332
|
+
|
|
1333
|
+
# form parameters
|
|
1334
|
+
form_params = opts[:form_params] || {}
|
|
1335
|
+
|
|
1336
|
+
# http body (model)
|
|
1337
|
+
post_body = opts[:debug_body]
|
|
1338
|
+
|
|
1339
|
+
# return_type
|
|
1340
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
1341
|
+
|
|
1342
|
+
# auth_names
|
|
1343
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
1344
|
+
|
|
1345
|
+
new_options = opts.merge(
|
|
1346
|
+
:operation => :"ProfilesApi.get_conversation_for_profile",
|
|
1347
|
+
:header_params => header_params,
|
|
1348
|
+
:query_params => query_params,
|
|
1349
|
+
:form_params => form_params,
|
|
1350
|
+
:body => post_body,
|
|
1351
|
+
:auth_names => auth_names,
|
|
1352
|
+
:return_type => return_type
|
|
1353
|
+
)
|
|
1354
|
+
|
|
1355
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1356
|
+
if @api_client.config.debugging
|
|
1357
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_conversation_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1358
|
+
end
|
|
1359
|
+
return data, status_code, headers
|
|
1360
|
+
end
|
|
1361
|
+
|
|
1362
|
+
# alias of `get_conversation_for_profile_with_http_info`
|
|
1363
|
+
alias get_profile_conversation_with_http_info get_conversation_for_profile_with_http_info
|
|
1364
|
+
|
|
1365
|
+
# Get Conversation ID for Profile
|
|
1366
|
+
# Get the conversation relationship for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)
|
|
1367
|
+
# @param id [String]
|
|
1368
|
+
# @param [Hash] opts the optional parameters
|
|
1369
|
+
# @return [Hash<String, Object>]
|
|
1370
|
+
def get_conversation_id_for_profile(id, opts = {})
|
|
1371
|
+
data, _status_code, _headers = get_conversation_id_for_profile_with_http_info(id, opts)
|
|
1372
|
+
data
|
|
1373
|
+
end
|
|
1374
|
+
|
|
1375
|
+
# alias of `get_conversation_id_for_profile`
|
|
1376
|
+
alias get_profile_relationships_conversation get_conversation_id_for_profile
|
|
1377
|
+
|
|
1378
|
+
# Get Conversation ID for Profile
|
|
1379
|
+
# Get the conversation relationship for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)
|
|
1380
|
+
# @param id [String]
|
|
1381
|
+
# @param [Hash] opts the optional parameters
|
|
1382
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1383
|
+
def get_conversation_id_for_profile_with_http_info(id, opts = {})
|
|
1384
|
+
if @api_client.config.debugging
|
|
1385
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_conversation_id_for_profile ...'
|
|
1386
|
+
end
|
|
1387
|
+
# verify the required parameter 'id' is set
|
|
1388
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1389
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_conversation_id_for_profile"
|
|
1390
|
+
end
|
|
1391
|
+
# resource path
|
|
1392
|
+
local_var_path = '/api/profiles/{id}/relationships/conversation'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1393
|
+
|
|
1394
|
+
# query parameters
|
|
1395
|
+
query_params = opts[:query_params] || {}
|
|
1396
|
+
|
|
1397
|
+
# header parameters
|
|
1398
|
+
header_params = opts[:header_params] || {}
|
|
1399
|
+
# klaviyo api revision
|
|
1400
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1401
|
+
# HTTP header 'Accept' (if needed)
|
|
1402
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1403
|
+
|
|
1404
|
+
# form parameters
|
|
1405
|
+
form_params = opts[:form_params] || {}
|
|
1406
|
+
|
|
1407
|
+
# http body (model)
|
|
1408
|
+
post_body = opts[:debug_body]
|
|
1409
|
+
|
|
1410
|
+
# return_type
|
|
1411
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
1412
|
+
|
|
1413
|
+
# auth_names
|
|
1414
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
1415
|
+
|
|
1416
|
+
new_options = opts.merge(
|
|
1417
|
+
:operation => :"ProfilesApi.get_conversation_id_for_profile",
|
|
1418
|
+
:header_params => header_params,
|
|
1419
|
+
:query_params => query_params,
|
|
1420
|
+
:form_params => form_params,
|
|
1421
|
+
:body => post_body,
|
|
1422
|
+
:auth_names => auth_names,
|
|
1423
|
+
:return_type => return_type
|
|
1424
|
+
)
|
|
1425
|
+
|
|
1426
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1427
|
+
if @api_client.config.debugging
|
|
1428
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_conversation_id_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1429
|
+
end
|
|
1430
|
+
return data, status_code, headers
|
|
1431
|
+
end
|
|
1432
|
+
|
|
1433
|
+
# alias of `get_conversation_id_for_profile_with_http_info`
|
|
1434
|
+
alias get_profile_relationships_conversation_with_http_info get_conversation_id_for_profile_with_http_info
|
|
1435
|
+
|
|
1436
|
+
# Get Conversation IDs for Profile
|
|
1437
|
+
# Get the IDs of all conversations for a profile across all channels.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_ids_for_profile.json)
|
|
1438
|
+
# @param id [String]
|
|
1439
|
+
# @param [Hash] opts the optional parameters
|
|
1440
|
+
# @return [Hash<String, Object>]
|
|
1441
|
+
def get_conversation_ids_for_profile(id, opts = {})
|
|
1442
|
+
data, _status_code, _headers = get_conversation_ids_for_profile_with_http_info(id, opts)
|
|
1443
|
+
data
|
|
1444
|
+
end
|
|
1445
|
+
|
|
1446
|
+
# alias of `get_conversation_ids_for_profile`
|
|
1447
|
+
alias get_profile_relationships_conversations get_conversation_ids_for_profile
|
|
1448
|
+
|
|
1449
|
+
# Get Conversation IDs for Profile
|
|
1450
|
+
# Get the IDs of all conversations for a profile across all channels.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_ids_for_profile.json)
|
|
1451
|
+
# @param id [String]
|
|
1452
|
+
# @param [Hash] opts the optional parameters
|
|
1453
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1454
|
+
def get_conversation_ids_for_profile_with_http_info(id, opts = {})
|
|
1455
|
+
if @api_client.config.debugging
|
|
1456
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_conversation_ids_for_profile ...'
|
|
1457
|
+
end
|
|
1458
|
+
# verify the required parameter 'id' is set
|
|
1459
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1460
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_conversation_ids_for_profile"
|
|
1461
|
+
end
|
|
1462
|
+
# resource path
|
|
1463
|
+
local_var_path = '/api/profiles/{id}/relationships/conversations'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1464
|
+
|
|
1465
|
+
# query parameters
|
|
1466
|
+
query_params = opts[:query_params] || {}
|
|
1467
|
+
|
|
1468
|
+
# header parameters
|
|
1469
|
+
header_params = opts[:header_params] || {}
|
|
1470
|
+
# klaviyo api revision
|
|
1471
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1472
|
+
# HTTP header 'Accept' (if needed)
|
|
1473
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1474
|
+
|
|
1475
|
+
# form parameters
|
|
1476
|
+
form_params = opts[:form_params] || {}
|
|
1477
|
+
|
|
1478
|
+
# http body (model)
|
|
1479
|
+
post_body = opts[:debug_body]
|
|
1480
|
+
|
|
1481
|
+
# return_type
|
|
1482
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
1483
|
+
|
|
1484
|
+
# auth_names
|
|
1485
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
1486
|
+
|
|
1487
|
+
new_options = opts.merge(
|
|
1488
|
+
:operation => :"ProfilesApi.get_conversation_ids_for_profile",
|
|
1489
|
+
:header_params => header_params,
|
|
1490
|
+
:query_params => query_params,
|
|
1491
|
+
:form_params => form_params,
|
|
1492
|
+
:body => post_body,
|
|
1493
|
+
:auth_names => auth_names,
|
|
1494
|
+
:return_type => return_type
|
|
1495
|
+
)
|
|
1496
|
+
|
|
1497
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1498
|
+
if @api_client.config.debugging
|
|
1499
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_conversation_ids_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1500
|
+
end
|
|
1501
|
+
return data, status_code, headers
|
|
1502
|
+
end
|
|
1503
|
+
|
|
1504
|
+
# alias of `get_conversation_ids_for_profile_with_http_info`
|
|
1505
|
+
alias get_profile_relationships_conversations_with_http_info get_conversation_ids_for_profile_with_http_info
|
|
1506
|
+
|
|
1507
|
+
# Get Conversations for Profile
|
|
1508
|
+
# Get all conversations for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversations_for_profile.json)
|
|
1509
|
+
# @param id [String]
|
|
1510
|
+
# @param [Hash] opts the optional parameters
|
|
1511
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1512
|
+
# @return [Hash<String, Object>]
|
|
1513
|
+
def get_conversations_for_profile(id, opts = {})
|
|
1514
|
+
data, _status_code, _headers = get_conversations_for_profile_with_http_info(id, opts)
|
|
1515
|
+
data
|
|
1516
|
+
end
|
|
1517
|
+
|
|
1518
|
+
# alias of `get_conversations_for_profile`
|
|
1519
|
+
alias get_profile_conversations get_conversations_for_profile
|
|
1520
|
+
|
|
1521
|
+
# Get Conversations for Profile
|
|
1522
|
+
# Get all conversations for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `conversations:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversations_for_profile.json)
|
|
1523
|
+
# @param id [String]
|
|
1524
|
+
# @param [Hash] opts the optional parameters
|
|
1525
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1526
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1527
|
+
def get_conversations_for_profile_with_http_info(id, opts = {})
|
|
1528
|
+
if @api_client.config.debugging
|
|
1529
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_conversations_for_profile ...'
|
|
1530
|
+
end
|
|
1531
|
+
# verify the required parameter 'id' is set
|
|
1532
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1533
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_conversations_for_profile"
|
|
1534
|
+
end
|
|
1535
|
+
allowable_values = ["channel", "id"]
|
|
1536
|
+
if @api_client.config.client_side_validation && opts[:'fields_conversation'] && !opts[:'fields_conversation'].all? { |item| allowable_values.include?(item) }
|
|
1537
|
+
fail ArgumentError, "invalid value for \"fields_conversation\", must include one of #{allowable_values}"
|
|
1538
|
+
end
|
|
1539
|
+
# resource path
|
|
1540
|
+
local_var_path = '/api/profiles/{id}/conversations'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1541
|
+
|
|
1542
|
+
# query parameters
|
|
1543
|
+
query_params = opts[:query_params] || {}
|
|
1544
|
+
query_params[:'fields[conversation]'] = @api_client.build_collection_param(opts[:'fields_conversation'], :csv) if !opts[:'fields_conversation'].nil?
|
|
1545
|
+
|
|
1546
|
+
# header parameters
|
|
1547
|
+
header_params = opts[:header_params] || {}
|
|
1548
|
+
# klaviyo api revision
|
|
1549
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1550
|
+
# HTTP header 'Accept' (if needed)
|
|
1551
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1552
|
+
|
|
1553
|
+
# form parameters
|
|
1554
|
+
form_params = opts[:form_params] || {}
|
|
1555
|
+
|
|
1556
|
+
# http body (model)
|
|
1557
|
+
post_body = opts[:debug_body]
|
|
1558
|
+
|
|
1559
|
+
# return_type
|
|
1560
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
1561
|
+
|
|
1562
|
+
# auth_names
|
|
1563
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
1564
|
+
|
|
1565
|
+
new_options = opts.merge(
|
|
1566
|
+
:operation => :"ProfilesApi.get_conversations_for_profile",
|
|
1567
|
+
:header_params => header_params,
|
|
1568
|
+
:query_params => query_params,
|
|
1569
|
+
:form_params => form_params,
|
|
1570
|
+
:body => post_body,
|
|
1571
|
+
:auth_names => auth_names,
|
|
1572
|
+
:return_type => return_type
|
|
1573
|
+
)
|
|
1574
|
+
|
|
1575
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1576
|
+
if @api_client.config.debugging
|
|
1577
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_conversations_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1578
|
+
end
|
|
1579
|
+
return data, status_code, headers
|
|
1580
|
+
end
|
|
1581
|
+
|
|
1582
|
+
# alias of `get_conversations_for_profile_with_http_info`
|
|
1583
|
+
alias get_profile_conversations_with_http_info get_conversations_for_profile_with_http_info
|
|
1584
|
+
|
|
1252
1585
|
# Get Errors for Bulk Import Profiles Job
|
|
1253
|
-
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
1586
|
+
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)
|
|
1254
1587
|
# @param id [String]
|
|
1255
1588
|
# @param [Hash] opts the optional parameters
|
|
1256
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1257
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1589
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1590
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1258
1591
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
1259
1592
|
# @return [Hash<String, Object>]
|
|
1260
1593
|
def get_errors_for_bulk_import_profiles_job(id, opts = {})
|
|
@@ -1272,11 +1605,11 @@ module KlaviyoAPI
|
|
|
1272
1605
|
alias get_profile_bulk_import_job_import_errors get_errors_for_bulk_import_profiles_job
|
|
1273
1606
|
|
|
1274
1607
|
# Get Errors for Bulk Import Profiles Job
|
|
1275
|
-
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
1608
|
+
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)
|
|
1276
1609
|
# @param id [String]
|
|
1277
1610
|
# @param [Hash] opts the optional parameters
|
|
1278
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1279
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1611
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1612
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1280
1613
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
1281
1614
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1282
1615
|
def get_errors_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
|
@@ -1287,7 +1620,7 @@ module KlaviyoAPI
|
|
|
1287
1620
|
if @api_client.config.client_side_validation && id.nil?
|
|
1288
1621
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_errors_for_bulk_import_profiles_job"
|
|
1289
1622
|
end
|
|
1290
|
-
allowable_values = ["code", "
|
|
1623
|
+
allowable_values = ["code", "detail", "id", "original_payload", "source", "source.pointer", "title"]
|
|
1291
1624
|
if @api_client.config.client_side_validation && opts[:'fields_import_error'] && !opts[:'fields_import_error'].all? { |item| allowable_values.include?(item) }
|
|
1292
1625
|
fail ArgumentError, "invalid value for \"fields_import_error\", must include one of #{allowable_values}"
|
|
1293
1626
|
end
|
|
@@ -1311,7 +1644,7 @@ module KlaviyoAPI
|
|
|
1311
1644
|
# header parameters
|
|
1312
1645
|
header_params = opts[:header_params] || {}
|
|
1313
1646
|
# klaviyo api revision
|
|
1314
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1647
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1315
1648
|
# HTTP header 'Accept' (if needed)
|
|
1316
1649
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1317
1650
|
|
|
@@ -1354,10 +1687,10 @@ module KlaviyoAPI
|
|
|
1354
1687
|
alias get_profile_bulk_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
|
|
1355
1688
|
|
|
1356
1689
|
# Get List for Bulk Import Profiles Job
|
|
1357
|
-
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
|
1690
|
+
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)
|
|
1358
1691
|
# @param id [String]
|
|
1359
1692
|
# @param [Hash] opts the optional parameters
|
|
1360
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1693
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1361
1694
|
# @return [Hash<String, Object>]
|
|
1362
1695
|
def get_list_for_bulk_import_profiles_job(id, opts = {})
|
|
1363
1696
|
data, _status_code, _headers = get_list_for_bulk_import_profiles_job_with_http_info(id, opts)
|
|
@@ -1374,10 +1707,10 @@ module KlaviyoAPI
|
|
|
1374
1707
|
alias get_profile_bulk_import_job_lists get_list_for_bulk_import_profiles_job
|
|
1375
1708
|
|
|
1376
1709
|
# Get List for Bulk Import Profiles Job
|
|
1377
|
-
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
|
1710
|
+
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)
|
|
1378
1711
|
# @param id [String]
|
|
1379
1712
|
# @param [Hash] opts the optional parameters
|
|
1380
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1713
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1381
1714
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1382
1715
|
def get_list_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
|
1383
1716
|
if @api_client.config.debugging
|
|
@@ -1387,7 +1720,7 @@ module KlaviyoAPI
|
|
|
1387
1720
|
if @api_client.config.client_side_validation && id.nil?
|
|
1388
1721
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_for_bulk_import_profiles_job"
|
|
1389
1722
|
end
|
|
1390
|
-
allowable_values = ["
|
|
1723
|
+
allowable_values = ["created", "id", "name", "opt_in_process", "updated"]
|
|
1391
1724
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
|
1392
1725
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
|
1393
1726
|
end
|
|
@@ -1401,7 +1734,7 @@ module KlaviyoAPI
|
|
|
1401
1734
|
# header parameters
|
|
1402
1735
|
header_params = opts[:header_params] || {}
|
|
1403
1736
|
# klaviyo api revision
|
|
1404
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1737
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1405
1738
|
# HTTP header 'Accept' (if needed)
|
|
1406
1739
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1407
1740
|
|
|
@@ -1444,7 +1777,7 @@ module KlaviyoAPI
|
|
|
1444
1777
|
alias get_profile_bulk_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
|
|
1445
1778
|
|
|
1446
1779
|
# Get List IDs for Bulk Import Profiles Job
|
|
1447
|
-
# Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
|
1780
|
+
# Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)
|
|
1448
1781
|
# @param id [String]
|
|
1449
1782
|
# @param [Hash] opts the optional parameters
|
|
1450
1783
|
# @return [Hash<String, Object>]
|
|
@@ -1463,7 +1796,7 @@ module KlaviyoAPI
|
|
|
1463
1796
|
alias get_profile_bulk_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
|
|
1464
1797
|
|
|
1465
1798
|
# Get List IDs for Bulk Import Profiles Job
|
|
1466
|
-
# Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
|
1799
|
+
# Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)
|
|
1467
1800
|
# @param id [String]
|
|
1468
1801
|
# @param [Hash] opts the optional parameters
|
|
1469
1802
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1484,7 +1817,7 @@ module KlaviyoAPI
|
|
|
1484
1817
|
# header parameters
|
|
1485
1818
|
header_params = opts[:header_params] || {}
|
|
1486
1819
|
# klaviyo api revision
|
|
1487
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1820
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1488
1821
|
# HTTP header 'Accept' (if needed)
|
|
1489
1822
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1490
1823
|
|
|
@@ -1527,7 +1860,7 @@ module KlaviyoAPI
|
|
|
1527
1860
|
alias get_profile_bulk_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
|
|
1528
1861
|
|
|
1529
1862
|
# Get List IDs for Profile
|
|
1530
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
|
1863
|
+
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)
|
|
1531
1864
|
# @param id [String]
|
|
1532
1865
|
# @param [Hash] opts the optional parameters
|
|
1533
1866
|
# @return [Hash<String, Object>]
|
|
@@ -1540,7 +1873,7 @@ module KlaviyoAPI
|
|
|
1540
1873
|
alias get_profile_relationships_lists get_list_ids_for_profile
|
|
1541
1874
|
|
|
1542
1875
|
# Get List IDs for Profile
|
|
1543
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
|
1876
|
+
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)
|
|
1544
1877
|
# @param id [String]
|
|
1545
1878
|
# @param [Hash] opts the optional parameters
|
|
1546
1879
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1561,7 +1894,7 @@ module KlaviyoAPI
|
|
|
1561
1894
|
# header parameters
|
|
1562
1895
|
header_params = opts[:header_params] || {}
|
|
1563
1896
|
# klaviyo api revision
|
|
1564
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1897
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1565
1898
|
# HTTP header 'Accept' (if needed)
|
|
1566
1899
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1567
1900
|
|
|
@@ -1598,10 +1931,10 @@ module KlaviyoAPI
|
|
|
1598
1931
|
alias get_profile_relationships_lists_with_http_info get_list_ids_for_profile_with_http_info
|
|
1599
1932
|
|
|
1600
1933
|
# Get Lists for Profile
|
|
1601
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
|
1934
|
+
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)
|
|
1602
1935
|
# @param id [String]
|
|
1603
1936
|
# @param [Hash] opts the optional parameters
|
|
1604
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1937
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1605
1938
|
# @return [Hash<String, Object>]
|
|
1606
1939
|
def get_lists_for_profile(id, opts = {})
|
|
1607
1940
|
data, _status_code, _headers = get_lists_for_profile_with_http_info(id, opts)
|
|
@@ -1612,10 +1945,10 @@ module KlaviyoAPI
|
|
|
1612
1945
|
alias get_profile_lists get_lists_for_profile
|
|
1613
1946
|
|
|
1614
1947
|
# Get Lists for Profile
|
|
1615
|
-
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
|
1948
|
+
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)
|
|
1616
1949
|
# @param id [String]
|
|
1617
1950
|
# @param [Hash] opts the optional parameters
|
|
1618
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1951
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1619
1952
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1620
1953
|
def get_lists_for_profile_with_http_info(id, opts = {})
|
|
1621
1954
|
if @api_client.config.debugging
|
|
@@ -1625,7 +1958,7 @@ module KlaviyoAPI
|
|
|
1625
1958
|
if @api_client.config.client_side_validation && id.nil?
|
|
1626
1959
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_lists_for_profile"
|
|
1627
1960
|
end
|
|
1628
|
-
allowable_values = ["
|
|
1961
|
+
allowable_values = ["created", "id", "name", "opt_in_process", "updated"]
|
|
1629
1962
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
|
1630
1963
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
|
1631
1964
|
end
|
|
@@ -1639,7 +1972,7 @@ module KlaviyoAPI
|
|
|
1639
1972
|
# header parameters
|
|
1640
1973
|
header_params = opts[:header_params] || {}
|
|
1641
1974
|
# klaviyo api revision
|
|
1642
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1975
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1643
1976
|
# HTTP header 'Accept' (if needed)
|
|
1644
1977
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1645
1978
|
|
|
@@ -1676,15 +2009,16 @@ module KlaviyoAPI
|
|
|
1676
2009
|
alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
|
|
1677
2010
|
|
|
1678
2011
|
# Get Profile
|
|
1679
|
-
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
2012
|
+
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)
|
|
1680
2013
|
# @param id [String]
|
|
1681
2014
|
# @param [Hash] opts the optional parameters
|
|
1682
2015
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
1683
|
-
# @option opts [Array<String>] :
|
|
1684
|
-
# @option opts [Array<String>] :
|
|
1685
|
-
# @option opts [Array<String>] :
|
|
1686
|
-
# @option opts [Array<String>] :
|
|
1687
|
-
# @option opts [Array<String>] :
|
|
2016
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2017
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2018
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2019
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2020
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2021
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1688
2022
|
# @return [Hash<String, Object>]
|
|
1689
2023
|
def get_profile(id, opts = {})
|
|
1690
2024
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
|
@@ -1692,15 +2026,16 @@ module KlaviyoAPI
|
|
|
1692
2026
|
end
|
|
1693
2027
|
|
|
1694
2028
|
# Get Profile
|
|
1695
|
-
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
2029
|
+
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)
|
|
1696
2030
|
# @param id [String]
|
|
1697
2031
|
# @param [Hash] opts the optional parameters
|
|
1698
2032
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
1699
|
-
# @option opts [Array<String>] :
|
|
1700
|
-
# @option opts [Array<String>] :
|
|
1701
|
-
# @option opts [Array<String>] :
|
|
1702
|
-
# @option opts [Array<String>] :
|
|
1703
|
-
# @option opts [Array<String>] :
|
|
2033
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2034
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2035
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2036
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2037
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2038
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1704
2039
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1705
2040
|
def get_profile_with_http_info(id, opts = {})
|
|
1706
2041
|
if @api_client.config.debugging
|
|
@@ -1714,23 +2049,27 @@ module KlaviyoAPI
|
|
|
1714
2049
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
1715
2050
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
1716
2051
|
end
|
|
1717
|
-
allowable_values = ["
|
|
2052
|
+
allowable_values = ["channel", "id"]
|
|
2053
|
+
if @api_client.config.client_side_validation && opts[:'fields_conversation'] && !opts[:'fields_conversation'].all? { |item| allowable_values.include?(item) }
|
|
2054
|
+
fail ArgumentError, "invalid value for \"fields_conversation\", must include one of #{allowable_values}"
|
|
2055
|
+
end
|
|
2056
|
+
allowable_values = ["created", "id", "name", "opt_in_process", "updated"]
|
|
1718
2057
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
|
1719
2058
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
|
1720
2059
|
end
|
|
1721
|
-
allowable_values = ["
|
|
2060
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
1722
2061
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
1723
2062
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
1724
2063
|
end
|
|
1725
|
-
allowable_values = ["
|
|
2064
|
+
allowable_values = ["background", "created", "enablement_status", "id", "metadata", "metadata.app_build", "metadata.app_id", "metadata.app_name", "metadata.app_version", "metadata.device_id", "metadata.device_model", "metadata.environment", "metadata.klaviyo_sdk", "metadata.manufacturer", "metadata.os_name", "metadata.os_version", "metadata.sdk_version", "platform", "recorded_date", "token", "vendor"]
|
|
1726
2065
|
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
|
1727
2066
|
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
|
1728
2067
|
end
|
|
1729
|
-
allowable_values = ["
|
|
2068
|
+
allowable_values = ["created", "definition", "definition.condition_groups", "id", "is_active", "is_processing", "is_starred", "name", "updated"]
|
|
1730
2069
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
1731
2070
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
|
1732
2071
|
end
|
|
1733
|
-
allowable_values = ["lists", "push-tokens", "segments"]
|
|
2072
|
+
allowable_values = ["conversations", "lists", "push-tokens", "segments"]
|
|
1734
2073
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
1735
2074
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
1736
2075
|
end
|
|
@@ -1740,6 +2079,7 @@ module KlaviyoAPI
|
|
|
1740
2079
|
# query parameters
|
|
1741
2080
|
query_params = opts[:query_params] || {}
|
|
1742
2081
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
|
2082
|
+
query_params[:'fields[conversation]'] = @api_client.build_collection_param(opts[:'fields_conversation'], :csv) if !opts[:'fields_conversation'].nil?
|
|
1743
2083
|
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
|
1744
2084
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
|
1745
2085
|
query_params[:'fields[push-token]'] = @api_client.build_collection_param(opts[:'fields_push_token'], :csv) if !opts[:'fields_push_token'].nil?
|
|
@@ -1749,7 +2089,7 @@ module KlaviyoAPI
|
|
|
1749
2089
|
# header parameters
|
|
1750
2090
|
header_params = opts[:header_params] || {}
|
|
1751
2091
|
# klaviyo api revision
|
|
1752
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2092
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1753
2093
|
# HTTP header 'Accept' (if needed)
|
|
1754
2094
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1755
2095
|
|
|
@@ -1783,11 +2123,11 @@ module KlaviyoAPI
|
|
|
1783
2123
|
end
|
|
1784
2124
|
|
|
1785
2125
|
# Get Profile for Push Token
|
|
1786
|
-
# Return the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2126
|
+
# Return the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)
|
|
1787
2127
|
# @param id [String] The value of the push token
|
|
1788
2128
|
# @param [Hash] opts the optional parameters
|
|
1789
2129
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
1790
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2130
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1791
2131
|
# @return [Hash<String, Object>]
|
|
1792
2132
|
def get_profile_for_push_token(id, opts = {})
|
|
1793
2133
|
data, _status_code, _headers = get_profile_for_push_token_with_http_info(id, opts)
|
|
@@ -1798,11 +2138,11 @@ module KlaviyoAPI
|
|
|
1798
2138
|
alias get_push_token_profile get_profile_for_push_token
|
|
1799
2139
|
|
|
1800
2140
|
# Get Profile for Push Token
|
|
1801
|
-
# Return the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2141
|
+
# Return the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)
|
|
1802
2142
|
# @param id [String] The value of the push token
|
|
1803
2143
|
# @param [Hash] opts the optional parameters
|
|
1804
2144
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
1805
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2145
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1806
2146
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1807
2147
|
def get_profile_for_push_token_with_http_info(id, opts = {})
|
|
1808
2148
|
if @api_client.config.debugging
|
|
@@ -1816,7 +2156,7 @@ module KlaviyoAPI
|
|
|
1816
2156
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
1817
2157
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
1818
2158
|
end
|
|
1819
|
-
allowable_values = ["
|
|
2159
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
1820
2160
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
1821
2161
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
1822
2162
|
end
|
|
@@ -1831,7 +2171,7 @@ module KlaviyoAPI
|
|
|
1831
2171
|
# header parameters
|
|
1832
2172
|
header_params = opts[:header_params] || {}
|
|
1833
2173
|
# klaviyo api revision
|
|
1834
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2174
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1835
2175
|
# HTTP header 'Accept' (if needed)
|
|
1836
2176
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1837
2177
|
|
|
@@ -1868,7 +2208,7 @@ module KlaviyoAPI
|
|
|
1868
2208
|
alias get_push_token_profile_with_http_info get_profile_for_push_token_with_http_info
|
|
1869
2209
|
|
|
1870
2210
|
# Get Profile ID for Push Token
|
|
1871
|
-
# Return the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2211
|
+
# Return the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)
|
|
1872
2212
|
# @param id [String] The value of the push token
|
|
1873
2213
|
# @param [Hash] opts the optional parameters
|
|
1874
2214
|
# @return [Hash<String, Object>]
|
|
@@ -1881,7 +2221,7 @@ module KlaviyoAPI
|
|
|
1881
2221
|
alias get_push_token_relationships_profile get_profile_id_for_push_token
|
|
1882
2222
|
|
|
1883
2223
|
# Get Profile ID for Push Token
|
|
1884
|
-
# Return the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2224
|
+
# Return the ID of the profile associated with the given push token.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)
|
|
1885
2225
|
# @param id [String] The value of the push token
|
|
1886
2226
|
# @param [Hash] opts the optional parameters
|
|
1887
2227
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1902,7 +2242,7 @@ module KlaviyoAPI
|
|
|
1902
2242
|
# header parameters
|
|
1903
2243
|
header_params = opts[:header_params] || {}
|
|
1904
2244
|
# klaviyo api revision
|
|
1905
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2245
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1906
2246
|
# HTTP header 'Accept' (if needed)
|
|
1907
2247
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1908
2248
|
|
|
@@ -1939,10 +2279,10 @@ module KlaviyoAPI
|
|
|
1939
2279
|
alias get_push_token_relationships_profile_with_http_info get_profile_id_for_push_token_with_http_info
|
|
1940
2280
|
|
|
1941
2281
|
# Get Profile IDs for Bulk Import Profiles Job
|
|
1942
|
-
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2282
|
+
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)
|
|
1943
2283
|
# @param id [String]
|
|
1944
2284
|
# @param [Hash] opts the optional parameters
|
|
1945
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2285
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1946
2286
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
1947
2287
|
# @return [Hash<String, Object>]
|
|
1948
2288
|
def get_profile_ids_for_bulk_import_profiles_job(id, opts = {})
|
|
@@ -1960,10 +2300,10 @@ module KlaviyoAPI
|
|
|
1960
2300
|
alias get_profile_ids_for_profile_bulk_import_job get_profile_ids_for_bulk_import_profiles_job
|
|
1961
2301
|
|
|
1962
2302
|
# Get Profile IDs for Bulk Import Profiles Job
|
|
1963
|
-
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2303
|
+
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)
|
|
1964
2304
|
# @param id [String]
|
|
1965
2305
|
# @param [Hash] opts the optional parameters
|
|
1966
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2306
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1967
2307
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
1968
2308
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1969
2309
|
def get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
|
@@ -1993,7 +2333,7 @@ module KlaviyoAPI
|
|
|
1993
2333
|
# header parameters
|
|
1994
2334
|
header_params = opts[:header_params] || {}
|
|
1995
2335
|
# klaviyo api revision
|
|
1996
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2336
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1997
2337
|
# HTTP header 'Accept' (if needed)
|
|
1998
2338
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1999
2339
|
|
|
@@ -2036,15 +2376,17 @@ module KlaviyoAPI
|
|
|
2036
2376
|
alias get_profile_ids_for_profile_bulk_import_job_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
|
2037
2377
|
|
|
2038
2378
|
# Get Profiles
|
|
2039
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
2379
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)
|
|
2040
2380
|
# @param [Hash] opts the optional parameters
|
|
2041
2381
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
2042
|
-
# @option opts [Array<String>] :
|
|
2043
|
-
# @option opts [String] :
|
|
2044
|
-
# @option opts [Array<String>] :
|
|
2045
|
-
# @option opts [String] :
|
|
2382
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2383
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2384
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2385
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
2386
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2387
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2046
2388
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2047
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2389
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
2048
2390
|
# @return [Hash<String, Object>]
|
|
2049
2391
|
def get_profiles(opts = {})
|
|
2050
2392
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
|
@@ -2052,15 +2394,17 @@ module KlaviyoAPI
|
|
|
2052
2394
|
end
|
|
2053
2395
|
|
|
2054
2396
|
# Get Profiles
|
|
2055
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
2397
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)
|
|
2056
2398
|
# @param [Hash] opts the optional parameters
|
|
2057
2399
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
2058
|
-
# @option opts [Array<String>] :
|
|
2059
|
-
# @option opts [String] :
|
|
2060
|
-
# @option opts [Array<String>] :
|
|
2061
|
-
# @option opts [String] :
|
|
2400
|
+
# @option opts [Array<String>] :fields_conversation For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2401
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2402
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2403
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
2404
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2405
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2062
2406
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2063
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2407
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
2064
2408
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2065
2409
|
def get_profiles_with_http_info(opts = {})
|
|
2066
2410
|
if @api_client.config.debugging
|
|
@@ -2070,11 +2414,19 @@ module KlaviyoAPI
|
|
|
2070
2414
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2071
2415
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
2072
2416
|
end
|
|
2073
|
-
allowable_values = ["
|
|
2417
|
+
allowable_values = ["channel", "id"]
|
|
2418
|
+
if @api_client.config.client_side_validation && opts[:'fields_conversation'] && !opts[:'fields_conversation'].all? { |item| allowable_values.include?(item) }
|
|
2419
|
+
fail ArgumentError, "invalid value for \"fields_conversation\", must include one of #{allowable_values}"
|
|
2420
|
+
end
|
|
2421
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
2074
2422
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2075
2423
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
2076
2424
|
end
|
|
2077
|
-
allowable_values = ["
|
|
2425
|
+
allowable_values = ["background", "created", "enablement_status", "id", "metadata", "metadata.app_build", "metadata.app_id", "metadata.app_name", "metadata.app_version", "metadata.device_id", "metadata.device_model", "metadata.environment", "metadata.klaviyo_sdk", "metadata.manufacturer", "metadata.os_name", "metadata.os_version", "metadata.sdk_version", "platform", "recorded_date", "token", "vendor"]
|
|
2426
|
+
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
|
2427
|
+
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
|
2428
|
+
end
|
|
2429
|
+
allowable_values = ["conversations", "push-tokens"]
|
|
2078
2430
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
2079
2431
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
2080
2432
|
end
|
|
@@ -2096,7 +2448,9 @@ module KlaviyoAPI
|
|
|
2096
2448
|
# query parameters
|
|
2097
2449
|
query_params = opts[:query_params] || {}
|
|
2098
2450
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
|
2451
|
+
query_params[:'fields[conversation]'] = @api_client.build_collection_param(opts[:'fields_conversation'], :csv) if !opts[:'fields_conversation'].nil?
|
|
2099
2452
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
|
2453
|
+
query_params[:'fields[push-token]'] = @api_client.build_collection_param(opts[:'fields_push_token'], :csv) if !opts[:'fields_push_token'].nil?
|
|
2100
2454
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
2101
2455
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
2102
2456
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
@@ -2106,7 +2460,7 @@ module KlaviyoAPI
|
|
|
2106
2460
|
# header parameters
|
|
2107
2461
|
header_params = opts[:header_params] || {}
|
|
2108
2462
|
# klaviyo api revision
|
|
2109
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2463
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2110
2464
|
# HTTP header 'Accept' (if needed)
|
|
2111
2465
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2112
2466
|
|
|
@@ -2140,12 +2494,12 @@ module KlaviyoAPI
|
|
|
2140
2494
|
end
|
|
2141
2495
|
|
|
2142
2496
|
# Get Profiles for Bulk Import Profiles Job
|
|
2143
|
-
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2497
|
+
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)
|
|
2144
2498
|
# @param id [String]
|
|
2145
2499
|
# @param [Hash] opts the optional parameters
|
|
2146
2500
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
2147
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2148
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2501
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2502
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2149
2503
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2150
2504
|
# @return [Hash<String, Object>]
|
|
2151
2505
|
def get_profiles_for_bulk_import_profiles_job(id, opts = {})
|
|
@@ -2163,12 +2517,12 @@ module KlaviyoAPI
|
|
|
2163
2517
|
alias get_profiles_for_profile_bulk_import_job get_profiles_for_bulk_import_profiles_job
|
|
2164
2518
|
|
|
2165
2519
|
# Get Profiles for Bulk Import Profiles Job
|
|
2166
|
-
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2520
|
+
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)
|
|
2167
2521
|
# @param id [String]
|
|
2168
2522
|
# @param [Hash] opts the optional parameters
|
|
2169
2523
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
2170
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2171
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2524
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2525
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2172
2526
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2173
2527
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2174
2528
|
def get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
|
@@ -2183,7 +2537,7 @@ module KlaviyoAPI
|
|
|
2183
2537
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2184
2538
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
2185
2539
|
end
|
|
2186
|
-
allowable_values = ["
|
|
2540
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
2187
2541
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2188
2542
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
2189
2543
|
end
|
|
@@ -2208,7 +2562,7 @@ module KlaviyoAPI
|
|
|
2208
2562
|
# header parameters
|
|
2209
2563
|
header_params = opts[:header_params] || {}
|
|
2210
2564
|
# klaviyo api revision
|
|
2211
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2565
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2212
2566
|
# HTTP header 'Accept' (if needed)
|
|
2213
2567
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2214
2568
|
|
|
@@ -2251,12 +2605,12 @@ module KlaviyoAPI
|
|
|
2251
2605
|
alias get_profiles_for_profile_bulk_import_job_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
|
|
2252
2606
|
|
|
2253
2607
|
# Get Push Token
|
|
2254
|
-
# Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2608
|
+
# Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)
|
|
2255
2609
|
# @param id [String] The value of the push token
|
|
2256
2610
|
# @param [Hash] opts the optional parameters
|
|
2257
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2258
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2259
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2611
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2612
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2613
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2260
2614
|
# @return [Hash<String, Object>]
|
|
2261
2615
|
def get_push_token(id, opts = {})
|
|
2262
2616
|
data, _status_code, _headers = get_push_token_with_http_info(id, opts)
|
|
@@ -2264,12 +2618,12 @@ module KlaviyoAPI
|
|
|
2264
2618
|
end
|
|
2265
2619
|
|
|
2266
2620
|
# Get Push Token
|
|
2267
|
-
# Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2621
|
+
# Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)
|
|
2268
2622
|
# @param id [String] The value of the push token
|
|
2269
2623
|
# @param [Hash] opts the optional parameters
|
|
2270
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2271
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2272
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2624
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2625
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2626
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2273
2627
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2274
2628
|
def get_push_token_with_http_info(id, opts = {})
|
|
2275
2629
|
if @api_client.config.debugging
|
|
@@ -2279,11 +2633,11 @@ module KlaviyoAPI
|
|
|
2279
2633
|
if @api_client.config.client_side_validation && id.nil?
|
|
2280
2634
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_push_token"
|
|
2281
2635
|
end
|
|
2282
|
-
allowable_values = ["
|
|
2636
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "properties", "title", "updated"]
|
|
2283
2637
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2284
2638
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
2285
2639
|
end
|
|
2286
|
-
allowable_values = ["
|
|
2640
|
+
allowable_values = ["background", "created", "enablement_status", "id", "metadata", "metadata.app_build", "metadata.app_id", "metadata.app_name", "metadata.app_version", "metadata.device_id", "metadata.device_model", "metadata.environment", "metadata.klaviyo_sdk", "metadata.manufacturer", "metadata.os_name", "metadata.os_version", "metadata.sdk_version", "platform", "recorded_date", "token", "vendor"]
|
|
2287
2641
|
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
|
2288
2642
|
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
|
2289
2643
|
end
|
|
@@ -2303,7 +2657,7 @@ module KlaviyoAPI
|
|
|
2303
2657
|
# header parameters
|
|
2304
2658
|
header_params = opts[:header_params] || {}
|
|
2305
2659
|
# klaviyo api revision
|
|
2306
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2660
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2307
2661
|
# HTTP header 'Accept' (if needed)
|
|
2308
2662
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2309
2663
|
|
|
@@ -2337,7 +2691,7 @@ module KlaviyoAPI
|
|
|
2337
2691
|
end
|
|
2338
2692
|
|
|
2339
2693
|
# Get Push Token IDs for Profile
|
|
2340
|
-
# Return the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2694
|
+
# Return the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)
|
|
2341
2695
|
# @param id [String]
|
|
2342
2696
|
# @param [Hash] opts the optional parameters
|
|
2343
2697
|
# @return [Hash<String, Object>]
|
|
@@ -2350,7 +2704,7 @@ module KlaviyoAPI
|
|
|
2350
2704
|
alias get_profile_relationships_push_tokens get_push_token_ids_for_profile
|
|
2351
2705
|
|
|
2352
2706
|
# Get Push Token IDs for Profile
|
|
2353
|
-
# Return the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2707
|
+
# Return the IDs of all push tokens associated with the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)
|
|
2354
2708
|
# @param id [String]
|
|
2355
2709
|
# @param [Hash] opts the optional parameters
|
|
2356
2710
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -2371,7 +2725,7 @@ module KlaviyoAPI
|
|
|
2371
2725
|
# header parameters
|
|
2372
2726
|
header_params = opts[:header_params] || {}
|
|
2373
2727
|
# klaviyo api revision
|
|
2374
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2728
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2375
2729
|
# HTTP header 'Accept' (if needed)
|
|
2376
2730
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2377
2731
|
|
|
@@ -2408,13 +2762,13 @@ module KlaviyoAPI
|
|
|
2408
2762
|
alias get_profile_relationships_push_tokens_with_http_info get_push_token_ids_for_profile_with_http_info
|
|
2409
2763
|
|
|
2410
2764
|
# Get Push Tokens
|
|
2411
|
-
# Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2765
|
+
# Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)
|
|
2412
2766
|
# @param [Hash] opts the optional parameters
|
|
2413
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2414
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2415
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2416
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2417
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2767
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2768
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2769
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals`<br>`profile.id`: `equals`<br>`enablement_status`: `equals`<br>`platform`: `equals`
|
|
2770
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2771
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2418
2772
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2419
2773
|
# @return [Hash<String, Object>]
|
|
2420
2774
|
def get_push_tokens(opts = {})
|
|
@@ -2423,24 +2777,24 @@ module KlaviyoAPI
|
|
|
2423
2777
|
end
|
|
2424
2778
|
|
|
2425
2779
|
# Get Push Tokens
|
|
2426
|
-
# Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
|
2780
|
+
# Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)
|
|
2427
2781
|
# @param [Hash] opts the optional parameters
|
|
2428
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2429
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2430
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2431
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2432
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2782
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2783
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2784
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals`<br>`profile.id`: `equals`<br>`enablement_status`: `equals`<br>`platform`: `equals`
|
|
2785
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
2786
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
2433
2787
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
2434
2788
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2435
2789
|
def get_push_tokens_with_http_info(opts = {})
|
|
2436
2790
|
if @api_client.config.debugging
|
|
2437
2791
|
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_push_tokens ...'
|
|
2438
2792
|
end
|
|
2439
|
-
allowable_values = ["
|
|
2793
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "properties", "title", "updated"]
|
|
2440
2794
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2441
2795
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
2442
2796
|
end
|
|
2443
|
-
allowable_values = ["
|
|
2797
|
+
allowable_values = ["background", "created", "enablement_status", "id", "metadata", "metadata.app_build", "metadata.app_id", "metadata.app_name", "metadata.app_version", "metadata.device_id", "metadata.device_model", "metadata.environment", "metadata.klaviyo_sdk", "metadata.manufacturer", "metadata.os_name", "metadata.os_version", "metadata.sdk_version", "platform", "recorded_date", "token", "vendor"]
|
|
2444
2798
|
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
|
2445
2799
|
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
|
2446
2800
|
end
|
|
@@ -2471,7 +2825,7 @@ module KlaviyoAPI
|
|
|
2471
2825
|
# header parameters
|
|
2472
2826
|
header_params = opts[:header_params] || {}
|
|
2473
2827
|
# klaviyo api revision
|
|
2474
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2828
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2475
2829
|
# HTTP header 'Accept' (if needed)
|
|
2476
2830
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2477
2831
|
|
|
@@ -2505,10 +2859,10 @@ module KlaviyoAPI
|
|
|
2505
2859
|
end
|
|
2506
2860
|
|
|
2507
2861
|
# Get Push Tokens for Profile
|
|
2508
|
-
# Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2862
|
+
# Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)
|
|
2509
2863
|
# @param id [String]
|
|
2510
2864
|
# @param [Hash] opts the optional parameters
|
|
2511
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2865
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2512
2866
|
# @return [Hash<String, Object>]
|
|
2513
2867
|
def get_push_tokens_for_profile(id, opts = {})
|
|
2514
2868
|
data, _status_code, _headers = get_push_tokens_for_profile_with_http_info(id, opts)
|
|
@@ -2519,10 +2873,10 @@ module KlaviyoAPI
|
|
|
2519
2873
|
alias get_profile_push_tokens get_push_tokens_for_profile
|
|
2520
2874
|
|
|
2521
2875
|
# Get Push Tokens for Profile
|
|
2522
|
-
# Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
|
2876
|
+
# Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)
|
|
2523
2877
|
# @param id [String]
|
|
2524
2878
|
# @param [Hash] opts the optional parameters
|
|
2525
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
2879
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2526
2880
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2527
2881
|
def get_push_tokens_for_profile_with_http_info(id, opts = {})
|
|
2528
2882
|
if @api_client.config.debugging
|
|
@@ -2532,7 +2886,7 @@ module KlaviyoAPI
|
|
|
2532
2886
|
if @api_client.config.client_side_validation && id.nil?
|
|
2533
2887
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_push_tokens_for_profile"
|
|
2534
2888
|
end
|
|
2535
|
-
allowable_values = ["
|
|
2889
|
+
allowable_values = ["background", "created", "enablement_status", "id", "metadata", "metadata.app_build", "metadata.app_id", "metadata.app_name", "metadata.app_version", "metadata.device_id", "metadata.device_model", "metadata.environment", "metadata.klaviyo_sdk", "metadata.manufacturer", "metadata.os_name", "metadata.os_version", "metadata.sdk_version", "platform", "recorded_date", "token", "vendor"]
|
|
2536
2890
|
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
|
2537
2891
|
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
|
2538
2892
|
end
|
|
@@ -2546,7 +2900,7 @@ module KlaviyoAPI
|
|
|
2546
2900
|
# header parameters
|
|
2547
2901
|
header_params = opts[:header_params] || {}
|
|
2548
2902
|
# klaviyo api revision
|
|
2549
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2903
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2550
2904
|
# HTTP header 'Accept' (if needed)
|
|
2551
2905
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2552
2906
|
|
|
@@ -2583,7 +2937,7 @@ module KlaviyoAPI
|
|
|
2583
2937
|
alias get_profile_push_tokens_with_http_info get_push_tokens_for_profile_with_http_info
|
|
2584
2938
|
|
|
2585
2939
|
# Get Segment IDs for Profile
|
|
2586
|
-
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
|
2940
|
+
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)
|
|
2587
2941
|
# @param id [String]
|
|
2588
2942
|
# @param [Hash] opts the optional parameters
|
|
2589
2943
|
# @return [Hash<String, Object>]
|
|
@@ -2596,7 +2950,7 @@ module KlaviyoAPI
|
|
|
2596
2950
|
alias get_profile_relationships_segments get_segment_ids_for_profile
|
|
2597
2951
|
|
|
2598
2952
|
# Get Segment IDs for Profile
|
|
2599
|
-
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
|
2953
|
+
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)
|
|
2600
2954
|
# @param id [String]
|
|
2601
2955
|
# @param [Hash] opts the optional parameters
|
|
2602
2956
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -2617,7 +2971,7 @@ module KlaviyoAPI
|
|
|
2617
2971
|
# header parameters
|
|
2618
2972
|
header_params = opts[:header_params] || {}
|
|
2619
2973
|
# klaviyo api revision
|
|
2620
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2974
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2621
2975
|
# HTTP header 'Accept' (if needed)
|
|
2622
2976
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2623
2977
|
|
|
@@ -2654,10 +3008,10 @@ module KlaviyoAPI
|
|
|
2654
3008
|
alias get_profile_relationships_segments_with_http_info get_segment_ids_for_profile_with_http_info
|
|
2655
3009
|
|
|
2656
3010
|
# Get Segments for Profile
|
|
2657
|
-
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
|
3011
|
+
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)
|
|
2658
3012
|
# @param id [String]
|
|
2659
3013
|
# @param [Hash] opts the optional parameters
|
|
2660
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3014
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2661
3015
|
# @return [Hash<String, Object>]
|
|
2662
3016
|
def get_segments_for_profile(id, opts = {})
|
|
2663
3017
|
data, _status_code, _headers = get_segments_for_profile_with_http_info(id, opts)
|
|
@@ -2668,10 +3022,10 @@ module KlaviyoAPI
|
|
|
2668
3022
|
alias get_profile_segments get_segments_for_profile
|
|
2669
3023
|
|
|
2670
3024
|
# Get Segments for Profile
|
|
2671
|
-
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
|
3025
|
+
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)
|
|
2672
3026
|
# @param id [String]
|
|
2673
3027
|
# @param [Hash] opts the optional parameters
|
|
2674
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
3028
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2675
3029
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2676
3030
|
def get_segments_for_profile_with_http_info(id, opts = {})
|
|
2677
3031
|
if @api_client.config.debugging
|
|
@@ -2681,7 +3035,7 @@ module KlaviyoAPI
|
|
|
2681
3035
|
if @api_client.config.client_side_validation && id.nil?
|
|
2682
3036
|
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_segments_for_profile"
|
|
2683
3037
|
end
|
|
2684
|
-
allowable_values = ["
|
|
3038
|
+
allowable_values = ["created", "definition", "definition.condition_groups", "id", "is_active", "is_processing", "is_starred", "name", "updated"]
|
|
2685
3039
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
2686
3040
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
|
2687
3041
|
end
|
|
@@ -2695,7 +3049,7 @@ module KlaviyoAPI
|
|
|
2695
3049
|
# header parameters
|
|
2696
3050
|
header_params = opts[:header_params] || {}
|
|
2697
3051
|
# klaviyo api revision
|
|
2698
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3052
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2699
3053
|
# HTTP header 'Accept' (if needed)
|
|
2700
3054
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2701
3055
|
|
|
@@ -2732,9 +3086,10 @@ module KlaviyoAPI
|
|
|
2732
3086
|
alias get_profile_segments_with_http_info get_segments_for_profile_with_http_info
|
|
2733
3087
|
|
|
2734
3088
|
# Merge Profiles
|
|
2735
|
-
# Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write`
|
|
3089
|
+
# Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)
|
|
2736
3090
|
# @param profile_merge_query [ProfileMergeQuery]
|
|
2737
3091
|
# @param [Hash] opts the optional parameters
|
|
3092
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2738
3093
|
# @return [Hash<String, Object>]
|
|
2739
3094
|
def merge_profiles(profile_merge_query, opts = {})
|
|
2740
3095
|
data, _status_code, _headers = merge_profiles_with_http_info(profile_merge_query, opts)
|
|
@@ -2745,9 +3100,10 @@ module KlaviyoAPI
|
|
|
2745
3100
|
alias create_profile_merge merge_profiles
|
|
2746
3101
|
|
|
2747
3102
|
# Merge Profiles
|
|
2748
|
-
# Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write`
|
|
3103
|
+
# Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)
|
|
2749
3104
|
# @param profile_merge_query [ProfileMergeQuery]
|
|
2750
3105
|
# @param [Hash] opts the optional parameters
|
|
3106
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2751
3107
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2752
3108
|
def merge_profiles_with_http_info(profile_merge_query, opts = {})
|
|
2753
3109
|
if @api_client.config.debugging
|
|
@@ -2757,16 +3113,21 @@ module KlaviyoAPI
|
|
|
2757
3113
|
if @api_client.config.client_side_validation && profile_merge_query.nil?
|
|
2758
3114
|
fail ArgumentError, "Missing the required parameter 'profile_merge_query' when calling ProfilesApi.merge_profiles"
|
|
2759
3115
|
end
|
|
3116
|
+
allowable_values = ["id"]
|
|
3117
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
3118
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
3119
|
+
end
|
|
2760
3120
|
# resource path
|
|
2761
3121
|
local_var_path = '/api/profile-merge'
|
|
2762
3122
|
|
|
2763
3123
|
# query parameters
|
|
2764
3124
|
query_params = opts[:query_params] || {}
|
|
3125
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
|
2765
3126
|
|
|
2766
3127
|
# header parameters
|
|
2767
3128
|
header_params = opts[:header_params] || {}
|
|
2768
3129
|
# klaviyo api revision
|
|
2769
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2770
3131
|
# HTTP header 'Accept' (if needed)
|
|
2771
3132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2772
3133
|
# HTTP header 'Content-Type'
|
|
@@ -2808,11 +3169,12 @@ module KlaviyoAPI
|
|
|
2808
3169
|
alias create_profile_merge_with_http_info merge_profiles_with_http_info
|
|
2809
3170
|
|
|
2810
3171
|
# Update Profile
|
|
2811
|
-
# Update the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
3172
|
+
# Update the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)
|
|
2812
3173
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
|
2813
3174
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
|
2814
3175
|
# @param [Hash] opts the optional parameters
|
|
2815
3176
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
3177
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2816
3178
|
# @return [Hash<String, Object>]
|
|
2817
3179
|
def update_profile(id, profile_partial_update_query, opts = {})
|
|
2818
3180
|
data, _status_code, _headers = update_profile_with_http_info(id, profile_partial_update_query, opts)
|
|
@@ -2820,11 +3182,12 @@ module KlaviyoAPI
|
|
|
2820
3182
|
end
|
|
2821
3183
|
|
|
2822
3184
|
# Update Profile
|
|
2823
|
-
# Update the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `
|
|
3185
|
+
# Update the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged. The maximum allowed payload size is 100KB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)
|
|
2824
3186
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
|
2825
3187
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
|
2826
3188
|
# @param [Hash] opts the optional parameters
|
|
2827
3189
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
3190
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
2828
3191
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
2829
3192
|
def update_profile_with_http_info(id, profile_partial_update_query, opts = {})
|
|
2830
3193
|
if @api_client.config.debugging
|
|
@@ -2842,17 +3205,22 @@ module KlaviyoAPI
|
|
|
2842
3205
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
2843
3206
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
2844
3207
|
end
|
|
3208
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
3209
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
3210
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
3211
|
+
end
|
|
2845
3212
|
# resource path
|
|
2846
3213
|
local_var_path = '/api/profiles/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
2847
3214
|
|
|
2848
3215
|
# query parameters
|
|
2849
3216
|
query_params = opts[:query_params] || {}
|
|
2850
3217
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
|
3218
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
|
2851
3219
|
|
|
2852
3220
|
# header parameters
|
|
2853
3221
|
header_params = opts[:header_params] || {}
|
|
2854
3222
|
# klaviyo api revision
|
|
2855
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
3223
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2856
3224
|
# HTTP header 'Accept' (if needed)
|
|
2857
3225
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2858
3226
|
# HTTP header 'Content-Type'
|