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
|
@@ -51,7 +51,7 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
54
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
57
|
# HTTP header 'Content-Type'
|
@@ -70,7 +70,7 @@ module KlaviyoAPI
|
|
70
70
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
71
71
|
|
72
72
|
# auth_names
|
73
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
73
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
74
74
|
|
75
75
|
new_options = opts.merge(
|
76
76
|
:operation => :"SegmentsApi.create_segment",
|
@@ -121,7 +121,7 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
124
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
125
125
|
# HTTP header 'Accept' (if needed)
|
126
126
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
127
127
|
|
@@ -135,7 +135,7 @@ module KlaviyoAPI
|
|
135
135
|
return_type = opts[:debug_return_type]
|
136
136
|
|
137
137
|
# auth_names
|
138
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
138
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
139
139
|
|
140
140
|
new_options = opts.merge(
|
141
141
|
:operation => :"SegmentsApi.delete_segment",
|
@@ -154,14 +154,175 @@ module KlaviyoAPI
|
|
154
154
|
return data, status_code, headers
|
155
155
|
end
|
156
156
|
|
157
|
+
# Get Flows Triggered by Segment
|
158
|
+
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
159
|
+
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
160
|
+
# @param [Hash] opts the optional parameters
|
161
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
162
|
+
# @return [Hash<String, Object>]
|
163
|
+
def get_flows_triggered_by_segment(id, opts = {})
|
164
|
+
data, _status_code, _headers = get_flows_triggered_by_segment_with_http_info(id, opts)
|
165
|
+
data
|
166
|
+
end
|
167
|
+
|
168
|
+
# alias of `get_flows_triggered_by_segment`
|
169
|
+
alias get_flow_triggers_for_segment get_flows_triggered_by_segment
|
170
|
+
|
171
|
+
# alias of `get_flows_triggered_by_segment`
|
172
|
+
alias get_segment_flow_triggers get_flows_triggered_by_segment
|
173
|
+
|
174
|
+
# Get Flows Triggered by Segment
|
175
|
+
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
176
|
+
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
177
|
+
# @param [Hash] opts the optional parameters
|
178
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
179
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
180
|
+
def get_flows_triggered_by_segment_with_http_info(id, opts = {})
|
181
|
+
if @api_client.config.debugging
|
182
|
+
@api_client.config.logger.debug 'Calling API: SegmentsApi.get_flows_triggered_by_segment ...'
|
183
|
+
end
|
184
|
+
# verify the required parameter 'id' is set
|
185
|
+
if @api_client.config.client_side_validation && id.nil?
|
186
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_flows_triggered_by_segment"
|
187
|
+
end
|
188
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
189
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
190
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
191
|
+
end
|
192
|
+
# resource path
|
193
|
+
local_var_path = '/api/segments/{id}/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
194
|
+
|
195
|
+
# query parameters
|
196
|
+
query_params = opts[:query_params] || {}
|
197
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
198
|
+
|
199
|
+
# header parameters
|
200
|
+
header_params = opts[:header_params] || {}
|
201
|
+
# klaviyo api revision
|
202
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
203
|
+
# HTTP header 'Accept' (if needed)
|
204
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
205
|
+
|
206
|
+
# form parameters
|
207
|
+
form_params = opts[:form_params] || {}
|
208
|
+
|
209
|
+
# http body (model)
|
210
|
+
post_body = opts[:debug_body]
|
211
|
+
|
212
|
+
# return_type
|
213
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
214
|
+
|
215
|
+
# auth_names
|
216
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
217
|
+
|
218
|
+
new_options = opts.merge(
|
219
|
+
:operation => :"SegmentsApi.get_flows_triggered_by_segment",
|
220
|
+
:header_params => header_params,
|
221
|
+
:query_params => query_params,
|
222
|
+
:form_params => form_params,
|
223
|
+
:body => post_body,
|
224
|
+
:auth_names => auth_names,
|
225
|
+
:return_type => return_type
|
226
|
+
)
|
227
|
+
|
228
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
229
|
+
if @api_client.config.debugging
|
230
|
+
@api_client.config.logger.debug "API called: SegmentsApi#get_flows_triggered_by_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
231
|
+
end
|
232
|
+
return data, status_code, headers
|
233
|
+
end
|
234
|
+
|
235
|
+
# alias of `get_flows_triggered_by_segment_with_http_info`
|
236
|
+
alias get_flow_triggers_for_segment_with_http_info get_flows_triggered_by_segment_with_http_info
|
237
|
+
|
238
|
+
# alias of `get_flows_triggered_by_segment_with_http_info`
|
239
|
+
alias get_segment_flow_triggers_with_http_info get_flows_triggered_by_segment_with_http_info
|
240
|
+
|
241
|
+
# Get IDs for Flows Triggered by Segment
|
242
|
+
# Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
243
|
+
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
244
|
+
# @param [Hash] opts the optional parameters
|
245
|
+
# @return [Hash<String, Object>]
|
246
|
+
def get_ids_for_flows_triggered_by_segment(id, opts = {})
|
247
|
+
data, _status_code, _headers = get_ids_for_flows_triggered_by_segment_with_http_info(id, opts)
|
248
|
+
data
|
249
|
+
end
|
250
|
+
|
251
|
+
# alias of `get_ids_for_flows_triggered_by_segment`
|
252
|
+
alias get_flow_trigger_ids_for_segment get_ids_for_flows_triggered_by_segment
|
253
|
+
|
254
|
+
# alias of `get_ids_for_flows_triggered_by_segment`
|
255
|
+
alias get_segment_relationships_flow_triggers get_ids_for_flows_triggered_by_segment
|
256
|
+
|
257
|
+
# Get IDs for Flows Triggered by Segment
|
258
|
+
# Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
259
|
+
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
260
|
+
# @param [Hash] opts the optional parameters
|
261
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
262
|
+
def get_ids_for_flows_triggered_by_segment_with_http_info(id, opts = {})
|
263
|
+
if @api_client.config.debugging
|
264
|
+
@api_client.config.logger.debug 'Calling API: SegmentsApi.get_ids_for_flows_triggered_by_segment ...'
|
265
|
+
end
|
266
|
+
# verify the required parameter 'id' is set
|
267
|
+
if @api_client.config.client_side_validation && id.nil?
|
268
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_ids_for_flows_triggered_by_segment"
|
269
|
+
end
|
270
|
+
# resource path
|
271
|
+
local_var_path = '/api/segments/{id}/relationships/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
272
|
+
|
273
|
+
# query parameters
|
274
|
+
query_params = opts[:query_params] || {}
|
275
|
+
|
276
|
+
# header parameters
|
277
|
+
header_params = opts[:header_params] || {}
|
278
|
+
# klaviyo api revision
|
279
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
280
|
+
# HTTP header 'Accept' (if needed)
|
281
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
282
|
+
|
283
|
+
# form parameters
|
284
|
+
form_params = opts[:form_params] || {}
|
285
|
+
|
286
|
+
# http body (model)
|
287
|
+
post_body = opts[:debug_body]
|
288
|
+
|
289
|
+
# return_type
|
290
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
291
|
+
|
292
|
+
# auth_names
|
293
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
294
|
+
|
295
|
+
new_options = opts.merge(
|
296
|
+
:operation => :"SegmentsApi.get_ids_for_flows_triggered_by_segment",
|
297
|
+
:header_params => header_params,
|
298
|
+
:query_params => query_params,
|
299
|
+
:form_params => form_params,
|
300
|
+
:body => post_body,
|
301
|
+
:auth_names => auth_names,
|
302
|
+
:return_type => return_type
|
303
|
+
)
|
304
|
+
|
305
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
306
|
+
if @api_client.config.debugging
|
307
|
+
@api_client.config.logger.debug "API called: SegmentsApi#get_ids_for_flows_triggered_by_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
308
|
+
end
|
309
|
+
return data, status_code, headers
|
310
|
+
end
|
311
|
+
|
312
|
+
# alias of `get_ids_for_flows_triggered_by_segment_with_http_info`
|
313
|
+
alias get_flow_trigger_ids_for_segment_with_http_info get_ids_for_flows_triggered_by_segment_with_http_info
|
314
|
+
|
315
|
+
# alias of `get_ids_for_flows_triggered_by_segment_with_http_info`
|
316
|
+
alias get_segment_relationships_flow_triggers_with_http_info get_ids_for_flows_triggered_by_segment_with_http_info
|
317
|
+
|
157
318
|
# Get Profile IDs for Segment
|
158
319
|
# Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
|
159
320
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
160
321
|
# @param [Hash] opts the optional parameters
|
161
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
162
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
163
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max:
|
164
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
322
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
323
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
324
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
325
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
165
326
|
# @return [Hash<String, Object>]
|
166
327
|
def get_profile_ids_for_segment(id, opts = {})
|
167
328
|
data, _status_code, _headers = get_profile_ids_for_segment_with_http_info(id, opts)
|
@@ -175,10 +336,10 @@ module KlaviyoAPI
|
|
175
336
|
# Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
|
176
337
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
177
338
|
# @param [Hash] opts the optional parameters
|
178
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
179
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
180
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max:
|
181
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
339
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
340
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
341
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
342
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
182
343
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
183
344
|
def get_profile_ids_for_segment_with_http_info(id, opts = {})
|
184
345
|
if @api_client.config.debugging
|
@@ -188,8 +349,8 @@ module KlaviyoAPI
|
|
188
349
|
if @api_client.config.client_side_validation && id.nil?
|
189
350
|
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_profile_ids_for_segment"
|
190
351
|
end
|
191
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
192
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_profile_ids_for_segment, must be smaller than or equal to
|
352
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
353
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_profile_ids_for_segment, must be smaller than or equal to 100.'
|
193
354
|
end
|
194
355
|
|
195
356
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
@@ -213,7 +374,7 @@ module KlaviyoAPI
|
|
213
374
|
# header parameters
|
214
375
|
header_params = opts[:header_params] || {}
|
215
376
|
# klaviyo api revision
|
216
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
377
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
217
378
|
# HTTP header 'Accept' (if needed)
|
218
379
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
219
380
|
|
@@ -227,7 +388,7 @@ module KlaviyoAPI
|
|
227
388
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
228
389
|
|
229
390
|
# auth_names
|
230
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
391
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
231
392
|
|
232
393
|
new_options = opts.merge(
|
233
394
|
:operation => :"SegmentsApi.get_profile_ids_for_segment",
|
@@ -251,14 +412,14 @@ module KlaviyoAPI
|
|
251
412
|
|
252
413
|
# Get Profiles for Segment
|
253
414
|
# Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
|
254
|
-
# @param id [String]
|
415
|
+
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
255
416
|
# @param [Hash] opts the optional parameters
|
256
417
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
257
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
258
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
259
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
418
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
419
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
420
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
260
421
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
261
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
422
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
262
423
|
# @return [Hash<String, Object>]
|
263
424
|
def get_profiles_for_segment(id, opts = {})
|
264
425
|
data, _status_code, _headers = get_profiles_for_segment_with_http_info(id, opts)
|
@@ -270,14 +431,14 @@ module KlaviyoAPI
|
|
270
431
|
|
271
432
|
# Get Profiles for Segment
|
272
433
|
# Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
|
273
|
-
# @param id [String]
|
434
|
+
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
274
435
|
# @param [Hash] opts the optional parameters
|
275
436
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
276
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/
|
277
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
278
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
437
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
438
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
439
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
279
440
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
280
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
441
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
281
442
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
282
443
|
def get_profiles_for_segment_with_http_info(id, opts = {})
|
283
444
|
if @api_client.config.debugging
|
@@ -322,7 +483,7 @@ module KlaviyoAPI
|
|
322
483
|
# header parameters
|
323
484
|
header_params = opts[:header_params] || {}
|
324
485
|
# klaviyo api revision
|
325
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
486
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
326
487
|
# HTTP header 'Accept' (if needed)
|
327
488
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
328
489
|
|
@@ -336,7 +497,7 @@ module KlaviyoAPI
|
|
336
497
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
337
498
|
|
338
499
|
# auth_names
|
339
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
500
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
340
501
|
|
341
502
|
new_options = opts.merge(
|
342
503
|
:operation => :"SegmentsApi.get_profiles_for_segment",
|
@@ -359,14 +520,14 @@ module KlaviyoAPI
|
|
359
520
|
alias get_segment_profiles_with_http_info get_profiles_for_segment_with_http_info
|
360
521
|
|
361
522
|
# Get Segment
|
362
|
-
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/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/
|
523
|
+
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/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:** `segments:read`
|
363
524
|
# @param id [String]
|
364
525
|
# @param [Hash] opts the optional parameters
|
365
526
|
# @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: 'profile_count'
|
366
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
367
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
368
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
369
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
527
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
528
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
529
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
530
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
370
531
|
# @return [Hash<String, Object>]
|
371
532
|
def get_segment(id, opts = {})
|
372
533
|
data, _status_code, _headers = get_segment_with_http_info(id, opts)
|
@@ -374,14 +535,14 @@ module KlaviyoAPI
|
|
374
535
|
end
|
375
536
|
|
376
537
|
# Get Segment
|
377
|
-
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/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/
|
538
|
+
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/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:** `segments:read`
|
378
539
|
# @param id [String]
|
379
540
|
# @param [Hash] opts the optional parameters
|
380
541
|
# @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: 'profile_count'
|
381
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
382
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
383
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
384
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
542
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
543
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
544
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
545
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
385
546
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
386
547
|
def get_segment_with_http_info(id, opts = {})
|
387
548
|
if @api_client.config.debugging
|
@@ -425,7 +586,7 @@ module KlaviyoAPI
|
|
425
586
|
# header parameters
|
426
587
|
header_params = opts[:header_params] || {}
|
427
588
|
# klaviyo api revision
|
428
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
589
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
429
590
|
# HTTP header 'Accept' (if needed)
|
430
591
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
431
592
|
|
@@ -439,7 +600,7 @@ module KlaviyoAPI
|
|
439
600
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
440
601
|
|
441
602
|
# auth_names
|
442
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
603
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
443
604
|
|
444
605
|
new_options = opts.merge(
|
445
606
|
:operation => :"SegmentsApi.get_segment",
|
@@ -458,153 +619,16 @@ module KlaviyoAPI
|
|
458
619
|
return data, status_code, headers
|
459
620
|
end
|
460
621
|
|
461
|
-
# Get Segment Flow Triggers
|
462
|
-
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
463
|
-
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
464
|
-
# @param [Hash] opts the optional parameters
|
465
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
466
|
-
# @return [Hash<String, Object>]
|
467
|
-
def get_segment_flow_triggers(id, opts = {})
|
468
|
-
data, _status_code, _headers = get_segment_flow_triggers_with_http_info(id, opts)
|
469
|
-
data
|
470
|
-
end
|
471
|
-
|
472
|
-
# Get Segment Flow Triggers
|
473
|
-
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
474
|
-
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
475
|
-
# @param [Hash] opts the optional parameters
|
476
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
477
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
478
|
-
def get_segment_flow_triggers_with_http_info(id, opts = {})
|
479
|
-
if @api_client.config.debugging
|
480
|
-
@api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_flow_triggers ...'
|
481
|
-
end
|
482
|
-
# verify the required parameter 'id' is set
|
483
|
-
if @api_client.config.client_side_validation && id.nil?
|
484
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_flow_triggers"
|
485
|
-
end
|
486
|
-
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
487
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
488
|
-
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
489
|
-
end
|
490
|
-
# resource path
|
491
|
-
local_var_path = '/api/segments/{id}/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
492
|
-
|
493
|
-
# query parameters
|
494
|
-
query_params = opts[:query_params] || {}
|
495
|
-
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
496
|
-
|
497
|
-
# header parameters
|
498
|
-
header_params = opts[:header_params] || {}
|
499
|
-
# klaviyo api revision
|
500
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
501
|
-
# HTTP header 'Accept' (if needed)
|
502
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
503
|
-
|
504
|
-
# form parameters
|
505
|
-
form_params = opts[:form_params] || {}
|
506
|
-
|
507
|
-
# http body (model)
|
508
|
-
post_body = opts[:debug_body]
|
509
|
-
|
510
|
-
# return_type
|
511
|
-
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
512
|
-
|
513
|
-
# auth_names
|
514
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
515
|
-
|
516
|
-
new_options = opts.merge(
|
517
|
-
:operation => :"SegmentsApi.get_segment_flow_triggers",
|
518
|
-
:header_params => header_params,
|
519
|
-
:query_params => query_params,
|
520
|
-
:form_params => form_params,
|
521
|
-
:body => post_body,
|
522
|
-
:auth_names => auth_names,
|
523
|
-
:return_type => return_type
|
524
|
-
)
|
525
|
-
|
526
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
527
|
-
if @api_client.config.debugging
|
528
|
-
@api_client.config.logger.debug "API called: SegmentsApi#get_segment_flow_triggers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
529
|
-
end
|
530
|
-
return data, status_code, headers
|
531
|
-
end
|
532
|
-
|
533
|
-
# Get Segment Relationships Flow Triggers
|
534
|
-
# Get all flow [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
535
|
-
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
536
|
-
# @param [Hash] opts the optional parameters
|
537
|
-
# @return [Hash<String, Object>]
|
538
|
-
def get_segment_relationships_flow_triggers(id, opts = {})
|
539
|
-
data, _status_code, _headers = get_segment_relationships_flow_triggers_with_http_info(id, opts)
|
540
|
-
data
|
541
|
-
end
|
542
|
-
|
543
|
-
# Get Segment Relationships Flow Triggers
|
544
|
-
# Get all flow [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
545
|
-
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
546
|
-
# @param [Hash] opts the optional parameters
|
547
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
548
|
-
def get_segment_relationships_flow_triggers_with_http_info(id, opts = {})
|
549
|
-
if @api_client.config.debugging
|
550
|
-
@api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_relationships_flow_triggers ...'
|
551
|
-
end
|
552
|
-
# verify the required parameter 'id' is set
|
553
|
-
if @api_client.config.client_side_validation && id.nil?
|
554
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_relationships_flow_triggers"
|
555
|
-
end
|
556
|
-
# resource path
|
557
|
-
local_var_path = '/api/segments/{id}/relationships/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
558
|
-
|
559
|
-
# query parameters
|
560
|
-
query_params = opts[:query_params] || {}
|
561
|
-
|
562
|
-
# header parameters
|
563
|
-
header_params = opts[:header_params] || {}
|
564
|
-
# klaviyo api revision
|
565
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
566
|
-
# HTTP header 'Accept' (if needed)
|
567
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
568
|
-
|
569
|
-
# form parameters
|
570
|
-
form_params = opts[:form_params] || {}
|
571
|
-
|
572
|
-
# http body (model)
|
573
|
-
post_body = opts[:debug_body]
|
574
|
-
|
575
|
-
# return_type
|
576
|
-
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
577
|
-
|
578
|
-
# auth_names
|
579
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
580
|
-
|
581
|
-
new_options = opts.merge(
|
582
|
-
:operation => :"SegmentsApi.get_segment_relationships_flow_triggers",
|
583
|
-
:header_params => header_params,
|
584
|
-
:query_params => query_params,
|
585
|
-
:form_params => form_params,
|
586
|
-
:body => post_body,
|
587
|
-
:auth_names => auth_names,
|
588
|
-
:return_type => return_type
|
589
|
-
)
|
590
|
-
|
591
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
592
|
-
if @api_client.config.debugging
|
593
|
-
@api_client.config.logger.debug "API called: SegmentsApi#get_segment_relationships_flow_triggers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
594
|
-
end
|
595
|
-
return data, status_code, headers
|
596
|
-
end
|
597
|
-
|
598
622
|
# Get Segments
|
599
623
|
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `segments:read`
|
600
624
|
# @param [Hash] opts the optional parameters
|
601
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
602
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
603
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
604
|
-
# @option opts [String] :filter 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/
|
606
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
607
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
625
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
626
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
627
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
628
|
+
# @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>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
|
629
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
630
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
631
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
608
632
|
# @return [Hash<String, Object>]
|
609
633
|
def get_segments(opts = {})
|
610
634
|
data, _status_code, _headers = get_segments_with_http_info(opts)
|
@@ -614,13 +638,13 @@ module KlaviyoAPI
|
|
614
638
|
# Get Segments
|
615
639
|
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `segments:read`
|
616
640
|
# @param [Hash] opts the optional parameters
|
617
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
618
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/
|
619
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
620
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
621
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
622
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
623
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
641
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
642
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
643
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
644
|
+
# @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>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
|
645
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
646
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
647
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
624
648
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
625
649
|
def get_segments_with_http_info(opts = {})
|
626
650
|
if @api_client.config.debugging
|
@@ -662,7 +686,7 @@ module KlaviyoAPI
|
|
662
686
|
# header parameters
|
663
687
|
header_params = opts[:header_params] || {}
|
664
688
|
# klaviyo api revision
|
665
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
689
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
666
690
|
# HTTP header 'Accept' (if needed)
|
667
691
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
668
692
|
|
@@ -676,7 +700,7 @@ module KlaviyoAPI
|
|
676
700
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
677
701
|
|
678
702
|
# auth_names
|
679
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
703
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
680
704
|
|
681
705
|
new_options = opts.merge(
|
682
706
|
:operation => :"SegmentsApi.get_segments",
|
@@ -730,7 +754,7 @@ module KlaviyoAPI
|
|
730
754
|
# header parameters
|
731
755
|
header_params = opts[:header_params] || {}
|
732
756
|
# klaviyo api revision
|
733
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
757
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
734
758
|
# HTTP header 'Accept' (if needed)
|
735
759
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
736
760
|
|
@@ -744,7 +768,7 @@ module KlaviyoAPI
|
|
744
768
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
745
769
|
|
746
770
|
# auth_names
|
747
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
771
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
748
772
|
|
749
773
|
new_options = opts.merge(
|
750
774
|
:operation => :"SegmentsApi.get_tag_ids_for_segment",
|
@@ -770,7 +794,7 @@ module KlaviyoAPI
|
|
770
794
|
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
771
795
|
# @param id [String]
|
772
796
|
# @param [Hash] opts the optional parameters
|
773
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
797
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
774
798
|
# @return [Hash<String, Object>]
|
775
799
|
def get_tags_for_segment(id, opts = {})
|
776
800
|
data, _status_code, _headers = get_tags_for_segment_with_http_info(id, opts)
|
@@ -784,7 +808,7 @@ module KlaviyoAPI
|
|
784
808
|
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
785
809
|
# @param id [String]
|
786
810
|
# @param [Hash] opts the optional parameters
|
787
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
811
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
788
812
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
789
813
|
def get_tags_for_segment_with_http_info(id, opts = {})
|
790
814
|
if @api_client.config.debugging
|
@@ -808,7 +832,7 @@ module KlaviyoAPI
|
|
808
832
|
# header parameters
|
809
833
|
header_params = opts[:header_params] || {}
|
810
834
|
# klaviyo api revision
|
811
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
835
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
812
836
|
# HTTP header 'Accept' (if needed)
|
813
837
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
814
838
|
|
@@ -822,7 +846,7 @@ module KlaviyoAPI
|
|
822
846
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
823
847
|
|
824
848
|
# auth_names
|
825
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
849
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
826
850
|
|
827
851
|
new_options = opts.merge(
|
828
852
|
:operation => :"SegmentsApi.get_tags_for_segment",
|
@@ -882,7 +906,7 @@ module KlaviyoAPI
|
|
882
906
|
# header parameters
|
883
907
|
header_params = opts[:header_params] || {}
|
884
908
|
# klaviyo api revision
|
885
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
909
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
886
910
|
# HTTP header 'Accept' (if needed)
|
887
911
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
888
912
|
# HTTP header 'Content-Type'
|
@@ -901,7 +925,7 @@ module KlaviyoAPI
|
|
901
925
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
902
926
|
|
903
927
|
# auth_names
|
904
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
928
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
905
929
|
|
906
930
|
new_options = opts.merge(
|
907
931
|
:operation => :"SegmentsApi.update_segment",
|