klaviyo-api-sdk 12.0.0 → 13.0.1
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 +43 -0
- data/README.md +615 -335
- data/klaviyo-api-sdk.gemspec +1 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +94 -95
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +919 -848
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +71 -68
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +38 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +101 -102
- data/lib/klaviyo-api-sdk/api/forms_api.rb +104 -40
- data/lib/klaviyo-api-sdk/api/images_api.rb +15 -16
- data/lib/klaviyo-api-sdk/api/lists_api.rb +59 -60
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +566 -41
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +675 -109
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -14
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -22
- data/lib/klaviyo-api-sdk/api/segments_api.rb +53 -54
- data/lib/klaviyo-api-sdk/api/tags_api.rb +60 -61
- data/lib/klaviyo-api-sdk/api/templates_api.rb +38 -39
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +9 -10
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +394 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -16
- data/lib/klaviyo-api-sdk/api_client.rb +1 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +0 -1
- data/lib/klaviyo-api-sdk/models/ab_test_action.rb +6 -3
- data/lib/klaviyo-api-sdk/models/ab_test_action_data.rb +303 -0
- data/lib/klaviyo-api-sdk/models/ab_test_action_data_current_experiment.rb +332 -0
- data/lib/klaviyo-api-sdk/models/{union_positive_numeric_filter_operator.rb → ab_test_action_data_main_action.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/audiences.rb +0 -1
- data/lib/klaviyo-api-sdk/models/audiences_update.rb +0 -1
- data/lib/klaviyo-api-sdk/models/automatic_winner_selection_settings.rb +247 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{base_event_create_query_resource_object.rb → base_event_create_query_bulk_entry_resource_object.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/{base_event_create_query_resource_object_attributes.rb → base_event_create_query_bulk_entry_resource_object_attributes.rb} +19 -20
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/block_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +0 -1
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/branch_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +2 -3
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{send_whats_app_action_data.rb → campaign_message_increment.rb} +21 -35
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_property.rb +271 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_static_count.rb +271 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{email_tracking_options.rb → campaigns_email_tracking_options.rb} +37 -50
- data/lib/klaviyo-api-sdk/models/campaigns_email_tracking_options_custom_tracking_params_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/campaigns_sms_tracking_options.rb +233 -0
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/code_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +2 -3
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +2 -7
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +112 -0
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +0 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +2 -3
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_metric_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_condition_filter.rb +110 -0
- data/lib/klaviyo-api-sdk/models/{scheduled_trigger.rb → custom_metric_create_query.rb} +13 -14
- data/lib/klaviyo-api-sdk/models/custom_metric_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_create_query_resource_object_attributes.rb +238 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_definition.rb +274 -0
- data/lib/klaviyo-api-sdk/models/{send_whatsapp_enum.rb → custom_metric_enum.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/custom_metric_group.rb +248 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{send_whats_app_action.rb → custom_metric_partial_update_query_resource_object.rb} +27 -39
- data/lib/klaviyo-api-sdk/models/custom_metric_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +265 -0
- data/lib/klaviyo-api-sdk/models/{custom_object_enum.rb → custom_object_property_enum.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +0 -1
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +287 -0
- data/lib/klaviyo-api-sdk/models/email_content.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +2 -7
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +0 -2
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{union_condition_group_conditions_inner.rb → flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb} +2 -3
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +0 -3
- data/lib/klaviyo-api-sdk/models/flow_email.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +113 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +12 -3
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +113 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_badge_options.rb +105 -0
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{union_filter.rb → flow_sms_additional_filters.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/{union_condition_group.rb → flow_sms_additional_filters_condition_groups_inner.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +113 -0
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{profile_metric_condition.rb → flows_profile_metric_condition.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/{profile_metric_condition_timeframe_filter.rb → flows_profile_metric_condition_timeframe_filter.rb} +2 -2
- data/lib/klaviyo-api-sdk/models/form_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +0 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +0 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{union_positive_numeric_filter.rb → greater_than_positive_numeric_filter.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +14 -5
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +14 -5
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +0 -1
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/html_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/increment.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{scheduled_enum.rb → increment_one_enum.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/internal_service_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/less_than_positive_numeric_filter.rb +251 -0
- data/lib/klaviyo-api-sdk/models/link.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_regex_operator_contains_filter.rb +282 -0
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_update_action_data.rb +29 -6
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/local_static_send.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -3
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +14 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_badge_badge_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_message_silent_definition_create.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_silent_definition_update.rb +242 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +24 -19
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_update.rb +21 -11
- data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_options_badge.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +0 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +0 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -1
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/other_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_sent_email_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_not_sent_push_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_not_sent_sms_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +1 -6
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition_filter.rb +104 -0
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +7 -18
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options.rb → property.rb} +22 -25
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/published_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +0 -1
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/render_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_condition.rb +326 -0
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_condition_timeframe_filter.rb +108 -0
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/set_count_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/set_property_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/silent_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/since_flow_start_date_filter.rb +272 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_content_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/split_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/split_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/split_links.rb +0 -1
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{utm_param_info.rb → static_count.rb} +13 -14
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +253 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_in_array_filter.rb +253 -0
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +2 -3
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +16 -6
- data/lib/klaviyo-api-sdk/models/template_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -6
- data/lib/klaviyo-api-sdk/models/text_block.rb +0 -1
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +21 -22
- data/lib/klaviyo-api-sdk/models/text_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +2 -3
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +4 -9
- 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 +106 -0
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/utm_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/web_feed_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/web_feed_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/web_feed_create_query_resource_object_attributes.rb +315 -0
- data/lib/klaviyo-api-sdk/models/web_feed_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/web_feed_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/web_feed_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{flow_whats_app.rb → web_feed_partial_update_query_resource_object_attributes.rb} +72 -67
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/version.rb +0 -1
- data/lib/klaviyo-api-sdk.rb +80 -21
- metadata +82 -22
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +0 -395
@@ -3,7 +3,6 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2025-01-15
|
7
6
|
Contact: developers@klaviyo.com
|
8
7
|
Generated by: https://openapi-generator.tech
|
9
8
|
OpenAPI Generator version: 6.2.1
|
@@ -20,7 +19,7 @@ module KlaviyoAPI
|
|
20
19
|
@api_client = api_client
|
21
20
|
end
|
22
21
|
# Bulk Import Profiles
|
23
|
-
# 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. 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`
|
24
23
|
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
25
24
|
# @param [Hash] opts the optional parameters
|
26
25
|
# @return [Hash<String, Object>]
|
@@ -36,7 +35,7 @@ module KlaviyoAPI
|
|
36
35
|
alias create_profile_bulk_import_job bulk_import_profiles
|
37
36
|
|
38
37
|
# Bulk Import Profiles
|
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. 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`
|
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`
|
40
39
|
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
41
40
|
# @param [Hash] opts the optional parameters
|
42
41
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -57,7 +56,7 @@ module KlaviyoAPI
|
|
57
56
|
# header parameters
|
58
57
|
header_params = opts[:header_params] || {}
|
59
58
|
# klaviyo api revision
|
60
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
59
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
61
60
|
# HTTP header 'Accept' (if needed)
|
62
61
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
62
|
# HTTP header 'Content-Type'
|
@@ -139,7 +138,7 @@ module KlaviyoAPI
|
|
139
138
|
# header parameters
|
140
139
|
header_params = opts[:header_params] || {}
|
141
140
|
# klaviyo api revision
|
142
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
141
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
143
142
|
# HTTP header 'Accept' (if needed)
|
144
143
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
145
144
|
# HTTP header 'Content-Type'
|
@@ -221,7 +220,7 @@ module KlaviyoAPI
|
|
221
220
|
# header parameters
|
222
221
|
header_params = opts[:header_params] || {}
|
223
222
|
# klaviyo api revision
|
224
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
223
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
225
224
|
# HTTP header 'Accept' (if needed)
|
226
225
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
227
226
|
# HTTP header 'Content-Type'
|
@@ -303,7 +302,7 @@ module KlaviyoAPI
|
|
303
302
|
# header parameters
|
304
303
|
header_params = opts[:header_params] || {}
|
305
304
|
# klaviyo api revision
|
306
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
305
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
307
306
|
# HTTP header 'Accept' (if needed)
|
308
307
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
309
308
|
# HTTP header 'Content-Type'
|
@@ -385,7 +384,7 @@ module KlaviyoAPI
|
|
385
384
|
# header parameters
|
386
385
|
header_params = opts[:header_params] || {}
|
387
386
|
# klaviyo api revision
|
388
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
387
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
389
388
|
# HTTP header 'Accept' (if needed)
|
390
389
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
391
390
|
# HTTP header 'Content-Type'
|
@@ -430,7 +429,7 @@ module KlaviyoAPI
|
|
430
429
|
alias create_profile_suppression_bulk_delete_job_with_http_info bulk_unsuppress_profiles_with_http_info
|
431
430
|
|
432
431
|
# Create or Update Profile
|
433
|
-
# 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
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: `700/m` **Scopes:** `profiles:write`
|
434
433
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
435
434
|
# @param [Hash] opts the optional parameters
|
436
435
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -444,7 +443,7 @@ module KlaviyoAPI
|
|
444
443
|
alias create_profile_import create_or_update_profile
|
445
444
|
|
446
445
|
# Create or Update Profile
|
447
|
-
# 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
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: `700/m` **Scopes:** `profiles:write`
|
448
447
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
449
448
|
# @param [Hash] opts the optional parameters
|
450
449
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -471,7 +470,7 @@ module KlaviyoAPI
|
|
471
470
|
# header parameters
|
472
471
|
header_params = opts[:header_params] || {}
|
473
472
|
# klaviyo api revision
|
474
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
473
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
475
474
|
# HTTP header 'Accept' (if needed)
|
476
475
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
477
476
|
# HTTP header 'Content-Type'
|
@@ -513,7 +512,7 @@ module KlaviyoAPI
|
|
513
512
|
alias create_profile_import_with_http_info create_or_update_profile_with_http_info
|
514
513
|
|
515
514
|
# Create Profile
|
516
|
-
# Create a new profile. 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: `700/m` **Scopes:** `profiles:write`
|
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: `700/m` **Scopes:** `profiles:write`
|
517
516
|
# @param profile_create_query [ProfileCreateQuery]
|
518
517
|
# @param [Hash] opts the optional parameters
|
519
518
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -524,7 +523,7 @@ module KlaviyoAPI
|
|
524
523
|
end
|
525
524
|
|
526
525
|
# Create Profile
|
527
|
-
# Create a new profile. 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: `700/m` **Scopes:** `profiles:write`
|
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: `700/m` **Scopes:** `profiles:write`
|
528
527
|
# @param profile_create_query [ProfileCreateQuery]
|
529
528
|
# @param [Hash] opts the optional parameters
|
530
529
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -551,7 +550,7 @@ module KlaviyoAPI
|
|
551
550
|
# header parameters
|
552
551
|
header_params = opts[:header_params] || {}
|
553
552
|
# klaviyo api revision
|
554
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
553
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
555
554
|
# HTTP header 'Accept' (if needed)
|
556
555
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
557
556
|
# HTTP header 'Content-Type'
|
@@ -590,7 +589,7 @@ module KlaviyoAPI
|
|
590
589
|
end
|
591
590
|
|
592
591
|
# Create or Update Push Token
|
593
|
-
# 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `push-tokens:write`
|
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: `700/m` **Scopes:** `profiles:write` `push-tokens:write`
|
594
593
|
# @param push_token_create_query [PushTokenCreateQuery]
|
595
594
|
# @param [Hash] opts the optional parameters
|
596
595
|
# @return [nil]
|
@@ -600,7 +599,7 @@ module KlaviyoAPI
|
|
600
599
|
end
|
601
600
|
|
602
601
|
# Create or Update Push Token
|
603
|
-
# 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `push-tokens:write`
|
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: `700/m` **Scopes:** `profiles:write` `push-tokens:write`
|
604
603
|
# @param push_token_create_query [PushTokenCreateQuery]
|
605
604
|
# @param [Hash] opts the optional parameters
|
606
605
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -621,7 +620,7 @@ module KlaviyoAPI
|
|
621
620
|
# header parameters
|
622
621
|
header_params = opts[:header_params] || {}
|
623
622
|
# klaviyo api revision
|
624
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
623
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
625
624
|
# HTTP header 'Accept' (if needed)
|
626
625
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
627
626
|
# HTTP header 'Content-Type'
|
@@ -659,13 +658,78 @@ module KlaviyoAPI
|
|
659
658
|
return data, status_code, headers
|
660
659
|
end
|
661
660
|
|
661
|
+
# 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`
|
663
|
+
# @param id [String] The value of the push token to delete
|
664
|
+
# @param [Hash] opts the optional parameters
|
665
|
+
# @return [nil]
|
666
|
+
def delete_push_token(id, opts = {})
|
667
|
+
delete_push_token_with_http_info(id, opts)
|
668
|
+
nil
|
669
|
+
end
|
670
|
+
|
671
|
+
# 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`
|
673
|
+
# @param id [String] The value of the push token to delete
|
674
|
+
# @param [Hash] opts the optional parameters
|
675
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
676
|
+
def delete_push_token_with_http_info(id, opts = {})
|
677
|
+
if @api_client.config.debugging
|
678
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.delete_push_token ...'
|
679
|
+
end
|
680
|
+
# verify the required parameter 'id' is set
|
681
|
+
if @api_client.config.client_side_validation && id.nil?
|
682
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.delete_push_token"
|
683
|
+
end
|
684
|
+
# resource path
|
685
|
+
local_var_path = '/api/push-tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
686
|
+
|
687
|
+
# query parameters
|
688
|
+
query_params = opts[:query_params] || {}
|
689
|
+
|
690
|
+
# header parameters
|
691
|
+
header_params = opts[:header_params] || {}
|
692
|
+
# klaviyo api revision
|
693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
694
|
+
# HTTP header 'Accept' (if needed)
|
695
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
696
|
+
|
697
|
+
# form parameters
|
698
|
+
form_params = opts[:form_params] || {}
|
699
|
+
|
700
|
+
# http body (model)
|
701
|
+
post_body = opts[:debug_body]
|
702
|
+
|
703
|
+
# return_type
|
704
|
+
return_type = opts[:debug_return_type]
|
705
|
+
|
706
|
+
# auth_names
|
707
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
708
|
+
|
709
|
+
new_options = opts.merge(
|
710
|
+
:operation => :"ProfilesApi.delete_push_token",
|
711
|
+
:header_params => header_params,
|
712
|
+
:query_params => query_params,
|
713
|
+
:form_params => form_params,
|
714
|
+
:body => post_body,
|
715
|
+
:auth_names => auth_names,
|
716
|
+
:return_type => return_type
|
717
|
+
)
|
718
|
+
|
719
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
720
|
+
if @api_client.config.debugging
|
721
|
+
@api_client.config.logger.debug "API called: ProfilesApi#delete_push_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
722
|
+
end
|
723
|
+
return data, status_code, headers
|
724
|
+
end
|
725
|
+
|
662
726
|
# Get Bulk Import Profiles Job
|
663
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`
|
664
728
|
# @param job_id [String] ID of the job to retrieve.
|
665
729
|
# @param [Hash] opts the optional parameters
|
666
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
667
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
668
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
730
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
731
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
732
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
669
733
|
# @return [Hash<String, Object>]
|
670
734
|
def get_bulk_import_profiles_job(job_id, opts = {})
|
671
735
|
data, _status_code, _headers = get_bulk_import_profiles_job_with_http_info(job_id, opts)
|
@@ -682,9 +746,9 @@ module KlaviyoAPI
|
|
682
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`
|
683
747
|
# @param job_id [String] ID of the job to retrieve.
|
684
748
|
# @param [Hash] opts the optional parameters
|
685
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
686
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
687
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
749
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
750
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
751
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
688
752
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
689
753
|
def get_bulk_import_profiles_job_with_http_info(job_id, opts = {})
|
690
754
|
if @api_client.config.debugging
|
@@ -718,7 +782,7 @@ module KlaviyoAPI
|
|
718
782
|
# header parameters
|
719
783
|
header_params = opts[:header_params] || {}
|
720
784
|
# klaviyo api revision
|
721
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
785
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
722
786
|
# HTTP header 'Accept' (if needed)
|
723
787
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
724
788
|
|
@@ -760,11 +824,11 @@ module KlaviyoAPI
|
|
760
824
|
# Get Bulk Import Profiles Jobs
|
761
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`
|
762
826
|
# @param [Hash] opts the optional parameters
|
763
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
764
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
765
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
827
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
828
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
829
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
766
830
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
767
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
831
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
768
832
|
# @return [Hash<String, Object>]
|
769
833
|
def get_bulk_import_profiles_jobs(opts = {})
|
770
834
|
data, _status_code, _headers = get_bulk_import_profiles_jobs_with_http_info(opts)
|
@@ -780,11 +844,11 @@ module KlaviyoAPI
|
|
780
844
|
# Get Bulk Import Profiles Jobs
|
781
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`
|
782
846
|
# @param [Hash] opts the optional parameters
|
783
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
784
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
785
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
847
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
848
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
849
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
786
850
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
787
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
851
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
788
852
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
789
853
|
def get_bulk_import_profiles_jobs_with_http_info(opts = {})
|
790
854
|
if @api_client.config.debugging
|
@@ -820,7 +884,7 @@ module KlaviyoAPI
|
|
820
884
|
# header parameters
|
821
885
|
header_params = opts[:header_params] || {}
|
822
886
|
# klaviyo api revision
|
823
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
887
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
824
888
|
# HTTP header 'Accept' (if needed)
|
825
889
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
826
890
|
|
@@ -863,7 +927,7 @@ module KlaviyoAPI
|
|
863
927
|
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
864
928
|
# @param job_id [String] ID of the job to retrieve.
|
865
929
|
# @param [Hash] opts the optional parameters
|
866
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
930
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
867
931
|
# @return [Hash<String, Object>]
|
868
932
|
def get_bulk_suppress_profiles_job(job_id, opts = {})
|
869
933
|
data, _status_code, _headers = get_bulk_suppress_profiles_job_with_http_info(job_id, opts)
|
@@ -877,7 +941,7 @@ module KlaviyoAPI
|
|
877
941
|
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
878
942
|
# @param job_id [String] ID of the job to retrieve.
|
879
943
|
# @param [Hash] opts the optional parameters
|
880
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
944
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
881
945
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
882
946
|
def get_bulk_suppress_profiles_job_with_http_info(job_id, opts = {})
|
883
947
|
if @api_client.config.debugging
|
@@ -901,7 +965,7 @@ module KlaviyoAPI
|
|
901
965
|
# header parameters
|
902
966
|
header_params = opts[:header_params] || {}
|
903
967
|
# klaviyo api revision
|
904
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
968
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
905
969
|
# HTTP header 'Accept' (if needed)
|
906
970
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
907
971
|
|
@@ -940,10 +1004,10 @@ module KlaviyoAPI
|
|
940
1004
|
# Get Bulk Suppress Profiles Jobs
|
941
1005
|
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
942
1006
|
# @param [Hash] opts the optional parameters
|
943
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
944
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
945
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
946
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1007
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1008
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1009
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1010
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
947
1011
|
# @return [Hash<String, Object>]
|
948
1012
|
def get_bulk_suppress_profiles_jobs(opts = {})
|
949
1013
|
data, _status_code, _headers = get_bulk_suppress_profiles_jobs_with_http_info(opts)
|
@@ -956,10 +1020,10 @@ module KlaviyoAPI
|
|
956
1020
|
# Get Bulk Suppress Profiles Jobs
|
957
1021
|
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
958
1022
|
# @param [Hash] opts the optional parameters
|
959
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
960
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
961
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
962
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1023
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1024
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1025
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1026
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
963
1027
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
964
1028
|
def get_bulk_suppress_profiles_jobs_with_http_info(opts = {})
|
965
1029
|
if @api_client.config.debugging
|
@@ -986,7 +1050,7 @@ module KlaviyoAPI
|
|
986
1050
|
# header parameters
|
987
1051
|
header_params = opts[:header_params] || {}
|
988
1052
|
# klaviyo api revision
|
989
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1053
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
990
1054
|
# HTTP header 'Accept' (if needed)
|
991
1055
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
992
1056
|
|
@@ -1026,7 +1090,7 @@ module KlaviyoAPI
|
|
1026
1090
|
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1027
1091
|
# @param job_id [String] ID of the job to retrieve.
|
1028
1092
|
# @param [Hash] opts the optional parameters
|
1029
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1093
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1030
1094
|
# @return [Hash<String, Object>]
|
1031
1095
|
def get_bulk_unsuppress_profiles_job(job_id, opts = {})
|
1032
1096
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts)
|
@@ -1040,7 +1104,7 @@ module KlaviyoAPI
|
|
1040
1104
|
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1041
1105
|
# @param job_id [String] ID of the job to retrieve.
|
1042
1106
|
# @param [Hash] opts the optional parameters
|
1043
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1107
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1044
1108
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1045
1109
|
def get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts = {})
|
1046
1110
|
if @api_client.config.debugging
|
@@ -1064,7 +1128,7 @@ module KlaviyoAPI
|
|
1064
1128
|
# header parameters
|
1065
1129
|
header_params = opts[:header_params] || {}
|
1066
1130
|
# klaviyo api revision
|
1067
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1131
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1068
1132
|
# HTTP header 'Accept' (if needed)
|
1069
1133
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1070
1134
|
|
@@ -1103,10 +1167,10 @@ module KlaviyoAPI
|
|
1103
1167
|
# Get Bulk Unsuppress Profiles Jobs
|
1104
1168
|
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1105
1169
|
# @param [Hash] opts the optional parameters
|
1106
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1107
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1108
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1109
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1170
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1171
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1172
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1173
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
1110
1174
|
# @return [Hash<String, Object>]
|
1111
1175
|
def get_bulk_unsuppress_profiles_jobs(opts = {})
|
1112
1176
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_jobs_with_http_info(opts)
|
@@ -1119,10 +1183,10 @@ module KlaviyoAPI
|
|
1119
1183
|
# Get Bulk Unsuppress Profiles Jobs
|
1120
1184
|
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1121
1185
|
# @param [Hash] opts the optional parameters
|
1122
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1123
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1124
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1125
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1186
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1187
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1188
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1189
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
1126
1190
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1127
1191
|
def get_bulk_unsuppress_profiles_jobs_with_http_info(opts = {})
|
1128
1192
|
if @api_client.config.debugging
|
@@ -1149,7 +1213,7 @@ module KlaviyoAPI
|
|
1149
1213
|
# header parameters
|
1150
1214
|
header_params = opts[:header_params] || {}
|
1151
1215
|
# klaviyo api revision
|
1152
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1216
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1153
1217
|
# HTTP header 'Accept' (if needed)
|
1154
1218
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1155
1219
|
|
@@ -1189,8 +1253,8 @@ module KlaviyoAPI
|
|
1189
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`
|
1190
1254
|
# @param id [String]
|
1191
1255
|
# @param [Hash] opts the optional parameters
|
1192
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-
|
1193
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1256
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1257
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1194
1258
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1195
1259
|
# @return [Hash<String, Object>]
|
1196
1260
|
def get_errors_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1211,8 +1275,8 @@ module KlaviyoAPI
|
|
1211
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`
|
1212
1276
|
# @param id [String]
|
1213
1277
|
# @param [Hash] opts the optional parameters
|
1214
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-
|
1215
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1278
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1279
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1216
1280
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1217
1281
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1218
1282
|
def get_errors_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1247,7 +1311,7 @@ module KlaviyoAPI
|
|
1247
1311
|
# header parameters
|
1248
1312
|
header_params = opts[:header_params] || {}
|
1249
1313
|
# klaviyo api revision
|
1250
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1314
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1251
1315
|
# HTTP header 'Accept' (if needed)
|
1252
1316
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1253
1317
|
|
@@ -1293,7 +1357,7 @@ module KlaviyoAPI
|
|
1293
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`
|
1294
1358
|
# @param id [String]
|
1295
1359
|
# @param [Hash] opts the optional parameters
|
1296
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1360
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1297
1361
|
# @return [Hash<String, Object>]
|
1298
1362
|
def get_list_for_bulk_import_profiles_job(id, opts = {})
|
1299
1363
|
data, _status_code, _headers = get_list_for_bulk_import_profiles_job_with_http_info(id, opts)
|
@@ -1313,7 +1377,7 @@ module KlaviyoAPI
|
|
1313
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`
|
1314
1378
|
# @param id [String]
|
1315
1379
|
# @param [Hash] opts the optional parameters
|
1316
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1380
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1317
1381
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1318
1382
|
def get_list_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
1319
1383
|
if @api_client.config.debugging
|
@@ -1337,7 +1401,7 @@ module KlaviyoAPI
|
|
1337
1401
|
# header parameters
|
1338
1402
|
header_params = opts[:header_params] || {}
|
1339
1403
|
# klaviyo api revision
|
1340
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1404
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1341
1405
|
# HTTP header 'Accept' (if needed)
|
1342
1406
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1343
1407
|
|
@@ -1420,7 +1484,7 @@ module KlaviyoAPI
|
|
1420
1484
|
# header parameters
|
1421
1485
|
header_params = opts[:header_params] || {}
|
1422
1486
|
# klaviyo api revision
|
1423
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1487
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1424
1488
|
# HTTP header 'Accept' (if needed)
|
1425
1489
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1426
1490
|
|
@@ -1497,7 +1561,7 @@ module KlaviyoAPI
|
|
1497
1561
|
# header parameters
|
1498
1562
|
header_params = opts[:header_params] || {}
|
1499
1563
|
# klaviyo api revision
|
1500
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1564
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1501
1565
|
# HTTP header 'Accept' (if needed)
|
1502
1566
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1503
1567
|
|
@@ -1537,7 +1601,7 @@ module KlaviyoAPI
|
|
1537
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`
|
1538
1602
|
# @param id [String]
|
1539
1603
|
# @param [Hash] opts the optional parameters
|
1540
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1604
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1541
1605
|
# @return [Hash<String, Object>]
|
1542
1606
|
def get_lists_for_profile(id, opts = {})
|
1543
1607
|
data, _status_code, _headers = get_lists_for_profile_with_http_info(id, opts)
|
@@ -1551,7 +1615,7 @@ module KlaviyoAPI
|
|
1551
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`
|
1552
1616
|
# @param id [String]
|
1553
1617
|
# @param [Hash] opts the optional parameters
|
1554
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1618
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1555
1619
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1556
1620
|
def get_lists_for_profile_with_http_info(id, opts = {})
|
1557
1621
|
if @api_client.config.debugging
|
@@ -1575,7 +1639,7 @@ module KlaviyoAPI
|
|
1575
1639
|
# header parameters
|
1576
1640
|
header_params = opts[:header_params] || {}
|
1577
1641
|
# klaviyo api revision
|
1578
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1642
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1579
1643
|
# HTTP header 'Accept' (if needed)
|
1580
1644
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1581
1645
|
|
@@ -1612,14 +1676,15 @@ module KlaviyoAPI
|
|
1612
1676
|
alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
|
1613
1677
|
|
1614
1678
|
# Get Profile
|
1615
|
-
# 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: `700/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/v2025-
|
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: `700/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/v2025-04-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1616
1680
|
# @param id [String]
|
1617
1681
|
# @param [Hash] opts the optional parameters
|
1618
1682
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1619
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1620
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1621
|
-
# @option opts [Array<String>] :
|
1622
|
-
# @option opts [Array<String>] :
|
1683
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1684
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1685
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1686
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1687
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1623
1688
|
# @return [Hash<String, Object>]
|
1624
1689
|
def get_profile(id, opts = {})
|
1625
1690
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -1627,14 +1692,15 @@ module KlaviyoAPI
|
|
1627
1692
|
end
|
1628
1693
|
|
1629
1694
|
# Get Profile
|
1630
|
-
# 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: `700/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/v2025-
|
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: `700/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/v2025-04-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1631
1696
|
# @param id [String]
|
1632
1697
|
# @param [Hash] opts the optional parameters
|
1633
1698
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1634
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1635
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1636
|
-
# @option opts [Array<String>] :
|
1637
|
-
# @option opts [Array<String>] :
|
1699
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1700
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1701
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1702
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1703
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1638
1704
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1639
1705
|
def get_profile_with_http_info(id, opts = {})
|
1640
1706
|
if @api_client.config.debugging
|
@@ -1656,11 +1722,15 @@ module KlaviyoAPI
|
|
1656
1722
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1657
1723
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1658
1724
|
end
|
1725
|
+
allowable_values = ["created", "token", "enablement_status", "platform", "vendor", "background", "recorded_date", "metadata", "metadata.device_id", "metadata.klaviyo_sdk", "metadata.sdk_version", "metadata.device_model", "metadata.os_name", "metadata.os_version", "metadata.manufacturer", "metadata.app_name", "metadata.app_version", "metadata.app_build", "metadata.app_id", "metadata.environment"]
|
1726
|
+
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
1727
|
+
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
1728
|
+
end
|
1659
1729
|
allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
|
1660
1730
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
1661
1731
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
1662
1732
|
end
|
1663
|
-
allowable_values = ["lists", "segments"]
|
1733
|
+
allowable_values = ["lists", "push-tokens", "segments"]
|
1664
1734
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1665
1735
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1666
1736
|
end
|
@@ -1672,13 +1742,14 @@ module KlaviyoAPI
|
|
1672
1742
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
1673
1743
|
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
1674
1744
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
1745
|
+
query_params[:'fields[push-token]'] = @api_client.build_collection_param(opts[:'fields_push_token'], :csv) if !opts[:'fields_push_token'].nil?
|
1675
1746
|
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
|
1676
1747
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1677
1748
|
|
1678
1749
|
# header parameters
|
1679
1750
|
header_params = opts[:header_params] || {}
|
1680
1751
|
# klaviyo api revision
|
1681
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1752
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1682
1753
|
# HTTP header 'Accept' (if needed)
|
1683
1754
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1684
1755
|
|
@@ -1711,11 +1782,167 @@ module KlaviyoAPI
|
|
1711
1782
|
return data, status_code, headers
|
1712
1783
|
end
|
1713
1784
|
|
1785
|
+
# 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`
|
1787
|
+
# @param id [String] The value of the push token
|
1788
|
+
# @param [Hash] opts the optional parameters
|
1789
|
+
# @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/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1791
|
+
# @return [Hash<String, Object>]
|
1792
|
+
def get_profile_for_push_token(id, opts = {})
|
1793
|
+
data, _status_code, _headers = get_profile_for_push_token_with_http_info(id, opts)
|
1794
|
+
data
|
1795
|
+
end
|
1796
|
+
|
1797
|
+
# alias of `get_profile_for_push_token`
|
1798
|
+
alias get_push_token_profile get_profile_for_push_token
|
1799
|
+
|
1800
|
+
# 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`
|
1802
|
+
# @param id [String] The value of the push token
|
1803
|
+
# @param [Hash] opts the optional parameters
|
1804
|
+
# @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/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1806
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1807
|
+
def get_profile_for_push_token_with_http_info(id, opts = {})
|
1808
|
+
if @api_client.config.debugging
|
1809
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_for_push_token ...'
|
1810
|
+
end
|
1811
|
+
# verify the required parameter 'id' is set
|
1812
|
+
if @api_client.config.client_side_validation && id.nil?
|
1813
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_for_push_token"
|
1814
|
+
end
|
1815
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
1816
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
1817
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
1818
|
+
end
|
1819
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "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.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "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", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1820
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1821
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1822
|
+
end
|
1823
|
+
# resource path
|
1824
|
+
local_var_path = '/api/push-tokens/{id}/profile'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1825
|
+
|
1826
|
+
# query parameters
|
1827
|
+
query_params = opts[:query_params] || {}
|
1828
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
1829
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
1830
|
+
|
1831
|
+
# header parameters
|
1832
|
+
header_params = opts[:header_params] || {}
|
1833
|
+
# klaviyo api revision
|
1834
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1835
|
+
# HTTP header 'Accept' (if needed)
|
1836
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1837
|
+
|
1838
|
+
# form parameters
|
1839
|
+
form_params = opts[:form_params] || {}
|
1840
|
+
|
1841
|
+
# http body (model)
|
1842
|
+
post_body = opts[:debug_body]
|
1843
|
+
|
1844
|
+
# return_type
|
1845
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1846
|
+
|
1847
|
+
# auth_names
|
1848
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1849
|
+
|
1850
|
+
new_options = opts.merge(
|
1851
|
+
:operation => :"ProfilesApi.get_profile_for_push_token",
|
1852
|
+
:header_params => header_params,
|
1853
|
+
:query_params => query_params,
|
1854
|
+
:form_params => form_params,
|
1855
|
+
:body => post_body,
|
1856
|
+
:auth_names => auth_names,
|
1857
|
+
:return_type => return_type
|
1858
|
+
)
|
1859
|
+
|
1860
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1861
|
+
if @api_client.config.debugging
|
1862
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profile_for_push_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1863
|
+
end
|
1864
|
+
return data, status_code, headers
|
1865
|
+
end
|
1866
|
+
|
1867
|
+
# alias of `get_profile_for_push_token_with_http_info`
|
1868
|
+
alias get_push_token_profile_with_http_info get_profile_for_push_token_with_http_info
|
1869
|
+
|
1870
|
+
# 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`
|
1872
|
+
# @param id [String] The value of the push token
|
1873
|
+
# @param [Hash] opts the optional parameters
|
1874
|
+
# @return [Hash<String, Object>]
|
1875
|
+
def get_profile_id_for_push_token(id, opts = {})
|
1876
|
+
data, _status_code, _headers = get_profile_id_for_push_token_with_http_info(id, opts)
|
1877
|
+
data
|
1878
|
+
end
|
1879
|
+
|
1880
|
+
# alias of `get_profile_id_for_push_token`
|
1881
|
+
alias get_push_token_relationships_profile get_profile_id_for_push_token
|
1882
|
+
|
1883
|
+
# 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`
|
1885
|
+
# @param id [String] The value of the push token
|
1886
|
+
# @param [Hash] opts the optional parameters
|
1887
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1888
|
+
def get_profile_id_for_push_token_with_http_info(id, opts = {})
|
1889
|
+
if @api_client.config.debugging
|
1890
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_id_for_push_token ...'
|
1891
|
+
end
|
1892
|
+
# verify the required parameter 'id' is set
|
1893
|
+
if @api_client.config.client_side_validation && id.nil?
|
1894
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_id_for_push_token"
|
1895
|
+
end
|
1896
|
+
# resource path
|
1897
|
+
local_var_path = '/api/push-tokens/{id}/relationships/profile'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1898
|
+
|
1899
|
+
# query parameters
|
1900
|
+
query_params = opts[:query_params] || {}
|
1901
|
+
|
1902
|
+
# header parameters
|
1903
|
+
header_params = opts[:header_params] || {}
|
1904
|
+
# klaviyo api revision
|
1905
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1906
|
+
# HTTP header 'Accept' (if needed)
|
1907
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1908
|
+
|
1909
|
+
# form parameters
|
1910
|
+
form_params = opts[:form_params] || {}
|
1911
|
+
|
1912
|
+
# http body (model)
|
1913
|
+
post_body = opts[:debug_body]
|
1914
|
+
|
1915
|
+
# return_type
|
1916
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1917
|
+
|
1918
|
+
# auth_names
|
1919
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1920
|
+
|
1921
|
+
new_options = opts.merge(
|
1922
|
+
:operation => :"ProfilesApi.get_profile_id_for_push_token",
|
1923
|
+
:header_params => header_params,
|
1924
|
+
:query_params => query_params,
|
1925
|
+
:form_params => form_params,
|
1926
|
+
:body => post_body,
|
1927
|
+
:auth_names => auth_names,
|
1928
|
+
:return_type => return_type
|
1929
|
+
)
|
1930
|
+
|
1931
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1932
|
+
if @api_client.config.debugging
|
1933
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profile_id_for_push_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1934
|
+
end
|
1935
|
+
return data, status_code, headers
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# alias of `get_profile_id_for_push_token_with_http_info`
|
1939
|
+
alias get_push_token_relationships_profile_with_http_info get_profile_id_for_push_token_with_http_info
|
1940
|
+
|
1714
1941
|
# Get Profile IDs for Bulk Import Profiles Job
|
1715
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`
|
1716
1943
|
# @param id [String]
|
1717
1944
|
# @param [Hash] opts the optional parameters
|
1718
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1945
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1719
1946
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1720
1947
|
# @return [Hash<String, Object>]
|
1721
1948
|
def get_profile_ids_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1736,7 +1963,7 @@ module KlaviyoAPI
|
|
1736
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`
|
1737
1964
|
# @param id [String]
|
1738
1965
|
# @param [Hash] opts the optional parameters
|
1739
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1966
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1740
1967
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1741
1968
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1742
1969
|
def get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1766,7 +1993,7 @@ module KlaviyoAPI
|
|
1766
1993
|
# header parameters
|
1767
1994
|
header_params = opts[:header_params] || {}
|
1768
1995
|
# klaviyo api revision
|
1769
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1996
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1770
1997
|
# HTTP header 'Accept' (if needed)
|
1771
1998
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1772
1999
|
|
@@ -1809,14 +2036,15 @@ module KlaviyoAPI
|
|
1809
2036
|
alias get_profile_ids_for_profile_bulk_import_job_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
1810
2037
|
|
1811
2038
|
# Get Profiles
|
1812
|
-
# 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: `700/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/v2025-
|
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: `700/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/v2025-04-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1813
2040
|
# @param [Hash] opts the optional parameters
|
1814
2041
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1815
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1816
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1817
|
-
# @option opts [String] :
|
2042
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2043
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-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`
|
2044
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2045
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1818
2046
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1819
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
2047
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
1820
2048
|
# @return [Hash<String, Object>]
|
1821
2049
|
def get_profiles(opts = {})
|
1822
2050
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -1824,14 +2052,15 @@ module KlaviyoAPI
|
|
1824
2052
|
end
|
1825
2053
|
|
1826
2054
|
# Get Profiles
|
1827
|
-
# 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: `700/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/v2025-
|
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: `700/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/v2025-04-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1828
2056
|
# @param [Hash] opts the optional parameters
|
1829
2057
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1830
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1831
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1832
|
-
# @option opts [String] :
|
2058
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2059
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-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`
|
2060
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2061
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1833
2062
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1834
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
2063
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
1835
2064
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1836
2065
|
def get_profiles_with_http_info(opts = {})
|
1837
2066
|
if @api_client.config.debugging
|
@@ -1845,6 +2074,10 @@ module KlaviyoAPI
|
|
1845
2074
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1846
2075
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1847
2076
|
end
|
2077
|
+
allowable_values = ["lists", "push-tokens", "segments"]
|
2078
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
2079
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
2080
|
+
end
|
1848
2081
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
1849
2082
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles, must be smaller than or equal to 100.'
|
1850
2083
|
end
|
@@ -1865,6 +2098,7 @@ module KlaviyoAPI
|
|
1865
2098
|
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
1866
2099
|
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
1867
2100
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2101
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1868
2102
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1869
2103
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1870
2104
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
@@ -1872,7 +2106,7 @@ module KlaviyoAPI
|
|
1872
2106
|
# header parameters
|
1873
2107
|
header_params = opts[:header_params] || {}
|
1874
2108
|
# klaviyo api revision
|
1875
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2109
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1876
2110
|
# HTTP header 'Accept' (if needed)
|
1877
2111
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1878
2112
|
|
@@ -1910,8 +2144,8 @@ module KlaviyoAPI
|
|
1910
2144
|
# @param id [String]
|
1911
2145
|
# @param [Hash] opts the optional parameters
|
1912
2146
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1913
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1914
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2147
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2148
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1915
2149
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1916
2150
|
# @return [Hash<String, Object>]
|
1917
2151
|
def get_profiles_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1933,8 +2167,8 @@ module KlaviyoAPI
|
|
1933
2167
|
# @param id [String]
|
1934
2168
|
# @param [Hash] opts the optional parameters
|
1935
2169
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1936
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1937
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2170
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2171
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1938
2172
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1939
2173
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1940
2174
|
def get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1974,7 +2208,7 @@ module KlaviyoAPI
|
|
1974
2208
|
# header parameters
|
1975
2209
|
header_params = opts[:header_params] || {}
|
1976
2210
|
# klaviyo api revision
|
1977
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2211
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1978
2212
|
# HTTP header 'Accept' (if needed)
|
1979
2213
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1980
2214
|
|
@@ -2016,6 +2250,338 @@ module KlaviyoAPI
|
|
2016
2250
|
# alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
|
2017
2251
|
alias get_profiles_for_profile_bulk_import_job_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
|
2018
2252
|
|
2253
|
+
# 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`
|
2255
|
+
# @param id [String] The value of the push token
|
2256
|
+
# @param [Hash] opts the optional parameters
|
2257
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2258
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2259
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2260
|
+
# @return [Hash<String, Object>]
|
2261
|
+
def get_push_token(id, opts = {})
|
2262
|
+
data, _status_code, _headers = get_push_token_with_http_info(id, opts)
|
2263
|
+
data
|
2264
|
+
end
|
2265
|
+
|
2266
|
+
# 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`
|
2268
|
+
# @param id [String] The value of the push token
|
2269
|
+
# @param [Hash] opts the optional parameters
|
2270
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2271
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2272
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2273
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2274
|
+
def get_push_token_with_http_info(id, opts = {})
|
2275
|
+
if @api_client.config.debugging
|
2276
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_push_token ...'
|
2277
|
+
end
|
2278
|
+
# verify the required parameter 'id' is set
|
2279
|
+
if @api_client.config.client_side_validation && id.nil?
|
2280
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_push_token"
|
2281
|
+
end
|
2282
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties"]
|
2283
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
2284
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
2285
|
+
end
|
2286
|
+
allowable_values = ["created", "token", "enablement_status", "platform", "vendor", "background", "recorded_date", "metadata", "metadata.device_id", "metadata.klaviyo_sdk", "metadata.sdk_version", "metadata.device_model", "metadata.os_name", "metadata.os_version", "metadata.manufacturer", "metadata.app_name", "metadata.app_version", "metadata.app_build", "metadata.app_id", "metadata.environment"]
|
2287
|
+
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
2288
|
+
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
2289
|
+
end
|
2290
|
+
allowable_values = ["profile"]
|
2291
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
2292
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
2293
|
+
end
|
2294
|
+
# resource path
|
2295
|
+
local_var_path = '/api/push-tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
2296
|
+
|
2297
|
+
# query parameters
|
2298
|
+
query_params = opts[:query_params] || {}
|
2299
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
2300
|
+
query_params[:'fields[push-token]'] = @api_client.build_collection_param(opts[:'fields_push_token'], :csv) if !opts[:'fields_push_token'].nil?
|
2301
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2302
|
+
|
2303
|
+
# header parameters
|
2304
|
+
header_params = opts[:header_params] || {}
|
2305
|
+
# klaviyo api revision
|
2306
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2307
|
+
# HTTP header 'Accept' (if needed)
|
2308
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2309
|
+
|
2310
|
+
# form parameters
|
2311
|
+
form_params = opts[:form_params] || {}
|
2312
|
+
|
2313
|
+
# http body (model)
|
2314
|
+
post_body = opts[:debug_body]
|
2315
|
+
|
2316
|
+
# return_type
|
2317
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2318
|
+
|
2319
|
+
# auth_names
|
2320
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2321
|
+
|
2322
|
+
new_options = opts.merge(
|
2323
|
+
:operation => :"ProfilesApi.get_push_token",
|
2324
|
+
:header_params => header_params,
|
2325
|
+
:query_params => query_params,
|
2326
|
+
:form_params => form_params,
|
2327
|
+
:body => post_body,
|
2328
|
+
:auth_names => auth_names,
|
2329
|
+
:return_type => return_type
|
2330
|
+
)
|
2331
|
+
|
2332
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2333
|
+
if @api_client.config.debugging
|
2334
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_push_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2335
|
+
end
|
2336
|
+
return data, status_code, headers
|
2337
|
+
end
|
2338
|
+
|
2339
|
+
# 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`
|
2341
|
+
# @param id [String]
|
2342
|
+
# @param [Hash] opts the optional parameters
|
2343
|
+
# @return [Hash<String, Object>]
|
2344
|
+
def get_push_token_ids_for_profile(id, opts = {})
|
2345
|
+
data, _status_code, _headers = get_push_token_ids_for_profile_with_http_info(id, opts)
|
2346
|
+
data
|
2347
|
+
end
|
2348
|
+
|
2349
|
+
# alias of `get_push_token_ids_for_profile`
|
2350
|
+
alias get_profile_relationships_push_tokens get_push_token_ids_for_profile
|
2351
|
+
|
2352
|
+
# 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`
|
2354
|
+
# @param id [String]
|
2355
|
+
# @param [Hash] opts the optional parameters
|
2356
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2357
|
+
def get_push_token_ids_for_profile_with_http_info(id, opts = {})
|
2358
|
+
if @api_client.config.debugging
|
2359
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_push_token_ids_for_profile ...'
|
2360
|
+
end
|
2361
|
+
# verify the required parameter 'id' is set
|
2362
|
+
if @api_client.config.client_side_validation && id.nil?
|
2363
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_push_token_ids_for_profile"
|
2364
|
+
end
|
2365
|
+
# resource path
|
2366
|
+
local_var_path = '/api/profiles/{id}/relationships/push-tokens'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
2367
|
+
|
2368
|
+
# query parameters
|
2369
|
+
query_params = opts[:query_params] || {}
|
2370
|
+
|
2371
|
+
# header parameters
|
2372
|
+
header_params = opts[:header_params] || {}
|
2373
|
+
# klaviyo api revision
|
2374
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2375
|
+
# HTTP header 'Accept' (if needed)
|
2376
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2377
|
+
|
2378
|
+
# form parameters
|
2379
|
+
form_params = opts[:form_params] || {}
|
2380
|
+
|
2381
|
+
# http body (model)
|
2382
|
+
post_body = opts[:debug_body]
|
2383
|
+
|
2384
|
+
# return_type
|
2385
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2386
|
+
|
2387
|
+
# auth_names
|
2388
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2389
|
+
|
2390
|
+
new_options = opts.merge(
|
2391
|
+
:operation => :"ProfilesApi.get_push_token_ids_for_profile",
|
2392
|
+
:header_params => header_params,
|
2393
|
+
:query_params => query_params,
|
2394
|
+
:form_params => form_params,
|
2395
|
+
:body => post_body,
|
2396
|
+
:auth_names => auth_names,
|
2397
|
+
:return_type => return_type
|
2398
|
+
)
|
2399
|
+
|
2400
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2401
|
+
if @api_client.config.debugging
|
2402
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_push_token_ids_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2403
|
+
end
|
2404
|
+
return data, status_code, headers
|
2405
|
+
end
|
2406
|
+
|
2407
|
+
# alias of `get_push_token_ids_for_profile_with_http_info`
|
2408
|
+
alias get_profile_relationships_push_tokens_with_http_info get_push_token_ids_for_profile_with_http_info
|
2409
|
+
|
2410
|
+
# 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`
|
2412
|
+
# @param [Hash] opts the optional parameters
|
2413
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2414
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2415
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-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`
|
2416
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2417
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2418
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2419
|
+
# @return [Hash<String, Object>]
|
2420
|
+
def get_push_tokens(opts = {})
|
2421
|
+
data, _status_code, _headers = get_push_tokens_with_http_info(opts)
|
2422
|
+
data
|
2423
|
+
end
|
2424
|
+
|
2425
|
+
# 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`
|
2427
|
+
# @param [Hash] opts the optional parameters
|
2428
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2429
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2430
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-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`
|
2431
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2432
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2433
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2434
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2435
|
+
def get_push_tokens_with_http_info(opts = {})
|
2436
|
+
if @api_client.config.debugging
|
2437
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_push_tokens ...'
|
2438
|
+
end
|
2439
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties"]
|
2440
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
2441
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
2442
|
+
end
|
2443
|
+
allowable_values = ["created", "token", "enablement_status", "platform", "vendor", "background", "recorded_date", "metadata", "metadata.device_id", "metadata.klaviyo_sdk", "metadata.sdk_version", "metadata.device_model", "metadata.os_name", "metadata.os_version", "metadata.manufacturer", "metadata.app_name", "metadata.app_version", "metadata.app_build", "metadata.app_id", "metadata.environment"]
|
2444
|
+
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
2445
|
+
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
2446
|
+
end
|
2447
|
+
allowable_values = ["profile"]
|
2448
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
2449
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
2450
|
+
end
|
2451
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
2452
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_push_tokens, must be smaller than or equal to 100.'
|
2453
|
+
end
|
2454
|
+
|
2455
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
2456
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_push_tokens, must be greater than or equal to 1.'
|
2457
|
+
end
|
2458
|
+
|
2459
|
+
# resource path
|
2460
|
+
local_var_path = '/api/push-tokens'
|
2461
|
+
|
2462
|
+
# query parameters
|
2463
|
+
query_params = opts[:query_params] || {}
|
2464
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
2465
|
+
query_params[:'fields[push-token]'] = @api_client.build_collection_param(opts[:'fields_push_token'], :csv) if !opts[:'fields_push_token'].nil?
|
2466
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2467
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2468
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2469
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
2470
|
+
|
2471
|
+
# header parameters
|
2472
|
+
header_params = opts[:header_params] || {}
|
2473
|
+
# klaviyo api revision
|
2474
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2475
|
+
# HTTP header 'Accept' (if needed)
|
2476
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2477
|
+
|
2478
|
+
# form parameters
|
2479
|
+
form_params = opts[:form_params] || {}
|
2480
|
+
|
2481
|
+
# http body (model)
|
2482
|
+
post_body = opts[:debug_body]
|
2483
|
+
|
2484
|
+
# return_type
|
2485
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2486
|
+
|
2487
|
+
# auth_names
|
2488
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2489
|
+
|
2490
|
+
new_options = opts.merge(
|
2491
|
+
:operation => :"ProfilesApi.get_push_tokens",
|
2492
|
+
:header_params => header_params,
|
2493
|
+
:query_params => query_params,
|
2494
|
+
:form_params => form_params,
|
2495
|
+
:body => post_body,
|
2496
|
+
:auth_names => auth_names,
|
2497
|
+
:return_type => return_type
|
2498
|
+
)
|
2499
|
+
|
2500
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2501
|
+
if @api_client.config.debugging
|
2502
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_push_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2503
|
+
end
|
2504
|
+
return data, status_code, headers
|
2505
|
+
end
|
2506
|
+
|
2507
|
+
# 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`
|
2509
|
+
# @param id [String]
|
2510
|
+
# @param [Hash] opts the optional parameters
|
2511
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2512
|
+
# @return [Hash<String, Object>]
|
2513
|
+
def get_push_tokens_for_profile(id, opts = {})
|
2514
|
+
data, _status_code, _headers = get_push_tokens_for_profile_with_http_info(id, opts)
|
2515
|
+
data
|
2516
|
+
end
|
2517
|
+
|
2518
|
+
# alias of `get_push_tokens_for_profile`
|
2519
|
+
alias get_profile_push_tokens get_push_tokens_for_profile
|
2520
|
+
|
2521
|
+
# 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`
|
2523
|
+
# @param id [String]
|
2524
|
+
# @param [Hash] opts the optional parameters
|
2525
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2526
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2527
|
+
def get_push_tokens_for_profile_with_http_info(id, opts = {})
|
2528
|
+
if @api_client.config.debugging
|
2529
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_push_tokens_for_profile ...'
|
2530
|
+
end
|
2531
|
+
# verify the required parameter 'id' is set
|
2532
|
+
if @api_client.config.client_side_validation && id.nil?
|
2533
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_push_tokens_for_profile"
|
2534
|
+
end
|
2535
|
+
allowable_values = ["created", "token", "enablement_status", "platform", "vendor", "background", "recorded_date", "metadata", "metadata.device_id", "metadata.klaviyo_sdk", "metadata.sdk_version", "metadata.device_model", "metadata.os_name", "metadata.os_version", "metadata.manufacturer", "metadata.app_name", "metadata.app_version", "metadata.app_build", "metadata.app_id", "metadata.environment"]
|
2536
|
+
if @api_client.config.client_side_validation && opts[:'fields_push_token'] && !opts[:'fields_push_token'].all? { |item| allowable_values.include?(item) }
|
2537
|
+
fail ArgumentError, "invalid value for \"fields_push_token\", must include one of #{allowable_values}"
|
2538
|
+
end
|
2539
|
+
# resource path
|
2540
|
+
local_var_path = '/api/profiles/{id}/push-tokens'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
2541
|
+
|
2542
|
+
# query parameters
|
2543
|
+
query_params = opts[:query_params] || {}
|
2544
|
+
query_params[:'fields[push-token]'] = @api_client.build_collection_param(opts[:'fields_push_token'], :csv) if !opts[:'fields_push_token'].nil?
|
2545
|
+
|
2546
|
+
# header parameters
|
2547
|
+
header_params = opts[:header_params] || {}
|
2548
|
+
# klaviyo api revision
|
2549
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2550
|
+
# HTTP header 'Accept' (if needed)
|
2551
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2552
|
+
|
2553
|
+
# form parameters
|
2554
|
+
form_params = opts[:form_params] || {}
|
2555
|
+
|
2556
|
+
# http body (model)
|
2557
|
+
post_body = opts[:debug_body]
|
2558
|
+
|
2559
|
+
# return_type
|
2560
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2561
|
+
|
2562
|
+
# auth_names
|
2563
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2564
|
+
|
2565
|
+
new_options = opts.merge(
|
2566
|
+
:operation => :"ProfilesApi.get_push_tokens_for_profile",
|
2567
|
+
:header_params => header_params,
|
2568
|
+
:query_params => query_params,
|
2569
|
+
:form_params => form_params,
|
2570
|
+
:body => post_body,
|
2571
|
+
:auth_names => auth_names,
|
2572
|
+
:return_type => return_type
|
2573
|
+
)
|
2574
|
+
|
2575
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2576
|
+
if @api_client.config.debugging
|
2577
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_push_tokens_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2578
|
+
end
|
2579
|
+
return data, status_code, headers
|
2580
|
+
end
|
2581
|
+
|
2582
|
+
# alias of `get_push_tokens_for_profile_with_http_info`
|
2583
|
+
alias get_profile_push_tokens_with_http_info get_push_tokens_for_profile_with_http_info
|
2584
|
+
|
2019
2585
|
# Get Segment IDs for Profile
|
2020
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`
|
2021
2587
|
# @param id [String]
|
@@ -2051,7 +2617,7 @@ module KlaviyoAPI
|
|
2051
2617
|
# header parameters
|
2052
2618
|
header_params = opts[:header_params] || {}
|
2053
2619
|
# klaviyo api revision
|
2054
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2620
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2055
2621
|
# HTTP header 'Accept' (if needed)
|
2056
2622
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2057
2623
|
|
@@ -2091,7 +2657,7 @@ module KlaviyoAPI
|
|
2091
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`
|
2092
2658
|
# @param id [String]
|
2093
2659
|
# @param [Hash] opts the optional parameters
|
2094
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-
|
2660
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2095
2661
|
# @return [Hash<String, Object>]
|
2096
2662
|
def get_segments_for_profile(id, opts = {})
|
2097
2663
|
data, _status_code, _headers = get_segments_for_profile_with_http_info(id, opts)
|
@@ -2105,7 +2671,7 @@ module KlaviyoAPI
|
|
2105
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`
|
2106
2672
|
# @param id [String]
|
2107
2673
|
# @param [Hash] opts the optional parameters
|
2108
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-
|
2674
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2109
2675
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2110
2676
|
def get_segments_for_profile_with_http_info(id, opts = {})
|
2111
2677
|
if @api_client.config.debugging
|
@@ -2129,7 +2695,7 @@ module KlaviyoAPI
|
|
2129
2695
|
# header parameters
|
2130
2696
|
header_params = opts[:header_params] || {}
|
2131
2697
|
# klaviyo api revision
|
2132
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2698
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2133
2699
|
# HTTP header 'Accept' (if needed)
|
2134
2700
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2135
2701
|
|
@@ -2200,7 +2766,7 @@ module KlaviyoAPI
|
|
2200
2766
|
# header parameters
|
2201
2767
|
header_params = opts[:header_params] || {}
|
2202
2768
|
# klaviyo api revision
|
2203
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2769
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2204
2770
|
# HTTP header 'Accept' (if needed)
|
2205
2771
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2206
2772
|
# HTTP header 'Content-Type'
|
@@ -2242,7 +2808,7 @@ module KlaviyoAPI
|
|
2242
2808
|
alias create_profile_merge_with_http_info merge_profiles_with_http_info
|
2243
2809
|
|
2244
2810
|
# Update Profile
|
2245
|
-
# 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
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: `700/m` **Scopes:** `profiles:write`
|
2246
2812
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
2247
2813
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
2248
2814
|
# @param [Hash] opts the optional parameters
|
@@ -2254,7 +2820,7 @@ module KlaviyoAPI
|
|
2254
2820
|
end
|
2255
2821
|
|
2256
2822
|
# Update Profile
|
2257
|
-
# 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
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: `700/m` **Scopes:** `profiles:write`
|
2258
2824
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
2259
2825
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
2260
2826
|
# @param [Hash] opts the optional parameters
|
@@ -2286,7 +2852,7 @@ module KlaviyoAPI
|
|
2286
2852
|
# header parameters
|
2287
2853
|
header_params = opts[:header_params] || {}
|
2288
2854
|
# klaviyo api revision
|
2289
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2855
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2290
2856
|
# HTTP header 'Accept' (if needed)
|
2291
2857
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2292
2858
|
# HTTP header 'Content-Type'
|