klaviyo-api-sdk 11.0.0 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -0
- data/README.md +677 -357
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +422 -159
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +405 -307
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +170 -149
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +147 -135
- data/lib/klaviyo-api-sdk/api/flows_api.rb +431 -311
- data/lib/klaviyo-api-sdk/api/forms_api.rb +76 -44
- data/lib/klaviyo-api-sdk/api/images_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/lists_api.rb +416 -362
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -148
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +242 -212
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +63 -21
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +101 -25
- data/lib/klaviyo-api-sdk/api/segments_api.rb +226 -202
- data/lib/klaviyo-api-sdk/api/tags_api.rb +167 -101
- data/lib/klaviyo-api-sdk/api/templates_api.rb +45 -45
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +19 -10
- data/lib/klaviyo-api-sdk/models/ab_test_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{audiences_sub_object.rb → audiences.rb} +9 -5
- data/lib/klaviyo-api-sdk/models/audiences_update.rb +236 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +230 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/branch_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +3 -3
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +11 -42
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_content.rb → campaign_message_create_query_resource_object_attributes_definition.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +9 -29
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +107 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +35 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_item_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/code_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +224 -0
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +1 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +312 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/custom_object_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_content_sub_object.rb → email_content.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +244 -0
- data/lib/klaviyo-api-sdk/models/email_send_options.rb +223 -0
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object.rb → email_tracking_options.rb} +50 -38
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{sto_schedule_options.rb → flow_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +269 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +122 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +111 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +364 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +394 -0
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +386 -0
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +259 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +294 -0
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +224 -0
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_strategy_sub_object.rb → internal_service_action.rb} +46 -33
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/link.rb +220 -0
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → list_update_action_data.rb} +34 -43
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{static_schedule_options.rb → local_static_send.rb} +46 -22
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +328 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +266 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +118 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +247 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options_sub_object.rb → mobile_push_message_standard_definition_update.rb} +40 -23
- data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +243 -0
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object_custom_tracking_params_inner.rb → mobile_push_options_badge.rb} +5 -4
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +105 -0
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +259 -0
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/other_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +349 -0
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +273 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +328 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +8 -3
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +20 -6
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/published_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +224 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +246 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_send_options_sub_object.rb → push_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +235 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +224 -0
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{render_options_sub_object.rb → render_options.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/review_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +109 -0
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +238 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +110 -0
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +224 -0
- data/lib/klaviyo-api-sdk/models/scheduled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/scheduled_trigger.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{sms_content_sub_object_create.rb → sms_content_create.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options_sub_object.rb → sms_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +228 -0
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/split_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/split_links.rb +226 -0
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{throttled_schedule_options.rb → static_send_strategy.rb} +26 -17
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +276 -0
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +288 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +325 -0
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +310 -0
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group_conditions_inner.rb +114 -0
- data/lib/klaviyo-api-sdk/models/union_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +228 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +259 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +273 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +109 -0
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/utm_param.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → utm_param_info.rb} +17 -33
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +2 -2
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +192 -18
- metadata +193 -19
@@ -3,7 +3,7 @@
|
|
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:
|
6
|
+
The version of the OpenAPI document: 2025-01-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,6 +19,88 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# 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`
|
24
|
+
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [Hash<String, Object>]
|
27
|
+
def bulk_import_profiles(profile_import_job_create_query, opts = {})
|
28
|
+
data, _status_code, _headers = bulk_import_profiles_with_http_info(profile_import_job_create_query, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# alias of `bulk_import_profiles`
|
33
|
+
alias spawn_bulk_profile_import_job bulk_import_profiles
|
34
|
+
|
35
|
+
# alias of `bulk_import_profiles`
|
36
|
+
alias create_profile_bulk_import_job bulk_import_profiles
|
37
|
+
|
38
|
+
# 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`
|
40
|
+
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
43
|
+
def bulk_import_profiles_with_http_info(profile_import_job_create_query, opts = {})
|
44
|
+
if @api_client.config.debugging
|
45
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_import_profiles ...'
|
46
|
+
end
|
47
|
+
# verify the required parameter 'profile_import_job_create_query' is set
|
48
|
+
if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.bulk_import_profiles"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/profile-bulk-import-jobs'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# klaviyo api revision
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
61
|
+
# HTTP header 'Accept' (if needed)
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
|
+
# HTTP header 'Content-Type'
|
64
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
65
|
+
if !content_type.nil?
|
66
|
+
header_params['Content-Type'] = content_type
|
67
|
+
end
|
68
|
+
|
69
|
+
# form parameters
|
70
|
+
form_params = opts[:form_params] || {}
|
71
|
+
|
72
|
+
# http body (model)
|
73
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_import_job_create_query)
|
74
|
+
|
75
|
+
# return_type
|
76
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
77
|
+
|
78
|
+
# auth_names
|
79
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
80
|
+
|
81
|
+
new_options = opts.merge(
|
82
|
+
:operation => :"ProfilesApi.bulk_import_profiles",
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => return_type
|
89
|
+
)
|
90
|
+
|
91
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug "API called: ProfilesApi#bulk_import_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
94
|
+
end
|
95
|
+
return data, status_code, headers
|
96
|
+
end
|
97
|
+
|
98
|
+
# alias of `bulk_import_profiles_with_http_info`
|
99
|
+
alias spawn_bulk_profile_import_job_with_http_info bulk_import_profiles_with_http_info
|
100
|
+
|
101
|
+
# alias of `bulk_import_profiles_with_http_info`
|
102
|
+
alias create_profile_bulk_import_job_with_http_info bulk_import_profiles_with_http_info
|
103
|
+
|
22
104
|
# Bulk Subscribe Profiles
|
23
105
|
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
24
106
|
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
@@ -57,7 +139,7 @@ module KlaviyoAPI
|
|
57
139
|
# header parameters
|
58
140
|
header_params = opts[:header_params] || {}
|
59
141
|
# klaviyo api revision
|
60
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
142
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
61
143
|
# HTTP header 'Accept' (if needed)
|
62
144
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
145
|
# HTTP header 'Content-Type'
|
@@ -76,7 +158,7 @@ module KlaviyoAPI
|
|
76
158
|
return_type = opts[:debug_return_type]
|
77
159
|
|
78
160
|
# auth_names
|
79
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
161
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
80
162
|
|
81
163
|
new_options = opts.merge(
|
82
164
|
:operation => :"ProfilesApi.bulk_subscribe_profiles",
|
@@ -139,7 +221,7 @@ module KlaviyoAPI
|
|
139
221
|
# header parameters
|
140
222
|
header_params = opts[:header_params] || {}
|
141
223
|
# klaviyo api revision
|
142
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
224
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
143
225
|
# HTTP header 'Accept' (if needed)
|
144
226
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
145
227
|
# HTTP header 'Content-Type'
|
@@ -158,7 +240,7 @@ module KlaviyoAPI
|
|
158
240
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
159
241
|
|
160
242
|
# auth_names
|
161
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
243
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
162
244
|
|
163
245
|
new_options = opts.merge(
|
164
246
|
:operation => :"ProfilesApi.bulk_suppress_profiles",
|
@@ -221,7 +303,7 @@ module KlaviyoAPI
|
|
221
303
|
# header parameters
|
222
304
|
header_params = opts[:header_params] || {}
|
223
305
|
# klaviyo api revision
|
224
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
306
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
225
307
|
# HTTP header 'Accept' (if needed)
|
226
308
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
227
309
|
# HTTP header 'Content-Type'
|
@@ -240,7 +322,7 @@ module KlaviyoAPI
|
|
240
322
|
return_type = opts[:debug_return_type]
|
241
323
|
|
242
324
|
# auth_names
|
243
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
325
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
244
326
|
|
245
327
|
new_options = opts.merge(
|
246
328
|
:operation => :"ProfilesApi.bulk_unsubscribe_profiles",
|
@@ -303,7 +385,7 @@ module KlaviyoAPI
|
|
303
385
|
# header parameters
|
304
386
|
header_params = opts[:header_params] || {}
|
305
387
|
# klaviyo api revision
|
306
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
388
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
307
389
|
# HTTP header 'Accept' (if needed)
|
308
390
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
309
391
|
# HTTP header 'Content-Type'
|
@@ -322,7 +404,7 @@ module KlaviyoAPI
|
|
322
404
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
323
405
|
|
324
406
|
# auth_names
|
325
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
407
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
326
408
|
|
327
409
|
new_options = opts.merge(
|
328
410
|
:operation => :"ProfilesApi.bulk_unsuppress_profiles",
|
@@ -348,7 +430,7 @@ module KlaviyoAPI
|
|
348
430
|
alias create_profile_suppression_bulk_delete_job_with_http_info bulk_unsuppress_profiles_with_http_info
|
349
431
|
|
350
432
|
# Create or Update Profile
|
351
|
-
# 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. 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`
|
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`
|
352
434
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
353
435
|
# @param [Hash] opts the optional parameters
|
354
436
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -362,7 +444,7 @@ module KlaviyoAPI
|
|
362
444
|
alias create_profile_import create_or_update_profile
|
363
445
|
|
364
446
|
# Create or Update Profile
|
365
|
-
# 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. 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`
|
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`
|
366
448
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
367
449
|
# @param [Hash] opts the optional parameters
|
368
450
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -389,7 +471,7 @@ module KlaviyoAPI
|
|
389
471
|
# header parameters
|
390
472
|
header_params = opts[:header_params] || {}
|
391
473
|
# klaviyo api revision
|
392
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
474
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
393
475
|
# HTTP header 'Accept' (if needed)
|
394
476
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
395
477
|
# HTTP header 'Content-Type'
|
@@ -408,7 +490,7 @@ module KlaviyoAPI
|
|
408
490
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
409
491
|
|
410
492
|
# auth_names
|
411
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
493
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
412
494
|
|
413
495
|
new_options = opts.merge(
|
414
496
|
:operation => :"ProfilesApi.create_or_update_profile",
|
@@ -431,7 +513,7 @@ module KlaviyoAPI
|
|
431
513
|
alias create_profile_import_with_http_info create_or_update_profile_with_http_info
|
432
514
|
|
433
515
|
# Create Profile
|
434
|
-
# Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
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`
|
435
517
|
# @param profile_create_query [ProfileCreateQuery]
|
436
518
|
# @param [Hash] opts the optional parameters
|
437
519
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -442,7 +524,7 @@ module KlaviyoAPI
|
|
442
524
|
end
|
443
525
|
|
444
526
|
# Create Profile
|
445
|
-
# Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
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`
|
446
528
|
# @param profile_create_query [ProfileCreateQuery]
|
447
529
|
# @param [Hash] opts the optional parameters
|
448
530
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
@@ -469,7 +551,7 @@ module KlaviyoAPI
|
|
469
551
|
# header parameters
|
470
552
|
header_params = opts[:header_params] || {}
|
471
553
|
# klaviyo api revision
|
472
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
554
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
473
555
|
# HTTP header 'Accept' (if needed)
|
474
556
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
475
557
|
# HTTP header 'Content-Type'
|
@@ -488,7 +570,7 @@ module KlaviyoAPI
|
|
488
570
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
489
571
|
|
490
572
|
# auth_names
|
491
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
573
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
492
574
|
|
493
575
|
new_options = opts.merge(
|
494
576
|
:operation => :"ProfilesApi.create_profile",
|
@@ -539,7 +621,7 @@ module KlaviyoAPI
|
|
539
621
|
# header parameters
|
540
622
|
header_params = opts[:header_params] || {}
|
541
623
|
# klaviyo api revision
|
542
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
624
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
543
625
|
# HTTP header 'Accept' (if needed)
|
544
626
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
545
627
|
# HTTP header 'Content-Type'
|
@@ -558,7 +640,7 @@ module KlaviyoAPI
|
|
558
640
|
return_type = opts[:debug_return_type]
|
559
641
|
|
560
642
|
# auth_names
|
561
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
643
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
562
644
|
|
563
645
|
new_options = opts.merge(
|
564
646
|
:operation => :"ProfilesApi.create_push_token",
|
@@ -581,9 +663,9 @@ module KlaviyoAPI
|
|
581
663
|
# 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`
|
582
664
|
# @param job_id [String] ID of the job to retrieve.
|
583
665
|
# @param [Hash] opts the optional parameters
|
584
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
585
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
586
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
666
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
667
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
668
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
587
669
|
# @return [Hash<String, Object>]
|
588
670
|
def get_bulk_import_profiles_job(job_id, opts = {})
|
589
671
|
data, _status_code, _headers = get_bulk_import_profiles_job_with_http_info(job_id, opts)
|
@@ -600,9 +682,9 @@ module KlaviyoAPI
|
|
600
682
|
# 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`
|
601
683
|
# @param job_id [String] ID of the job to retrieve.
|
602
684
|
# @param [Hash] opts the optional parameters
|
603
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
604
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
605
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
685
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
686
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
687
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
606
688
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
607
689
|
def get_bulk_import_profiles_job_with_http_info(job_id, opts = {})
|
608
690
|
if @api_client.config.debugging
|
@@ -636,7 +718,7 @@ module KlaviyoAPI
|
|
636
718
|
# header parameters
|
637
719
|
header_params = opts[:header_params] || {}
|
638
720
|
# klaviyo api revision
|
639
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
721
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
640
722
|
# HTTP header 'Accept' (if needed)
|
641
723
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
642
724
|
|
@@ -650,7 +732,7 @@ module KlaviyoAPI
|
|
650
732
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
651
733
|
|
652
734
|
# auth_names
|
653
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
735
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
654
736
|
|
655
737
|
new_options = opts.merge(
|
656
738
|
:operation => :"ProfilesApi.get_bulk_import_profiles_job",
|
@@ -678,11 +760,11 @@ module KlaviyoAPI
|
|
678
760
|
# Get Bulk Import Profiles Jobs
|
679
761
|
# 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`
|
680
762
|
# @param [Hash] opts the optional parameters
|
681
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
682
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
683
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
763
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
764
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
765
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
684
766
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
685
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
767
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
686
768
|
# @return [Hash<String, Object>]
|
687
769
|
def get_bulk_import_profiles_jobs(opts = {})
|
688
770
|
data, _status_code, _headers = get_bulk_import_profiles_jobs_with_http_info(opts)
|
@@ -698,11 +780,11 @@ module KlaviyoAPI
|
|
698
780
|
# Get Bulk Import Profiles Jobs
|
699
781
|
# 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`
|
700
782
|
# @param [Hash] opts the optional parameters
|
701
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/
|
702
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
703
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
783
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
784
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
785
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
704
786
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
705
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
787
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
706
788
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
707
789
|
def get_bulk_import_profiles_jobs_with_http_info(opts = {})
|
708
790
|
if @api_client.config.debugging
|
@@ -738,7 +820,7 @@ module KlaviyoAPI
|
|
738
820
|
# header parameters
|
739
821
|
header_params = opts[:header_params] || {}
|
740
822
|
# klaviyo api revision
|
741
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
823
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
742
824
|
# HTTP header 'Accept' (if needed)
|
743
825
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
744
826
|
|
@@ -752,7 +834,7 @@ module KlaviyoAPI
|
|
752
834
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
753
835
|
|
754
836
|
# auth_names
|
755
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
837
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
756
838
|
|
757
839
|
new_options = opts.merge(
|
758
840
|
:operation => :"ProfilesApi.get_bulk_import_profiles_jobs",
|
@@ -781,7 +863,7 @@ module KlaviyoAPI
|
|
781
863
|
# 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`
|
782
864
|
# @param job_id [String] ID of the job to retrieve.
|
783
865
|
# @param [Hash] opts the optional parameters
|
784
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
866
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
785
867
|
# @return [Hash<String, Object>]
|
786
868
|
def get_bulk_suppress_profiles_job(job_id, opts = {})
|
787
869
|
data, _status_code, _headers = get_bulk_suppress_profiles_job_with_http_info(job_id, opts)
|
@@ -795,7 +877,7 @@ module KlaviyoAPI
|
|
795
877
|
# 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`
|
796
878
|
# @param job_id [String] ID of the job to retrieve.
|
797
879
|
# @param [Hash] opts the optional parameters
|
798
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
880
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
799
881
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
800
882
|
def get_bulk_suppress_profiles_job_with_http_info(job_id, opts = {})
|
801
883
|
if @api_client.config.debugging
|
@@ -819,7 +901,7 @@ module KlaviyoAPI
|
|
819
901
|
# header parameters
|
820
902
|
header_params = opts[:header_params] || {}
|
821
903
|
# klaviyo api revision
|
822
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
904
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
823
905
|
# HTTP header 'Accept' (if needed)
|
824
906
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
825
907
|
|
@@ -833,7 +915,7 @@ module KlaviyoAPI
|
|
833
915
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
834
916
|
|
835
917
|
# auth_names
|
836
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
918
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
837
919
|
|
838
920
|
new_options = opts.merge(
|
839
921
|
:operation => :"ProfilesApi.get_bulk_suppress_profiles_job",
|
@@ -858,10 +940,10 @@ module KlaviyoAPI
|
|
858
940
|
# Get Bulk Suppress Profiles Jobs
|
859
941
|
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
860
942
|
# @param [Hash] opts the optional parameters
|
861
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
862
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
863
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
864
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
943
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
944
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
945
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
946
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
865
947
|
# @return [Hash<String, Object>]
|
866
948
|
def get_bulk_suppress_profiles_jobs(opts = {})
|
867
949
|
data, _status_code, _headers = get_bulk_suppress_profiles_jobs_with_http_info(opts)
|
@@ -874,10 +956,10 @@ module KlaviyoAPI
|
|
874
956
|
# Get Bulk Suppress Profiles Jobs
|
875
957
|
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
876
958
|
# @param [Hash] opts the optional parameters
|
877
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/
|
878
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
879
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
880
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
959
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
960
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
961
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
962
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
881
963
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
882
964
|
def get_bulk_suppress_profiles_jobs_with_http_info(opts = {})
|
883
965
|
if @api_client.config.debugging
|
@@ -904,7 +986,7 @@ module KlaviyoAPI
|
|
904
986
|
# header parameters
|
905
987
|
header_params = opts[:header_params] || {}
|
906
988
|
# klaviyo api revision
|
907
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
989
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
908
990
|
# HTTP header 'Accept' (if needed)
|
909
991
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
910
992
|
|
@@ -918,7 +1000,7 @@ module KlaviyoAPI
|
|
918
1000
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
919
1001
|
|
920
1002
|
# auth_names
|
921
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1003
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
922
1004
|
|
923
1005
|
new_options = opts.merge(
|
924
1006
|
:operation => :"ProfilesApi.get_bulk_suppress_profiles_jobs",
|
@@ -944,7 +1026,7 @@ module KlaviyoAPI
|
|
944
1026
|
# 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`
|
945
1027
|
# @param job_id [String] ID of the job to retrieve.
|
946
1028
|
# @param [Hash] opts the optional parameters
|
947
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1029
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
948
1030
|
# @return [Hash<String, Object>]
|
949
1031
|
def get_bulk_unsuppress_profiles_job(job_id, opts = {})
|
950
1032
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts)
|
@@ -958,7 +1040,7 @@ module KlaviyoAPI
|
|
958
1040
|
# 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`
|
959
1041
|
# @param job_id [String] ID of the job to retrieve.
|
960
1042
|
# @param [Hash] opts the optional parameters
|
961
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1043
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
962
1044
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
963
1045
|
def get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts = {})
|
964
1046
|
if @api_client.config.debugging
|
@@ -982,7 +1064,7 @@ module KlaviyoAPI
|
|
982
1064
|
# header parameters
|
983
1065
|
header_params = opts[:header_params] || {}
|
984
1066
|
# klaviyo api revision
|
985
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1067
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
986
1068
|
# HTTP header 'Accept' (if needed)
|
987
1069
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
988
1070
|
|
@@ -996,7 +1078,7 @@ module KlaviyoAPI
|
|
996
1078
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
997
1079
|
|
998
1080
|
# auth_names
|
999
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1081
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1000
1082
|
|
1001
1083
|
new_options = opts.merge(
|
1002
1084
|
:operation => :"ProfilesApi.get_bulk_unsuppress_profiles_job",
|
@@ -1021,10 +1103,10 @@ module KlaviyoAPI
|
|
1021
1103
|
# Get Bulk Unsuppress Profiles Jobs
|
1022
1104
|
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1023
1105
|
# @param [Hash] opts the optional parameters
|
1024
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1025
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1026
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1027
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1106
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1107
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1108
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1109
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1028
1110
|
# @return [Hash<String, Object>]
|
1029
1111
|
def get_bulk_unsuppress_profiles_jobs(opts = {})
|
1030
1112
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_jobs_with_http_info(opts)
|
@@ -1037,10 +1119,10 @@ module KlaviyoAPI
|
|
1037
1119
|
# Get Bulk Unsuppress Profiles Jobs
|
1038
1120
|
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1039
1121
|
# @param [Hash] opts the optional parameters
|
1040
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/
|
1041
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1042
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1043
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1122
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1123
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1124
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1125
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1044
1126
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1045
1127
|
def get_bulk_unsuppress_profiles_jobs_with_http_info(opts = {})
|
1046
1128
|
if @api_client.config.debugging
|
@@ -1067,7 +1149,7 @@ module KlaviyoAPI
|
|
1067
1149
|
# header parameters
|
1068
1150
|
header_params = opts[:header_params] || {}
|
1069
1151
|
# klaviyo api revision
|
1070
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1152
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1071
1153
|
# HTTP header 'Accept' (if needed)
|
1072
1154
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1073
1155
|
|
@@ -1081,7 +1163,7 @@ module KlaviyoAPI
|
|
1081
1163
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1082
1164
|
|
1083
1165
|
# auth_names
|
1084
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1166
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1085
1167
|
|
1086
1168
|
new_options = opts.merge(
|
1087
1169
|
:operation => :"ProfilesApi.get_bulk_unsuppress_profiles_jobs",
|
@@ -1107,8 +1189,8 @@ module KlaviyoAPI
|
|
1107
1189
|
# 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`
|
1108
1190
|
# @param id [String]
|
1109
1191
|
# @param [Hash] opts the optional parameters
|
1110
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/
|
1111
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1192
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1193
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1112
1194
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1113
1195
|
# @return [Hash<String, Object>]
|
1114
1196
|
def get_errors_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1119,6 +1201,9 @@ module KlaviyoAPI
|
|
1119
1201
|
# alias of `get_errors_for_bulk_import_profiles_job`
|
1120
1202
|
alias get_bulk_profile_import_job_import_errors get_errors_for_bulk_import_profiles_job
|
1121
1203
|
|
1204
|
+
# alias of `get_errors_for_bulk_import_profiles_job`
|
1205
|
+
alias get_import_errors_for_profile_bulk_import_job get_errors_for_bulk_import_profiles_job
|
1206
|
+
|
1122
1207
|
# alias of `get_errors_for_bulk_import_profiles_job`
|
1123
1208
|
alias get_profile_bulk_import_job_import_errors get_errors_for_bulk_import_profiles_job
|
1124
1209
|
|
@@ -1126,8 +1211,8 @@ module KlaviyoAPI
|
|
1126
1211
|
# 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`
|
1127
1212
|
# @param id [String]
|
1128
1213
|
# @param [Hash] opts the optional parameters
|
1129
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/
|
1130
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1214
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1215
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1131
1216
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1132
1217
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1133
1218
|
def get_errors_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1162,7 +1247,7 @@ module KlaviyoAPI
|
|
1162
1247
|
# header parameters
|
1163
1248
|
header_params = opts[:header_params] || {}
|
1164
1249
|
# klaviyo api revision
|
1165
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1250
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1166
1251
|
# HTTP header 'Accept' (if needed)
|
1167
1252
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1168
1253
|
|
@@ -1176,7 +1261,7 @@ module KlaviyoAPI
|
|
1176
1261
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1177
1262
|
|
1178
1263
|
# auth_names
|
1179
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1264
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1180
1265
|
|
1181
1266
|
new_options = opts.merge(
|
1182
1267
|
:operation => :"ProfilesApi.get_errors_for_bulk_import_profiles_job",
|
@@ -1198,6 +1283,9 @@ module KlaviyoAPI
|
|
1198
1283
|
# alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
|
1199
1284
|
alias get_bulk_profile_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
|
1200
1285
|
|
1286
|
+
# alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
|
1287
|
+
alias get_import_errors_for_profile_bulk_import_job_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
|
1288
|
+
|
1201
1289
|
# alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
|
1202
1290
|
alias get_profile_bulk_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
|
1203
1291
|
|
@@ -1205,7 +1293,7 @@ module KlaviyoAPI
|
|
1205
1293
|
# 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`
|
1206
1294
|
# @param id [String]
|
1207
1295
|
# @param [Hash] opts the optional parameters
|
1208
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
1296
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1209
1297
|
# @return [Hash<String, Object>]
|
1210
1298
|
def get_list_for_bulk_import_profiles_job(id, opts = {})
|
1211
1299
|
data, _status_code, _headers = get_list_for_bulk_import_profiles_job_with_http_info(id, opts)
|
@@ -1215,6 +1303,9 @@ module KlaviyoAPI
|
|
1215
1303
|
# alias of `get_list_for_bulk_import_profiles_job`
|
1216
1304
|
alias get_bulk_profile_import_job_lists get_list_for_bulk_import_profiles_job
|
1217
1305
|
|
1306
|
+
# alias of `get_list_for_bulk_import_profiles_job`
|
1307
|
+
alias get_lists_for_profile_bulk_import_job get_list_for_bulk_import_profiles_job
|
1308
|
+
|
1218
1309
|
# alias of `get_list_for_bulk_import_profiles_job`
|
1219
1310
|
alias get_profile_bulk_import_job_lists get_list_for_bulk_import_profiles_job
|
1220
1311
|
|
@@ -1222,7 +1313,7 @@ module KlaviyoAPI
|
|
1222
1313
|
# 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`
|
1223
1314
|
# @param id [String]
|
1224
1315
|
# @param [Hash] opts the optional parameters
|
1225
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
1316
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1226
1317
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1227
1318
|
def get_list_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
1228
1319
|
if @api_client.config.debugging
|
@@ -1246,7 +1337,7 @@ module KlaviyoAPI
|
|
1246
1337
|
# header parameters
|
1247
1338
|
header_params = opts[:header_params] || {}
|
1248
1339
|
# klaviyo api revision
|
1249
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1340
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1250
1341
|
# HTTP header 'Accept' (if needed)
|
1251
1342
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1252
1343
|
|
@@ -1260,7 +1351,7 @@ module KlaviyoAPI
|
|
1260
1351
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1261
1352
|
|
1262
1353
|
# auth_names
|
1263
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1354
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1264
1355
|
|
1265
1356
|
new_options = opts.merge(
|
1266
1357
|
:operation => :"ProfilesApi.get_list_for_bulk_import_profiles_job",
|
@@ -1282,6 +1373,9 @@ module KlaviyoAPI
|
|
1282
1373
|
# alias of `get_list_for_bulk_import_profiles_job_with_http_info`
|
1283
1374
|
alias get_bulk_profile_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
|
1284
1375
|
|
1376
|
+
# alias of `get_list_for_bulk_import_profiles_job_with_http_info`
|
1377
|
+
alias get_lists_for_profile_bulk_import_job_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
|
1378
|
+
|
1285
1379
|
# alias of `get_list_for_bulk_import_profiles_job_with_http_info`
|
1286
1380
|
alias get_profile_bulk_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
|
1287
1381
|
|
@@ -1298,6 +1392,9 @@ module KlaviyoAPI
|
|
1298
1392
|
# alias of `get_list_ids_for_bulk_import_profiles_job`
|
1299
1393
|
alias get_bulk_profile_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
|
1300
1394
|
|
1395
|
+
# alias of `get_list_ids_for_bulk_import_profiles_job`
|
1396
|
+
alias get_list_ids_for_profile_bulk_import_job get_list_ids_for_bulk_import_profiles_job
|
1397
|
+
|
1301
1398
|
# alias of `get_list_ids_for_bulk_import_profiles_job`
|
1302
1399
|
alias get_profile_bulk_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
|
1303
1400
|
|
@@ -1323,7 +1420,7 @@ module KlaviyoAPI
|
|
1323
1420
|
# header parameters
|
1324
1421
|
header_params = opts[:header_params] || {}
|
1325
1422
|
# klaviyo api revision
|
1326
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1423
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1327
1424
|
# HTTP header 'Accept' (if needed)
|
1328
1425
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1329
1426
|
|
@@ -1337,7 +1434,7 @@ module KlaviyoAPI
|
|
1337
1434
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1338
1435
|
|
1339
1436
|
# auth_names
|
1340
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1437
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1341
1438
|
|
1342
1439
|
new_options = opts.merge(
|
1343
1440
|
:operation => :"ProfilesApi.get_list_ids_for_bulk_import_profiles_job",
|
@@ -1359,6 +1456,9 @@ module KlaviyoAPI
|
|
1359
1456
|
# alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
|
1360
1457
|
alias get_bulk_profile_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
|
1361
1458
|
|
1459
|
+
# alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
|
1460
|
+
alias get_list_ids_for_profile_bulk_import_job_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
|
1461
|
+
|
1362
1462
|
# alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
|
1363
1463
|
alias get_profile_bulk_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
|
1364
1464
|
|
@@ -1397,7 +1497,7 @@ module KlaviyoAPI
|
|
1397
1497
|
# header parameters
|
1398
1498
|
header_params = opts[:header_params] || {}
|
1399
1499
|
# klaviyo api revision
|
1400
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1500
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1401
1501
|
# HTTP header 'Accept' (if needed)
|
1402
1502
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1403
1503
|
|
@@ -1411,7 +1511,7 @@ module KlaviyoAPI
|
|
1411
1511
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1412
1512
|
|
1413
1513
|
# auth_names
|
1414
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1514
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1415
1515
|
|
1416
1516
|
new_options = opts.merge(
|
1417
1517
|
:operation => :"ProfilesApi.get_list_ids_for_profile",
|
@@ -1437,7 +1537,7 @@ module KlaviyoAPI
|
|
1437
1537
|
# 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`
|
1438
1538
|
# @param id [String]
|
1439
1539
|
# @param [Hash] opts the optional parameters
|
1440
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
1540
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1441
1541
|
# @return [Hash<String, Object>]
|
1442
1542
|
def get_lists_for_profile(id, opts = {})
|
1443
1543
|
data, _status_code, _headers = get_lists_for_profile_with_http_info(id, opts)
|
@@ -1451,7 +1551,7 @@ module KlaviyoAPI
|
|
1451
1551
|
# 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`
|
1452
1552
|
# @param id [String]
|
1453
1553
|
# @param [Hash] opts the optional parameters
|
1454
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
1554
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1455
1555
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1456
1556
|
def get_lists_for_profile_with_http_info(id, opts = {})
|
1457
1557
|
if @api_client.config.debugging
|
@@ -1475,7 +1575,7 @@ module KlaviyoAPI
|
|
1475
1575
|
# header parameters
|
1476
1576
|
header_params = opts[:header_params] || {}
|
1477
1577
|
# klaviyo api revision
|
1478
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1578
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1479
1579
|
# HTTP header 'Accept' (if needed)
|
1480
1580
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1481
1581
|
|
@@ -1489,7 +1589,7 @@ module KlaviyoAPI
|
|
1489
1589
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1490
1590
|
|
1491
1591
|
# auth_names
|
1492
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1592
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1493
1593
|
|
1494
1594
|
new_options = opts.merge(
|
1495
1595
|
:operation => :"ProfilesApi.get_lists_for_profile",
|
@@ -1512,14 +1612,14 @@ module KlaviyoAPI
|
|
1512
1612
|
alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
|
1513
1613
|
|
1514
1614
|
# Get Profile
|
1515
|
-
# Get the profile with the given profile ID.<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/
|
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-01-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1516
1616
|
# @param id [String]
|
1517
1617
|
# @param [Hash] opts the optional parameters
|
1518
1618
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1519
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
1520
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1521
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
1522
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
1619
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1620
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1621
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1622
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1523
1623
|
# @return [Hash<String, Object>]
|
1524
1624
|
def get_profile(id, opts = {})
|
1525
1625
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -1527,14 +1627,14 @@ module KlaviyoAPI
|
|
1527
1627
|
end
|
1528
1628
|
|
1529
1629
|
# Get Profile
|
1530
|
-
# Get the profile with the given profile ID.<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/
|
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-01-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1531
1631
|
# @param id [String]
|
1532
1632
|
# @param [Hash] opts the optional parameters
|
1533
1633
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1534
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/
|
1535
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1536
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
1537
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
1634
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1635
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1636
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1637
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1538
1638
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1539
1639
|
def get_profile_with_http_info(id, opts = {})
|
1540
1640
|
if @api_client.config.debugging
|
@@ -1578,7 +1678,7 @@ module KlaviyoAPI
|
|
1578
1678
|
# header parameters
|
1579
1679
|
header_params = opts[:header_params] || {}
|
1580
1680
|
# klaviyo api revision
|
1581
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1681
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1582
1682
|
# HTTP header 'Accept' (if needed)
|
1583
1683
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1584
1684
|
|
@@ -1592,7 +1692,7 @@ module KlaviyoAPI
|
|
1592
1692
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1593
1693
|
|
1594
1694
|
# auth_names
|
1595
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1695
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1596
1696
|
|
1597
1697
|
new_options = opts.merge(
|
1598
1698
|
:operation => :"ProfilesApi.get_profile",
|
@@ -1615,7 +1715,7 @@ module KlaviyoAPI
|
|
1615
1715
|
# 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`
|
1616
1716
|
# @param id [String]
|
1617
1717
|
# @param [Hash] opts the optional parameters
|
1618
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1718
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1619
1719
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1620
1720
|
# @return [Hash<String, Object>]
|
1621
1721
|
def get_profile_ids_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1629,11 +1729,14 @@ module KlaviyoAPI
|
|
1629
1729
|
# alias of `get_profile_ids_for_bulk_import_profiles_job`
|
1630
1730
|
alias get_profile_bulk_import_job_relationships_profiles get_profile_ids_for_bulk_import_profiles_job
|
1631
1731
|
|
1732
|
+
# alias of `get_profile_ids_for_bulk_import_profiles_job`
|
1733
|
+
alias get_profile_ids_for_profile_bulk_import_job get_profile_ids_for_bulk_import_profiles_job
|
1734
|
+
|
1632
1735
|
# Get Profile IDs for Bulk Import Profiles Job
|
1633
1736
|
# 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`
|
1634
1737
|
# @param id [String]
|
1635
1738
|
# @param [Hash] opts the optional parameters
|
1636
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1739
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1637
1740
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1638
1741
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1639
1742
|
def get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1663,7 +1766,7 @@ module KlaviyoAPI
|
|
1663
1766
|
# header parameters
|
1664
1767
|
header_params = opts[:header_params] || {}
|
1665
1768
|
# klaviyo api revision
|
1666
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1769
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1667
1770
|
# HTTP header 'Accept' (if needed)
|
1668
1771
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1669
1772
|
|
@@ -1677,7 +1780,7 @@ module KlaviyoAPI
|
|
1677
1780
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1678
1781
|
|
1679
1782
|
# auth_names
|
1680
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1783
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1681
1784
|
|
1682
1785
|
new_options = opts.merge(
|
1683
1786
|
:operation => :"ProfilesApi.get_profile_ids_for_bulk_import_profiles_job",
|
@@ -1702,15 +1805,18 @@ module KlaviyoAPI
|
|
1702
1805
|
# alias of `get_profile_ids_for_bulk_import_profiles_job_with_http_info`
|
1703
1806
|
alias get_profile_bulk_import_job_relationships_profiles_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
1704
1807
|
|
1808
|
+
# alias of `get_profile_ids_for_bulk_import_profiles_job_with_http_info`
|
1809
|
+
alias get_profile_ids_for_profile_bulk_import_job_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
1810
|
+
|
1705
1811
|
# Get Profiles
|
1706
|
-
# 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
|
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-01-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1707
1813
|
# @param [Hash] opts the optional parameters
|
1708
1814
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1709
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1710
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1711
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1815
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1816
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-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`
|
1817
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1712
1818
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1713
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1819
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1714
1820
|
# @return [Hash<String, Object>]
|
1715
1821
|
def get_profiles(opts = {})
|
1716
1822
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -1718,14 +1824,14 @@ module KlaviyoAPI
|
|
1718
1824
|
end
|
1719
1825
|
|
1720
1826
|
# Get Profiles
|
1721
|
-
# 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`
|
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-01-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1722
1828
|
# @param [Hash] opts the optional parameters
|
1723
1829
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1724
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1725
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1726
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1830
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1831
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-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`
|
1832
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1727
1833
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1728
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1834
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1729
1835
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1730
1836
|
def get_profiles_with_http_info(opts = {})
|
1731
1837
|
if @api_client.config.debugging
|
@@ -1747,7 +1853,7 @@ module KlaviyoAPI
|
|
1747
1853
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles, must be greater than or equal to 1.'
|
1748
1854
|
end
|
1749
1855
|
|
1750
|
-
allowable_values = ["created", "-created", "email", "-email", "id", "-id", "
|
1856
|
+
allowable_values = ["created", "-created", "email", "-email", "id", "-id", "subscriptions.email.marketing.list_suppressions.timestamp", "-subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.email.marketing.suppression.timestamp", "-subscriptions.email.marketing.suppression.timestamp", "updated", "-updated"]
|
1751
1857
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1752
1858
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1753
1859
|
end
|
@@ -1766,7 +1872,7 @@ module KlaviyoAPI
|
|
1766
1872
|
# header parameters
|
1767
1873
|
header_params = opts[:header_params] || {}
|
1768
1874
|
# klaviyo api revision
|
1769
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1875
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1770
1876
|
# HTTP header 'Accept' (if needed)
|
1771
1877
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1772
1878
|
|
@@ -1780,7 +1886,7 @@ module KlaviyoAPI
|
|
1780
1886
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1781
1887
|
|
1782
1888
|
# auth_names
|
1783
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1889
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1784
1890
|
|
1785
1891
|
new_options = opts.merge(
|
1786
1892
|
:operation => :"ProfilesApi.get_profiles",
|
@@ -1804,8 +1910,8 @@ module KlaviyoAPI
|
|
1804
1910
|
# @param id [String]
|
1805
1911
|
# @param [Hash] opts the optional parameters
|
1806
1912
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1807
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1808
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1913
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1914
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1809
1915
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1810
1916
|
# @return [Hash<String, Object>]
|
1811
1917
|
def get_profiles_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1819,13 +1925,16 @@ module KlaviyoAPI
|
|
1819
1925
|
# alias of `get_profiles_for_bulk_import_profiles_job`
|
1820
1926
|
alias get_profile_bulk_import_job_profiles get_profiles_for_bulk_import_profiles_job
|
1821
1927
|
|
1928
|
+
# alias of `get_profiles_for_bulk_import_profiles_job`
|
1929
|
+
alias get_profiles_for_profile_bulk_import_job get_profiles_for_bulk_import_profiles_job
|
1930
|
+
|
1822
1931
|
# Get Profiles for Bulk Import Profiles Job
|
1823
1932
|
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1824
1933
|
# @param id [String]
|
1825
1934
|
# @param [Hash] opts the optional parameters
|
1826
1935
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1827
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
1828
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1936
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1937
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1829
1938
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1830
1939
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1831
1940
|
def get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1865,7 +1974,7 @@ module KlaviyoAPI
|
|
1865
1974
|
# header parameters
|
1866
1975
|
header_params = opts[:header_params] || {}
|
1867
1976
|
# klaviyo api revision
|
1868
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1977
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1869
1978
|
# HTTP header 'Accept' (if needed)
|
1870
1979
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1871
1980
|
|
@@ -1879,7 +1988,7 @@ module KlaviyoAPI
|
|
1879
1988
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1880
1989
|
|
1881
1990
|
# auth_names
|
1882
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1991
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1883
1992
|
|
1884
1993
|
new_options = opts.merge(
|
1885
1994
|
:operation => :"ProfilesApi.get_profiles_for_bulk_import_profiles_job",
|
@@ -1904,6 +2013,9 @@ module KlaviyoAPI
|
|
1904
2013
|
# alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
|
1905
2014
|
alias get_profile_bulk_import_job_profiles_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
|
1906
2015
|
|
2016
|
+
# alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
|
2017
|
+
alias get_profiles_for_profile_bulk_import_job_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
|
2018
|
+
|
1907
2019
|
# Get Segment IDs for Profile
|
1908
2020
|
# 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`
|
1909
2021
|
# @param id [String]
|
@@ -1939,7 +2051,7 @@ module KlaviyoAPI
|
|
1939
2051
|
# header parameters
|
1940
2052
|
header_params = opts[:header_params] || {}
|
1941
2053
|
# klaviyo api revision
|
1942
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2054
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1943
2055
|
# HTTP header 'Accept' (if needed)
|
1944
2056
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1945
2057
|
|
@@ -1953,7 +2065,7 @@ module KlaviyoAPI
|
|
1953
2065
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1954
2066
|
|
1955
2067
|
# auth_names
|
1956
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2068
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1957
2069
|
|
1958
2070
|
new_options = opts.merge(
|
1959
2071
|
:operation => :"ProfilesApi.get_segment_ids_for_profile",
|
@@ -1979,7 +2091,7 @@ module KlaviyoAPI
|
|
1979
2091
|
# 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`
|
1980
2092
|
# @param id [String]
|
1981
2093
|
# @param [Hash] opts the optional parameters
|
1982
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
2094
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1983
2095
|
# @return [Hash<String, Object>]
|
1984
2096
|
def get_segments_for_profile(id, opts = {})
|
1985
2097
|
data, _status_code, _headers = get_segments_for_profile_with_http_info(id, opts)
|
@@ -1993,7 +2105,7 @@ module KlaviyoAPI
|
|
1993
2105
|
# 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`
|
1994
2106
|
# @param id [String]
|
1995
2107
|
# @param [Hash] opts the optional parameters
|
1996
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
2108
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1997
2109
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1998
2110
|
def get_segments_for_profile_with_http_info(id, opts = {})
|
1999
2111
|
if @api_client.config.debugging
|
@@ -2017,7 +2129,7 @@ module KlaviyoAPI
|
|
2017
2129
|
# header parameters
|
2018
2130
|
header_params = opts[:header_params] || {}
|
2019
2131
|
# klaviyo api revision
|
2020
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2132
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2021
2133
|
# HTTP header 'Accept' (if needed)
|
2022
2134
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2023
2135
|
|
@@ -2031,7 +2143,7 @@ module KlaviyoAPI
|
|
2031
2143
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2032
2144
|
|
2033
2145
|
# auth_names
|
2034
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2146
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2035
2147
|
|
2036
2148
|
new_options = opts.merge(
|
2037
2149
|
:operation => :"ProfilesApi.get_segments_for_profile",
|
@@ -2088,7 +2200,7 @@ module KlaviyoAPI
|
|
2088
2200
|
# header parameters
|
2089
2201
|
header_params = opts[:header_params] || {}
|
2090
2202
|
# klaviyo api revision
|
2091
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2203
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2092
2204
|
# HTTP header 'Accept' (if needed)
|
2093
2205
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2094
2206
|
# HTTP header 'Content-Type'
|
@@ -2107,7 +2219,7 @@ module KlaviyoAPI
|
|
2107
2219
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2108
2220
|
|
2109
2221
|
# auth_names
|
2110
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2222
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2111
2223
|
|
2112
2224
|
new_options = opts.merge(
|
2113
2225
|
:operation => :"ProfilesApi.merge_profiles",
|
@@ -2129,90 +2241,8 @@ module KlaviyoAPI
|
|
2129
2241
|
# alias of `merge_profiles_with_http_info`
|
2130
2242
|
alias create_profile_merge_with_http_info merge_profiles_with_http_info
|
2131
2243
|
|
2132
|
-
# Spawn Bulk Profile Import Job
|
2133
|
-
# 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`
|
2134
|
-
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
2135
|
-
# @param [Hash] opts the optional parameters
|
2136
|
-
# @return [Hash<String, Object>]
|
2137
|
-
def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {})
|
2138
|
-
data, _status_code, _headers = spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts)
|
2139
|
-
data
|
2140
|
-
end
|
2141
|
-
|
2142
|
-
# alias of `spawn_bulk_profile_import_job`
|
2143
|
-
alias bulk_import_profiles spawn_bulk_profile_import_job
|
2144
|
-
|
2145
|
-
# alias of `spawn_bulk_profile_import_job`
|
2146
|
-
alias create_profile_bulk_import_job spawn_bulk_profile_import_job
|
2147
|
-
|
2148
|
-
# Spawn Bulk Profile Import Job
|
2149
|
-
# 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`
|
2150
|
-
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
2151
|
-
# @param [Hash] opts the optional parameters
|
2152
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2153
|
-
def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts = {})
|
2154
|
-
if @api_client.config.debugging
|
2155
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.spawn_bulk_profile_import_job ...'
|
2156
|
-
end
|
2157
|
-
# verify the required parameter 'profile_import_job_create_query' is set
|
2158
|
-
if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
|
2159
|
-
fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.spawn_bulk_profile_import_job"
|
2160
|
-
end
|
2161
|
-
# resource path
|
2162
|
-
local_var_path = '/api/profile-bulk-import-jobs'
|
2163
|
-
|
2164
|
-
# query parameters
|
2165
|
-
query_params = opts[:query_params] || {}
|
2166
|
-
|
2167
|
-
# header parameters
|
2168
|
-
header_params = opts[:header_params] || {}
|
2169
|
-
# klaviyo api revision
|
2170
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
2171
|
-
# HTTP header 'Accept' (if needed)
|
2172
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2173
|
-
# HTTP header 'Content-Type'
|
2174
|
-
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
2175
|
-
if !content_type.nil?
|
2176
|
-
header_params['Content-Type'] = content_type
|
2177
|
-
end
|
2178
|
-
|
2179
|
-
# form parameters
|
2180
|
-
form_params = opts[:form_params] || {}
|
2181
|
-
|
2182
|
-
# http body (model)
|
2183
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_import_job_create_query)
|
2184
|
-
|
2185
|
-
# return_type
|
2186
|
-
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2187
|
-
|
2188
|
-
# auth_names
|
2189
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2190
|
-
|
2191
|
-
new_options = opts.merge(
|
2192
|
-
:operation => :"ProfilesApi.spawn_bulk_profile_import_job",
|
2193
|
-
:header_params => header_params,
|
2194
|
-
:query_params => query_params,
|
2195
|
-
:form_params => form_params,
|
2196
|
-
:body => post_body,
|
2197
|
-
:auth_names => auth_names,
|
2198
|
-
:return_type => return_type
|
2199
|
-
)
|
2200
|
-
|
2201
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2202
|
-
if @api_client.config.debugging
|
2203
|
-
@api_client.config.logger.debug "API called: ProfilesApi#spawn_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2204
|
-
end
|
2205
|
-
return data, status_code, headers
|
2206
|
-
end
|
2207
|
-
|
2208
|
-
# alias of `spawn_bulk_profile_import_job_with_http_info`
|
2209
|
-
alias bulk_import_profiles_with_http_info spawn_bulk_profile_import_job_with_http_info
|
2210
|
-
|
2211
|
-
# alias of `spawn_bulk_profile_import_job_with_http_info`
|
2212
|
-
alias create_profile_bulk_import_job_with_http_info spawn_bulk_profile_import_job_with_http_info
|
2213
|
-
|
2214
2244
|
# Update Profile
|
2215
|
-
# Update the profile with the given profile ID. 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`
|
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`
|
2216
2246
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
2217
2247
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
2218
2248
|
# @param [Hash] opts the optional parameters
|
@@ -2224,7 +2254,7 @@ module KlaviyoAPI
|
|
2224
2254
|
end
|
2225
2255
|
|
2226
2256
|
# Update Profile
|
2227
|
-
# Update the profile with the given profile ID. 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`
|
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`
|
2228
2258
|
# @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
|
2229
2259
|
# @param profile_partial_update_query [ProfilePartialUpdateQuery]
|
2230
2260
|
# @param [Hash] opts the optional parameters
|
@@ -2256,7 +2286,7 @@ module KlaviyoAPI
|
|
2256
2286
|
# header parameters
|
2257
2287
|
header_params = opts[:header_params] || {}
|
2258
2288
|
# klaviyo api revision
|
2259
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
2289
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2260
2290
|
# HTTP header 'Accept' (if needed)
|
2261
2291
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2262
2292
|
# HTTP header 'Content-Type'
|
@@ -2275,7 +2305,7 @@ module KlaviyoAPI
|
|
2275
2305
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
2276
2306
|
|
2277
2307
|
# auth_names
|
2278
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
2308
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2279
2309
|
|
2280
2310
|
new_options = opts.merge(
|
2281
2311
|
:operation => :"ProfilesApi.update_profile",
|