klaviyo-api-sdk 9.0.0 → 11.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 +35 -0
- data/README.md +1272 -524
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1720 -1576
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +317 -287
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +5 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +134 -122
- data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
- data/lib/klaviyo-api-sdk/api/forms_api.rb +56 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +28 -28
- data/lib/klaviyo-api-sdk/api/lists_api.rb +316 -153
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +582 -19
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +1046 -603
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +323 -19
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
- data/lib/klaviyo-api-sdk/api/tags_api.rb +741 -645
- data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
- 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 +1 -1
- 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 +1 -1
- 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 +274 -0
- data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -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/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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
- 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 +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
- 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 +1 -1
- 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 +1 -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 +1 -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/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- 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 +238 -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 +1 -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 +1 -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_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 +245 -0
- 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/device_metadata.rb +3 -3
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -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 +13 -2
- 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/flow_enum.rb +1 -1
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
- 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 +1 -1
- 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 +36 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
- 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 +252 -0
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- 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/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- 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/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/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 +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -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/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/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/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- 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/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 +13 -2
- 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 +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -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 +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- 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 +13 -2
- 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_enum.rb +1 -1
- 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_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 +1 -1
- 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 +1 -1
- 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 +13 -2
- 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/push_enum.rb +1 -1
- 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 +13 -2
- 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/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 +1 -1
- 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 +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- 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 +1 -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 +1 -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/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +14 -10
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- 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/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 +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -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/sto_schedule_options.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/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- 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/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 +1 -1
- 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 +36 -0
- 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 +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -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 +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -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 +1 -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 +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- 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 +90 -22
- metadata +59 -4
@@ -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: 2024-
|
6
|
+
The version of the OpenAPI document: 2024-10-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -20,7 +20,7 @@ module KlaviyoAPI
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create List
|
23
|
-
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `
|
23
|
+
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `150/d` **Scopes:** `lists:write`
|
24
24
|
# @param list_create_query [ListCreateQuery]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
@@ -30,7 +30,7 @@ module KlaviyoAPI
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create List
|
33
|
-
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `
|
33
|
+
# Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `150/d` **Scopes:** `lists:write`
|
34
34
|
# @param list_create_query [ListCreateQuery]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
@@ -43,7 +43,7 @@ module KlaviyoAPI
|
|
43
43
|
fail ArgumentError, "Missing the required parameter 'list_create_query' when calling ListsApi.create_list"
|
44
44
|
end
|
45
45
|
# resource path
|
46
|
-
local_var_path = '/api/lists
|
46
|
+
local_var_path = '/api/lists'
|
47
47
|
|
48
48
|
# query parameters
|
49
49
|
query_params = opts[:query_params] || {}
|
@@ -51,11 +51,11 @@ 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'] || "2024-
|
54
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
57
|
# HTTP header 'Content-Type'
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
58
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
59
59
|
if !content_type.nil?
|
60
60
|
header_params['Content-Type'] = content_type
|
61
61
|
end
|
@@ -122,7 +122,7 @@ module KlaviyoAPI
|
|
122
122
|
fail ArgumentError, "Missing the required parameter 'list_members_add_query' when calling ListsApi.create_list_relationships"
|
123
123
|
end
|
124
124
|
# resource path
|
125
|
-
local_var_path = '/api/lists/{id}/relationships/profiles
|
125
|
+
local_var_path = '/api/lists/{id}/relationships/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
126
126
|
|
127
127
|
# query parameters
|
128
128
|
query_params = opts[:query_params] || {}
|
@@ -130,11 +130,11 @@ module KlaviyoAPI
|
|
130
130
|
# header parameters
|
131
131
|
header_params = opts[:header_params] || {}
|
132
132
|
# klaviyo api revision
|
133
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
133
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
134
134
|
# HTTP header 'Accept' (if needed)
|
135
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
135
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
136
136
|
# HTTP header 'Content-Type'
|
137
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
137
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
138
138
|
if !content_type.nil?
|
139
139
|
header_params['Content-Type'] = content_type
|
140
140
|
end
|
@@ -195,7 +195,7 @@ module KlaviyoAPI
|
|
195
195
|
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.delete_list"
|
196
196
|
end
|
197
197
|
# resource path
|
198
|
-
local_var_path = '/api/lists/{id}
|
198
|
+
local_var_path = '/api/lists/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
199
199
|
|
200
200
|
# query parameters
|
201
201
|
query_params = opts[:query_params] || {}
|
@@ -203,9 +203,9 @@ module KlaviyoAPI
|
|
203
203
|
# header parameters
|
204
204
|
header_params = opts[:header_params] || {}
|
205
205
|
# klaviyo api revision
|
206
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
206
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
207
207
|
# HTTP header 'Accept' (if needed)
|
208
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
209
209
|
|
210
210
|
# form parameters
|
211
211
|
form_params = opts[:form_params] || {}
|
@@ -269,7 +269,7 @@ module KlaviyoAPI
|
|
269
269
|
fail ArgumentError, "Missing the required parameter 'list_members_delete_query' when calling ListsApi.delete_list_relationships"
|
270
270
|
end
|
271
271
|
# resource path
|
272
|
-
local_var_path = '/api/lists/{id}/relationships/profiles
|
272
|
+
local_var_path = '/api/lists/{id}/relationships/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
273
273
|
|
274
274
|
# query parameters
|
275
275
|
query_params = opts[:query_params] || {}
|
@@ -277,11 +277,11 @@ module KlaviyoAPI
|
|
277
277
|
# header parameters
|
278
278
|
header_params = opts[:header_params] || {}
|
279
279
|
# klaviyo api revision
|
280
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
280
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
281
281
|
# HTTP header 'Accept' (if needed)
|
282
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
283
283
|
# HTTP header 'Content-Type'
|
284
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
284
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
285
285
|
if !content_type.nil?
|
286
286
|
header_params['Content-Type'] = content_type
|
287
287
|
end
|
@@ -319,13 +319,14 @@ module KlaviyoAPI
|
|
319
319
|
alias delete_list_relationships_profiles_with_http_info delete_list_relationships_with_http_info
|
320
320
|
|
321
321
|
# Get List
|
322
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=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/v2024-
|
322
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=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/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
|
323
323
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
324
324
|
# @param [Hash] opts the optional parameters
|
325
325
|
# @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: 'profile_count'
|
326
|
-
# @option opts [Array<String>] :
|
327
|
-
# @option opts [Array<String>] :
|
328
|
-
# @option opts [Array<String>] :
|
326
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
327
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
328
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
329
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
329
330
|
# @return [Hash<String, Object>]
|
330
331
|
def get_list(id, opts = {})
|
331
332
|
data, _status_code, _headers = get_list_with_http_info(id, opts)
|
@@ -333,13 +334,14 @@ module KlaviyoAPI
|
|
333
334
|
end
|
334
335
|
|
335
336
|
# Get List
|
336
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=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/v2024-
|
337
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=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/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
|
337
338
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
338
339
|
# @param [Hash] opts the optional parameters
|
339
340
|
# @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: 'profile_count'
|
340
|
-
# @option opts [Array<String>] :
|
341
|
-
# @option opts [Array<String>] :
|
342
|
-
# @option opts [Array<String>] :
|
341
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
342
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
343
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
344
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
343
345
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
344
346
|
def get_list_with_http_info(id, opts = {})
|
345
347
|
if @api_client.config.debugging
|
@@ -353,6 +355,10 @@ module KlaviyoAPI
|
|
353
355
|
if @api_client.config.client_side_validation && opts[:'additional_fields_list'] && !opts[:'additional_fields_list'].all? { |item| allowable_values.include?(item) }
|
354
356
|
fail ArgumentError, "invalid value for \"additional_fields_list\", must include one of #{allowable_values}"
|
355
357
|
end
|
358
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
359
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
360
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
361
|
+
end
|
356
362
|
allowable_values = ["name", "created", "updated", "opt_in_process", "profile_count"]
|
357
363
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
358
364
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
@@ -361,16 +367,17 @@ module KlaviyoAPI
|
|
361
367
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
362
368
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
363
369
|
end
|
364
|
-
allowable_values = ["tags"]
|
370
|
+
allowable_values = ["flow-triggers", "tags"]
|
365
371
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
366
372
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
367
373
|
end
|
368
374
|
# resource path
|
369
|
-
local_var_path = '/api/lists/{id}
|
375
|
+
local_var_path = '/api/lists/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
370
376
|
|
371
377
|
# query parameters
|
372
378
|
query_params = opts[:query_params] || {}
|
373
379
|
query_params[:'additional-fields[list]'] = @api_client.build_collection_param(opts[:'additional_fields_list'], :csv) if !opts[:'additional_fields_list'].nil?
|
380
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
374
381
|
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
375
382
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
376
383
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
@@ -378,9 +385,9 @@ module KlaviyoAPI
|
|
378
385
|
# header parameters
|
379
386
|
header_params = opts[:header_params] || {}
|
380
387
|
# klaviyo api revision
|
381
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
388
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
382
389
|
# HTTP header 'Accept' (if needed)
|
383
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
390
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
384
391
|
|
385
392
|
# form parameters
|
386
393
|
form_params = opts[:form_params] || {}
|
@@ -411,79 +418,48 @@ module KlaviyoAPI
|
|
411
418
|
return data, status_code, headers
|
412
419
|
end
|
413
420
|
|
414
|
-
# Get List
|
415
|
-
# Get all
|
416
|
-
# @param id [String]
|
421
|
+
# Get List Flow Triggers
|
422
|
+
# Get all flows where the given lsit ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `lists:read`
|
423
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
417
424
|
# @param [Hash] opts the optional parameters
|
418
|
-
# @option opts [Array<String>] :
|
419
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
420
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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`
|
421
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
422
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
423
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
425
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
424
426
|
# @return [Hash<String, Object>]
|
425
|
-
def
|
426
|
-
data, _status_code, _headers =
|
427
|
+
def get_list_flow_triggers(id, opts = {})
|
428
|
+
data, _status_code, _headers = get_list_flow_triggers_with_http_info(id, opts)
|
427
429
|
data
|
428
430
|
end
|
429
431
|
|
430
|
-
# Get List
|
431
|
-
# Get all
|
432
|
-
# @param id [String]
|
432
|
+
# Get List Flow Triggers
|
433
|
+
# Get all flows where the given lsit ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `lists:read`
|
434
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
433
435
|
# @param [Hash] opts the optional parameters
|
434
|
-
# @option opts [Array<String>] :
|
435
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
436
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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`
|
437
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
438
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
439
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
436
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
440
437
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
441
|
-
def
|
438
|
+
def get_list_flow_triggers_with_http_info(id, opts = {})
|
442
439
|
if @api_client.config.debugging
|
443
|
-
@api_client.config.logger.debug 'Calling API: ListsApi.
|
440
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_flow_triggers ...'
|
444
441
|
end
|
445
442
|
# verify the required parameter 'id' is set
|
446
443
|
if @api_client.config.client_side_validation && id.nil?
|
447
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.
|
448
|
-
end
|
449
|
-
allowable_values = ["subscriptions", "predictive_analytics"]
|
450
|
-
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
451
|
-
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
452
|
-
end
|
453
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
454
|
-
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
455
|
-
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
456
|
-
end
|
457
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
458
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be smaller than or equal to 100.'
|
459
|
-
end
|
460
|
-
|
461
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
462
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be greater than or equal to 1.'
|
444
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_flow_triggers"
|
463
445
|
end
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
446
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
447
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
448
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
468
449
|
end
|
469
450
|
# resource path
|
470
|
-
local_var_path = '/api/lists/{id}/
|
451
|
+
local_var_path = '/api/lists/{id}/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
471
452
|
|
472
453
|
# query parameters
|
473
454
|
query_params = opts[:query_params] || {}
|
474
|
-
query_params[:'
|
475
|
-
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
476
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
477
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
478
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
479
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
455
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
480
456
|
|
481
457
|
# header parameters
|
482
458
|
header_params = opts[:header_params] || {}
|
483
459
|
# klaviyo api revision
|
484
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
460
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
485
461
|
# HTTP header 'Accept' (if needed)
|
486
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
462
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
487
463
|
|
488
464
|
# form parameters
|
489
465
|
form_params = opts[:form_params] || {}
|
@@ -498,7 +474,7 @@ module KlaviyoAPI
|
|
498
474
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
499
475
|
|
500
476
|
new_options = opts.merge(
|
501
|
-
:operation => :"ListsApi.
|
477
|
+
:operation => :"ListsApi.get_list_flow_triggers",
|
502
478
|
:header_params => header_params,
|
503
479
|
:query_params => query_params,
|
504
480
|
:form_params => form_params,
|
@@ -509,48 +485,60 @@ module KlaviyoAPI
|
|
509
485
|
|
510
486
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
511
487
|
if @api_client.config.debugging
|
512
|
-
@api_client.config.logger.debug "API called: ListsApi#
|
488
|
+
@api_client.config.logger.debug "API called: ListsApi#get_list_flow_triggers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
513
489
|
end
|
514
490
|
return data, status_code, headers
|
515
491
|
end
|
516
492
|
|
517
|
-
# Get List
|
518
|
-
# Get
|
519
|
-
# @param id [String]
|
493
|
+
# Get List Profiles
|
494
|
+
# Get all profiles within a list with the given list 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`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
495
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
520
496
|
# @param [Hash] opts the optional parameters
|
521
|
-
# @option opts [String] :
|
522
|
-
# @option opts [String] :
|
523
|
-
# @option opts [
|
524
|
-
# @option opts [String] :
|
497
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
498
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
499
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
500
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
501
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
502
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
525
503
|
# @return [Hash<String, Object>]
|
526
|
-
def
|
527
|
-
data, _status_code, _headers =
|
504
|
+
def get_list_profiles(id, opts = {})
|
505
|
+
data, _status_code, _headers = get_list_profiles_with_http_info(id, opts)
|
528
506
|
data
|
529
507
|
end
|
530
508
|
|
531
|
-
# Get List
|
532
|
-
# Get
|
533
|
-
# @param id [String]
|
509
|
+
# Get List Profiles
|
510
|
+
# Get all profiles within a list with the given list 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`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
511
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
534
512
|
# @param [Hash] opts the optional parameters
|
535
|
-
# @option opts [String] :
|
536
|
-
# @option opts [String] :
|
537
|
-
# @option opts [
|
538
|
-
# @option opts [String] :
|
513
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
514
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
515
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
516
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
517
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
518
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
539
519
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
540
|
-
def
|
520
|
+
def get_list_profiles_with_http_info(id, opts = {})
|
541
521
|
if @api_client.config.debugging
|
542
|
-
@api_client.config.logger.debug 'Calling API: ListsApi.
|
522
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_profiles ...'
|
543
523
|
end
|
544
524
|
# verify the required parameter 'id' is set
|
545
525
|
if @api_client.config.client_side_validation && id.nil?
|
546
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.
|
526
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_profiles"
|
547
527
|
end
|
548
|
-
|
549
|
-
|
528
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
529
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
530
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
531
|
+
end
|
532
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
533
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
534
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
535
|
+
end
|
536
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
537
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be smaller than or equal to 100.'
|
550
538
|
end
|
551
539
|
|
552
540
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
553
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.
|
541
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_list_profiles, must be greater than or equal to 1.'
|
554
542
|
end
|
555
543
|
|
556
544
|
allowable_values = ["joined_group_at", "-joined_group_at"]
|
@@ -558,10 +546,12 @@ module KlaviyoAPI
|
|
558
546
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
559
547
|
end
|
560
548
|
# resource path
|
561
|
-
local_var_path = '/api/lists/{id}/
|
549
|
+
local_var_path = '/api/lists/{id}/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
562
550
|
|
563
551
|
# query parameters
|
564
552
|
query_params = opts[:query_params] || {}
|
553
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
554
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
565
555
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
566
556
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
567
557
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
@@ -570,9 +560,9 @@ module KlaviyoAPI
|
|
570
560
|
# header parameters
|
571
561
|
header_params = opts[:header_params] || {}
|
572
562
|
# klaviyo api revision
|
573
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
563
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
574
564
|
# HTTP header 'Accept' (if needed)
|
575
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
565
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
576
566
|
|
577
567
|
# form parameters
|
578
568
|
form_params = opts[:form_params] || {}
|
@@ -587,7 +577,7 @@ module KlaviyoAPI
|
|
587
577
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
588
578
|
|
589
579
|
new_options = opts.merge(
|
590
|
-
:operation => :"ListsApi.
|
580
|
+
:operation => :"ListsApi.get_list_profiles",
|
591
581
|
:header_params => header_params,
|
592
582
|
:query_params => query_params,
|
593
583
|
:form_params => form_params,
|
@@ -598,36 +588,36 @@ module KlaviyoAPI
|
|
598
588
|
|
599
589
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
600
590
|
if @api_client.config.debugging
|
601
|
-
@api_client.config.logger.debug "API called: ListsApi#
|
591
|
+
@api_client.config.logger.debug "API called: ListsApi#get_list_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
602
592
|
end
|
603
593
|
return data, status_code, headers
|
604
594
|
end
|
605
595
|
|
606
|
-
# Get List Relationships
|
607
|
-
#
|
608
|
-
# @param id [String]
|
596
|
+
# Get List Relationships Flow Triggers
|
597
|
+
# Get all flow [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) where the given list is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `lists:read`
|
598
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
609
599
|
# @param [Hash] opts the optional parameters
|
610
600
|
# @return [Hash<String, Object>]
|
611
|
-
def
|
612
|
-
data, _status_code, _headers =
|
601
|
+
def get_list_relationships_flow_triggers(id, opts = {})
|
602
|
+
data, _status_code, _headers = get_list_relationships_flow_triggers_with_http_info(id, opts)
|
613
603
|
data
|
614
604
|
end
|
615
605
|
|
616
|
-
# Get List Relationships
|
617
|
-
#
|
618
|
-
# @param id [String]
|
606
|
+
# Get List Relationships Flow Triggers
|
607
|
+
# Get all flow [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) where the given list is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `lists:read`
|
608
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
619
609
|
# @param [Hash] opts the optional parameters
|
620
610
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
621
|
-
def
|
611
|
+
def get_list_relationships_flow_triggers_with_http_info(id, opts = {})
|
622
612
|
if @api_client.config.debugging
|
623
|
-
@api_client.config.logger.debug 'Calling API: ListsApi.
|
613
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_list_relationships_flow_triggers ...'
|
624
614
|
end
|
625
615
|
# verify the required parameter 'id' is set
|
626
616
|
if @api_client.config.client_side_validation && id.nil?
|
627
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.
|
617
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list_relationships_flow_triggers"
|
628
618
|
end
|
629
619
|
# resource path
|
630
|
-
local_var_path = '/api/lists/{id}/relationships/
|
620
|
+
local_var_path = '/api/lists/{id}/relationships/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
631
621
|
|
632
622
|
# query parameters
|
633
623
|
query_params = opts[:query_params] || {}
|
@@ -635,9 +625,9 @@ module KlaviyoAPI
|
|
635
625
|
# header parameters
|
636
626
|
header_params = opts[:header_params] || {}
|
637
627
|
# klaviyo api revision
|
638
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
628
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
639
629
|
# HTTP header 'Accept' (if needed)
|
640
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
630
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
641
631
|
|
642
632
|
# form parameters
|
643
633
|
form_params = opts[:form_params] || {}
|
@@ -652,7 +642,7 @@ module KlaviyoAPI
|
|
652
642
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
653
643
|
|
654
644
|
new_options = opts.merge(
|
655
|
-
:operation => :"ListsApi.
|
645
|
+
:operation => :"ListsApi.get_list_relationships_flow_triggers",
|
656
646
|
:header_params => header_params,
|
657
647
|
:query_params => query_params,
|
658
648
|
:form_params => form_params,
|
@@ -663,16 +653,16 @@ module KlaviyoAPI
|
|
663
653
|
|
664
654
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
665
655
|
if @api_client.config.debugging
|
666
|
-
@api_client.config.logger.debug "API called: ListsApi#
|
656
|
+
@api_client.config.logger.debug "API called: ListsApi#get_list_relationships_flow_triggers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
667
657
|
end
|
668
658
|
return data, status_code, headers
|
669
659
|
end
|
670
660
|
|
671
661
|
# Get List Tags
|
672
662
|
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
673
|
-
# @param id [String]
|
663
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
674
664
|
# @param [Hash] opts the optional parameters
|
675
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-
|
665
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
676
666
|
# @return [Hash<String, Object>]
|
677
667
|
def get_list_tags(id, opts = {})
|
678
668
|
data, _status_code, _headers = get_list_tags_with_http_info(id, opts)
|
@@ -681,9 +671,9 @@ module KlaviyoAPI
|
|
681
671
|
|
682
672
|
# Get List Tags
|
683
673
|
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
684
|
-
# @param id [String]
|
674
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
685
675
|
# @param [Hash] opts the optional parameters
|
686
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-
|
676
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
687
677
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
688
678
|
def get_list_tags_with_http_info(id, opts = {})
|
689
679
|
if @api_client.config.debugging
|
@@ -698,7 +688,7 @@ module KlaviyoAPI
|
|
698
688
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
699
689
|
end
|
700
690
|
# resource path
|
701
|
-
local_var_path = '/api/lists/{id}/tags
|
691
|
+
local_var_path = '/api/lists/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
702
692
|
|
703
693
|
# query parameters
|
704
694
|
query_params = opts[:query_params] || {}
|
@@ -707,9 +697,9 @@ module KlaviyoAPI
|
|
707
697
|
# header parameters
|
708
698
|
header_params = opts[:header_params] || {}
|
709
699
|
# klaviyo api revision
|
710
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
700
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
711
701
|
# HTTP header 'Accept' (if needed)
|
712
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
702
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
713
703
|
|
714
704
|
# form parameters
|
715
705
|
form_params = opts[:form_params] || {}
|
@@ -743,12 +733,13 @@ module KlaviyoAPI
|
|
743
733
|
# Get Lists
|
744
734
|
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `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:** `lists:read`
|
745
735
|
# @param [Hash] opts the optional parameters
|
746
|
-
# @option opts [Array<String>] :
|
747
|
-
# @option opts [Array<String>] :
|
748
|
-
# @option opts [String] :
|
749
|
-
# @option opts [
|
750
|
-
# @option opts [String] :
|
751
|
-
# @option opts [String] :
|
736
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
737
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
738
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
739
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
740
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
741
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
742
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
752
743
|
# @return [Hash<String, Object>]
|
753
744
|
def get_lists(opts = {})
|
754
745
|
data, _status_code, _headers = get_lists_with_http_info(opts)
|
@@ -758,17 +749,22 @@ module KlaviyoAPI
|
|
758
749
|
# Get Lists
|
759
750
|
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `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:** `lists:read`
|
760
751
|
# @param [Hash] opts the optional parameters
|
761
|
-
# @option opts [Array<String>] :
|
762
|
-
# @option opts [Array<String>] :
|
763
|
-
# @option opts [String] :
|
764
|
-
# @option opts [
|
765
|
-
# @option opts [String] :
|
766
|
-
# @option opts [String] :
|
752
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
753
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
754
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
755
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
756
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
757
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
758
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
767
759
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
768
760
|
def get_lists_with_http_info(opts = {})
|
769
761
|
if @api_client.config.debugging
|
770
762
|
@api_client.config.logger.debug 'Calling API: ListsApi.get_lists ...'
|
771
763
|
end
|
764
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
765
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
766
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
767
|
+
end
|
772
768
|
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
773
769
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
774
770
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
@@ -777,7 +773,7 @@ module KlaviyoAPI
|
|
777
773
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
778
774
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
779
775
|
end
|
780
|
-
allowable_values = ["tags"]
|
776
|
+
allowable_values = ["flow-triggers", "tags"]
|
781
777
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
782
778
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
783
779
|
end
|
@@ -786,10 +782,11 @@ module KlaviyoAPI
|
|
786
782
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
787
783
|
end
|
788
784
|
# resource path
|
789
|
-
local_var_path = '/api/lists
|
785
|
+
local_var_path = '/api/lists'
|
790
786
|
|
791
787
|
# query parameters
|
792
788
|
query_params = opts[:query_params] || {}
|
789
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
793
790
|
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
794
791
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
795
792
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
@@ -800,9 +797,9 @@ module KlaviyoAPI
|
|
800
797
|
# header parameters
|
801
798
|
header_params = opts[:header_params] || {}
|
802
799
|
# klaviyo api revision
|
803
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
800
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
804
801
|
# HTTP header 'Accept' (if needed)
|
805
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
802
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
806
803
|
|
807
804
|
# form parameters
|
808
805
|
form_params = opts[:form_params] || {}
|
@@ -833,6 +830,172 @@ module KlaviyoAPI
|
|
833
830
|
return data, status_code, headers
|
834
831
|
end
|
835
832
|
|
833
|
+
# Get Profile IDs for List
|
834
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` `profiles:read`
|
835
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
836
|
+
# @param [Hash] opts the optional parameters
|
837
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
838
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
839
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
|
840
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
841
|
+
# @return [Hash<String, Object>]
|
842
|
+
def get_profile_ids_for_list(id, opts = {})
|
843
|
+
data, _status_code, _headers = get_profile_ids_for_list_with_http_info(id, opts)
|
844
|
+
data
|
845
|
+
end
|
846
|
+
|
847
|
+
# alias of `get_profile_ids_for_list`
|
848
|
+
alias get_list_relationships_profiles get_profile_ids_for_list
|
849
|
+
|
850
|
+
# Get Profile IDs for List
|
851
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` `profiles:read`
|
852
|
+
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
853
|
+
# @param [Hash] opts the optional parameters
|
854
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
855
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
856
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
|
857
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
858
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
859
|
+
def get_profile_ids_for_list_with_http_info(id, opts = {})
|
860
|
+
if @api_client.config.debugging
|
861
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_profile_ids_for_list ...'
|
862
|
+
end
|
863
|
+
# verify the required parameter 'id' is set
|
864
|
+
if @api_client.config.client_side_validation && id.nil?
|
865
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_profile_ids_for_list"
|
866
|
+
end
|
867
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
868
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_profile_ids_for_list, must be smaller than or equal to 1000.'
|
869
|
+
end
|
870
|
+
|
871
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
872
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ListsApi.get_profile_ids_for_list, must be greater than or equal to 1.'
|
873
|
+
end
|
874
|
+
|
875
|
+
allowable_values = ["joined_group_at", "-joined_group_at"]
|
876
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
877
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
878
|
+
end
|
879
|
+
# resource path
|
880
|
+
local_var_path = '/api/lists/{id}/relationships/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
881
|
+
|
882
|
+
# query parameters
|
883
|
+
query_params = opts[:query_params] || {}
|
884
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
885
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
886
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
887
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
888
|
+
|
889
|
+
# header parameters
|
890
|
+
header_params = opts[:header_params] || {}
|
891
|
+
# klaviyo api revision
|
892
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
893
|
+
# HTTP header 'Accept' (if needed)
|
894
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
895
|
+
|
896
|
+
# form parameters
|
897
|
+
form_params = opts[:form_params] || {}
|
898
|
+
|
899
|
+
# http body (model)
|
900
|
+
post_body = opts[:debug_body]
|
901
|
+
|
902
|
+
# return_type
|
903
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
904
|
+
|
905
|
+
# auth_names
|
906
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
907
|
+
|
908
|
+
new_options = opts.merge(
|
909
|
+
:operation => :"ListsApi.get_profile_ids_for_list",
|
910
|
+
:header_params => header_params,
|
911
|
+
:query_params => query_params,
|
912
|
+
:form_params => form_params,
|
913
|
+
:body => post_body,
|
914
|
+
:auth_names => auth_names,
|
915
|
+
:return_type => return_type
|
916
|
+
)
|
917
|
+
|
918
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
919
|
+
if @api_client.config.debugging
|
920
|
+
@api_client.config.logger.debug "API called: ListsApi#get_profile_ids_for_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
921
|
+
end
|
922
|
+
return data, status_code, headers
|
923
|
+
end
|
924
|
+
|
925
|
+
# alias of `get_profile_ids_for_list_with_http_info`
|
926
|
+
alias get_list_relationships_profiles_with_http_info get_profile_ids_for_list_with_http_info
|
927
|
+
|
928
|
+
# Get Tag IDs for List
|
929
|
+
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
930
|
+
# @param id [String]
|
931
|
+
# @param [Hash] opts the optional parameters
|
932
|
+
# @return [Hash<String, Object>]
|
933
|
+
def get_tag_ids_for_list(id, opts = {})
|
934
|
+
data, _status_code, _headers = get_tag_ids_for_list_with_http_info(id, opts)
|
935
|
+
data
|
936
|
+
end
|
937
|
+
|
938
|
+
# alias of `get_tag_ids_for_list`
|
939
|
+
alias get_list_relationships_tags get_tag_ids_for_list
|
940
|
+
|
941
|
+
# Get Tag IDs for List
|
942
|
+
# Returns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
943
|
+
# @param id [String]
|
944
|
+
# @param [Hash] opts the optional parameters
|
945
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
946
|
+
def get_tag_ids_for_list_with_http_info(id, opts = {})
|
947
|
+
if @api_client.config.debugging
|
948
|
+
@api_client.config.logger.debug 'Calling API: ListsApi.get_tag_ids_for_list ...'
|
949
|
+
end
|
950
|
+
# verify the required parameter 'id' is set
|
951
|
+
if @api_client.config.client_side_validation && id.nil?
|
952
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_tag_ids_for_list"
|
953
|
+
end
|
954
|
+
# resource path
|
955
|
+
local_var_path = '/api/lists/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
956
|
+
|
957
|
+
# query parameters
|
958
|
+
query_params = opts[:query_params] || {}
|
959
|
+
|
960
|
+
# header parameters
|
961
|
+
header_params = opts[:header_params] || {}
|
962
|
+
# klaviyo api revision
|
963
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
964
|
+
# HTTP header 'Accept' (if needed)
|
965
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
966
|
+
|
967
|
+
# form parameters
|
968
|
+
form_params = opts[:form_params] || {}
|
969
|
+
|
970
|
+
# http body (model)
|
971
|
+
post_body = opts[:debug_body]
|
972
|
+
|
973
|
+
# return_type
|
974
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
975
|
+
|
976
|
+
# auth_names
|
977
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
978
|
+
|
979
|
+
new_options = opts.merge(
|
980
|
+
:operation => :"ListsApi.get_tag_ids_for_list",
|
981
|
+
:header_params => header_params,
|
982
|
+
:query_params => query_params,
|
983
|
+
:form_params => form_params,
|
984
|
+
:body => post_body,
|
985
|
+
:auth_names => auth_names,
|
986
|
+
:return_type => return_type
|
987
|
+
)
|
988
|
+
|
989
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
990
|
+
if @api_client.config.debugging
|
991
|
+
@api_client.config.logger.debug "API called: ListsApi#get_tag_ids_for_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
992
|
+
end
|
993
|
+
return data, status_code, headers
|
994
|
+
end
|
995
|
+
|
996
|
+
# alias of `get_tag_ids_for_list_with_http_info`
|
997
|
+
alias get_list_relationships_tags_with_http_info get_tag_ids_for_list_with_http_info
|
998
|
+
|
836
999
|
# Update List
|
837
1000
|
# Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`
|
838
1001
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
@@ -863,7 +1026,7 @@ module KlaviyoAPI
|
|
863
1026
|
fail ArgumentError, "Missing the required parameter 'list_partial_update_query' when calling ListsApi.update_list"
|
864
1027
|
end
|
865
1028
|
# resource path
|
866
|
-
local_var_path = '/api/lists/{id}
|
1029
|
+
local_var_path = '/api/lists/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
867
1030
|
|
868
1031
|
# query parameters
|
869
1032
|
query_params = opts[:query_params] || {}
|
@@ -871,11 +1034,11 @@ module KlaviyoAPI
|
|
871
1034
|
# header parameters
|
872
1035
|
header_params = opts[:header_params] || {}
|
873
1036
|
# klaviyo api revision
|
874
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1037
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
875
1038
|
# HTTP header 'Accept' (if needed)
|
876
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1039
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
877
1040
|
# HTTP header 'Content-Type'
|
878
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1041
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
879
1042
|
if !content_type.nil?
|
880
1043
|
header_params['Content-Type'] = content_type
|
881
1044
|
end
|