klaviyo-api-sdk 11.0.0 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -0
- data/README.md +677 -357
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +422 -159
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +405 -307
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +170 -149
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +147 -135
- data/lib/klaviyo-api-sdk/api/flows_api.rb +431 -311
- data/lib/klaviyo-api-sdk/api/forms_api.rb +76 -44
- data/lib/klaviyo-api-sdk/api/images_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/lists_api.rb +416 -362
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -148
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +242 -212
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +63 -21
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +101 -25
- data/lib/klaviyo-api-sdk/api/segments_api.rb +226 -202
- data/lib/klaviyo-api-sdk/api/tags_api.rb +167 -101
- data/lib/klaviyo-api-sdk/api/templates_api.rb +45 -45
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +19 -10
- data/lib/klaviyo-api-sdk/models/ab_test_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{audiences_sub_object.rb → audiences.rb} +9 -5
- data/lib/klaviyo-api-sdk/models/audiences_update.rb +236 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +230 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/branch_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +3 -3
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +11 -42
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_content.rb → campaign_message_create_query_resource_object_attributes_definition.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +9 -29
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +107 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +35 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_item_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/code_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +224 -0
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +1 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +312 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/custom_object_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_content_sub_object.rb → email_content.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +244 -0
- data/lib/klaviyo-api-sdk/models/email_send_options.rb +223 -0
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object.rb → email_tracking_options.rb} +50 -38
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{sto_schedule_options.rb → flow_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +269 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +122 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +111 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +364 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +394 -0
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +386 -0
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +259 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +294 -0
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +224 -0
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_strategy_sub_object.rb → internal_service_action.rb} +46 -33
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/link.rb +220 -0
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → list_update_action_data.rb} +34 -43
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{static_schedule_options.rb → local_static_send.rb} +46 -22
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +328 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +266 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +118 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +247 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options_sub_object.rb → mobile_push_message_standard_definition_update.rb} +40 -23
- data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +243 -0
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object_custom_tracking_params_inner.rb → mobile_push_options_badge.rb} +5 -4
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +105 -0
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +259 -0
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/other_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +349 -0
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +273 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +328 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +8 -3
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +20 -6
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/published_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +224 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +246 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_send_options_sub_object.rb → push_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +235 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +224 -0
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{render_options_sub_object.rb → render_options.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/review_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +109 -0
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +238 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +110 -0
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +224 -0
- data/lib/klaviyo-api-sdk/models/scheduled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/scheduled_trigger.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{sms_content_sub_object_create.rb → sms_content_create.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options_sub_object.rb → sms_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +228 -0
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/split_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/split_links.rb +226 -0
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{throttled_schedule_options.rb → static_send_strategy.rb} +26 -17
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +276 -0
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +288 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +325 -0
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +310 -0
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group_conditions_inner.rb +114 -0
- data/lib/klaviyo-api-sdk/models/union_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +228 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +259 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +273 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +109 -0
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/utm_param.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → utm_param_info.rb} +17 -33
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +2 -2
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +192 -18
- metadata +193 -19
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: 2025-01-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,6 +19,83 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Create Flow
|
23
|
+
# Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `flows:write`
|
24
|
+
# @param flow_create_query [FlowCreateQuery] Creates a Flow from parameters
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
27
|
+
# @return [Hash<String, Object>]
|
28
|
+
def create_flow(flow_create_query, opts = {})
|
29
|
+
data, _status_code, _headers = create_flow_with_http_info(flow_create_query, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Create Flow
|
34
|
+
# Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `flows:write`
|
35
|
+
# @param flow_create_query [FlowCreateQuery] Creates a Flow from parameters
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
38
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
39
|
+
def create_flow_with_http_info(flow_create_query, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.create_flow ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'flow_create_query' is set
|
44
|
+
if @api_client.config.client_side_validation && flow_create_query.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'flow_create_query' when calling FlowsApi.create_flow"
|
46
|
+
end
|
47
|
+
allowable_values = ["definition"]
|
48
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_flow'] && !opts[:'additional_fields_flow'].all? { |item| allowable_values.include?(item) }
|
49
|
+
fail ArgumentError, "invalid value for \"additional_fields_flow\", must include one of #{allowable_values}"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/flows'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
query_params[:'additional-fields[flow]'] = @api_client.build_collection_param(opts[:'additional_fields_flow'], :csv) if !opts[:'additional_fields_flow'].nil?
|
57
|
+
|
58
|
+
# header parameters
|
59
|
+
header_params = opts[:header_params] || {}
|
60
|
+
# klaviyo api revision
|
61
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
62
|
+
# HTTP header 'Accept' (if needed)
|
63
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
64
|
+
# HTTP header 'Content-Type'
|
65
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
66
|
+
if !content_type.nil?
|
67
|
+
header_params['Content-Type'] = content_type
|
68
|
+
end
|
69
|
+
|
70
|
+
# form parameters
|
71
|
+
form_params = opts[:form_params] || {}
|
72
|
+
|
73
|
+
# http body (model)
|
74
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_create_query)
|
75
|
+
|
76
|
+
# return_type
|
77
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
78
|
+
|
79
|
+
# auth_names
|
80
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
81
|
+
|
82
|
+
new_options = opts.merge(
|
83
|
+
:operation => :"FlowsApi.create_flow",
|
84
|
+
:header_params => header_params,
|
85
|
+
:query_params => query_params,
|
86
|
+
:form_params => form_params,
|
87
|
+
:body => post_body,
|
88
|
+
:auth_names => auth_names,
|
89
|
+
:return_type => return_type
|
90
|
+
)
|
91
|
+
|
92
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug "API called: FlowsApi#create_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
95
|
+
end
|
96
|
+
return data, status_code, headers
|
97
|
+
end
|
98
|
+
|
22
99
|
# Delete Flow
|
23
100
|
# Delete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
24
101
|
# @param id [String] ID of the Flow to delete. Ex: XVTP5Q
|
@@ -51,7 +128,7 @@ module KlaviyoAPI
|
|
51
128
|
# header parameters
|
52
129
|
header_params = opts[:header_params] || {}
|
53
130
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
131
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
55
132
|
# HTTP header 'Accept' (if needed)
|
56
133
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
134
|
|
@@ -65,7 +142,7 @@ module KlaviyoAPI
|
|
65
142
|
return_type = opts[:debug_return_type]
|
66
143
|
|
67
144
|
# auth_names
|
68
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
145
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
69
146
|
|
70
147
|
new_options = opts.merge(
|
71
148
|
:operation => :"FlowsApi.delete_flow",
|
@@ -84,6 +161,84 @@ module KlaviyoAPI
|
|
84
161
|
return data, status_code, headers
|
85
162
|
end
|
86
163
|
|
164
|
+
# Get Action for Flow Message
|
165
|
+
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
166
|
+
# @param id [String]
|
167
|
+
# @param [Hash] opts the optional parameters
|
168
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
169
|
+
# @return [Hash<String, Object>]
|
170
|
+
def get_action_for_flow_message(id, opts = {})
|
171
|
+
data, _status_code, _headers = get_action_for_flow_message_with_http_info(id, opts)
|
172
|
+
data
|
173
|
+
end
|
174
|
+
|
175
|
+
# alias of `get_action_for_flow_message`
|
176
|
+
alias get_flow_message_action get_action_for_flow_message
|
177
|
+
|
178
|
+
# Get Action for Flow Message
|
179
|
+
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
180
|
+
# @param id [String]
|
181
|
+
# @param [Hash] opts the optional parameters
|
182
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
183
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
184
|
+
def get_action_for_flow_message_with_http_info(id, opts = {})
|
185
|
+
if @api_client.config.debugging
|
186
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_action_for_flow_message ...'
|
187
|
+
end
|
188
|
+
# verify the required parameter 'id' is set
|
189
|
+
if @api_client.config.client_side_validation && id.nil?
|
190
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_for_flow_message"
|
191
|
+
end
|
192
|
+
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
193
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
194
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
195
|
+
end
|
196
|
+
# resource path
|
197
|
+
local_var_path = '/api/flow-messages/{id}/flow-action'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
198
|
+
|
199
|
+
# query parameters
|
200
|
+
query_params = opts[:query_params] || {}
|
201
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
202
|
+
|
203
|
+
# header parameters
|
204
|
+
header_params = opts[:header_params] || {}
|
205
|
+
# klaviyo api revision
|
206
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
207
|
+
# HTTP header 'Accept' (if needed)
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
209
|
+
|
210
|
+
# form parameters
|
211
|
+
form_params = opts[:form_params] || {}
|
212
|
+
|
213
|
+
# http body (model)
|
214
|
+
post_body = opts[:debug_body]
|
215
|
+
|
216
|
+
# return_type
|
217
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
218
|
+
|
219
|
+
# auth_names
|
220
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
221
|
+
|
222
|
+
new_options = opts.merge(
|
223
|
+
:operation => :"FlowsApi.get_action_for_flow_message",
|
224
|
+
:header_params => header_params,
|
225
|
+
:query_params => query_params,
|
226
|
+
:form_params => form_params,
|
227
|
+
:body => post_body,
|
228
|
+
:auth_names => auth_names,
|
229
|
+
:return_type => return_type
|
230
|
+
)
|
231
|
+
|
232
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
233
|
+
if @api_client.config.debugging
|
234
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_action_for_flow_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
235
|
+
end
|
236
|
+
return data, status_code, headers
|
237
|
+
end
|
238
|
+
|
239
|
+
# alias of `get_action_for_flow_message_with_http_info`
|
240
|
+
alias get_flow_message_action_with_http_info get_action_for_flow_message_with_http_info
|
241
|
+
|
87
242
|
# Get Action ID for Flow Message
|
88
243
|
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
89
244
|
# @param id [String]
|
@@ -119,7 +274,7 @@ module KlaviyoAPI
|
|
119
274
|
# header parameters
|
120
275
|
header_params = opts[:header_params] || {}
|
121
276
|
# klaviyo api revision
|
122
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
277
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
123
278
|
# HTTP header 'Accept' (if needed)
|
124
279
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
125
280
|
|
@@ -133,7 +288,7 @@ module KlaviyoAPI
|
|
133
288
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
134
289
|
|
135
290
|
# auth_names
|
136
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
291
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
137
292
|
|
138
293
|
new_options = opts.merge(
|
139
294
|
:operation => :"FlowsApi.get_action_id_for_flow_message",
|
@@ -156,12 +311,13 @@ module KlaviyoAPI
|
|
156
311
|
alias get_flow_message_relationships_action_with_http_info get_action_id_for_flow_message_with_http_info
|
157
312
|
|
158
313
|
# Get Action IDs for Flow
|
159
|
-
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.
|
160
|
-
# @param id [String]
|
314
|
+
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
315
|
+
# @param id [String]
|
161
316
|
# @param [Hash] opts the optional parameters
|
162
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
163
|
-
# @option opts [
|
164
|
-
# @option opts [
|
317
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
318
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
319
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
320
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
165
321
|
# @return [Hash<String, Object>]
|
166
322
|
def get_action_ids_for_flow(id, opts = {})
|
167
323
|
data, _status_code, _headers = get_action_ids_for_flow_with_http_info(id, opts)
|
@@ -171,13 +327,17 @@ module KlaviyoAPI
|
|
171
327
|
# alias of `get_action_ids_for_flow`
|
172
328
|
alias get_flow_relationships_flow_actions get_action_ids_for_flow
|
173
329
|
|
330
|
+
# alias of `get_action_ids_for_flow`
|
331
|
+
alias get_flow_relationships_actions get_action_ids_for_flow
|
332
|
+
|
174
333
|
# Get Action IDs for Flow
|
175
|
-
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.
|
176
|
-
# @param id [String]
|
334
|
+
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
335
|
+
# @param id [String]
|
177
336
|
# @param [Hash] opts the optional parameters
|
178
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
179
|
-
# @option opts [
|
180
|
-
# @option opts [
|
337
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
338
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
339
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
340
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
181
341
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
182
342
|
def get_action_ids_for_flow_with_http_info(id, opts = {})
|
183
343
|
if @api_client.config.debugging
|
@@ -187,15 +347,15 @@ module KlaviyoAPI
|
|
187
347
|
if @api_client.config.client_side_validation && id.nil?
|
188
348
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_ids_for_flow"
|
189
349
|
end
|
190
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
191
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_action_ids_for_flow, must be smaller than or equal to
|
350
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
351
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_action_ids_for_flow, must be smaller than or equal to 50.'
|
192
352
|
end
|
193
353
|
|
194
354
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
195
355
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_action_ids_for_flow, must be greater than or equal to 1.'
|
196
356
|
end
|
197
357
|
|
198
|
-
allowable_values = ["created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
358
|
+
allowable_values = ["action_type", "-action_type", "created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
199
359
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
200
360
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
201
361
|
end
|
@@ -205,13 +365,14 @@ module KlaviyoAPI
|
|
205
365
|
# query parameters
|
206
366
|
query_params = opts[:query_params] || {}
|
207
367
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
368
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
208
369
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
209
370
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
210
371
|
|
211
372
|
# header parameters
|
212
373
|
header_params = opts[:header_params] || {}
|
213
374
|
# klaviyo api revision
|
214
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
375
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
215
376
|
# HTTP header 'Accept' (if needed)
|
216
377
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
217
378
|
|
@@ -225,7 +386,7 @@ module KlaviyoAPI
|
|
225
386
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
226
387
|
|
227
388
|
# auth_names
|
228
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
389
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
229
390
|
|
230
391
|
new_options = opts.merge(
|
231
392
|
:operation => :"FlowsApi.get_action_ids_for_flow",
|
@@ -247,15 +408,18 @@ module KlaviyoAPI
|
|
247
408
|
# alias of `get_action_ids_for_flow_with_http_info`
|
248
409
|
alias get_flow_relationships_flow_actions_with_http_info get_action_ids_for_flow_with_http_info
|
249
410
|
|
411
|
+
# alias of `get_action_ids_for_flow_with_http_info`
|
412
|
+
alias get_flow_relationships_actions_with_http_info get_action_ids_for_flow_with_http_info
|
413
|
+
|
250
414
|
# Get Actions for Flow
|
251
415
|
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
252
416
|
# @param id [String]
|
253
417
|
# @param [Hash] opts the optional parameters
|
254
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
255
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
256
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
418
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
419
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
420
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
257
421
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
258
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
422
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
259
423
|
# @return [Hash<String, Object>]
|
260
424
|
def get_actions_for_flow(id, opts = {})
|
261
425
|
data, _status_code, _headers = get_actions_for_flow_with_http_info(id, opts)
|
@@ -265,15 +429,18 @@ module KlaviyoAPI
|
|
265
429
|
# alias of `get_actions_for_flow`
|
266
430
|
alias get_flow_flow_actions get_actions_for_flow
|
267
431
|
|
432
|
+
# alias of `get_actions_for_flow`
|
433
|
+
alias get_flow_actions get_actions_for_flow
|
434
|
+
|
268
435
|
# Get Actions for Flow
|
269
436
|
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
270
437
|
# @param id [String]
|
271
438
|
# @param [Hash] opts the optional parameters
|
272
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
273
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
274
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
439
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
440
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
441
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
275
442
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
276
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
443
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
277
444
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
278
445
|
def get_actions_for_flow_with_http_info(id, opts = {})
|
279
446
|
if @api_client.config.debugging
|
@@ -313,7 +480,7 @@ module KlaviyoAPI
|
|
313
480
|
# header parameters
|
314
481
|
header_params = opts[:header_params] || {}
|
315
482
|
# klaviyo api revision
|
316
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
483
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
317
484
|
# HTTP header 'Accept' (if needed)
|
318
485
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
319
486
|
|
@@ -327,7 +494,7 @@ module KlaviyoAPI
|
|
327
494
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
328
495
|
|
329
496
|
# auth_names
|
330
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
497
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
331
498
|
|
332
499
|
new_options = opts.merge(
|
333
500
|
:operation => :"FlowsApi.get_actions_for_flow",
|
@@ -349,14 +516,18 @@ module KlaviyoAPI
|
|
349
516
|
# alias of `get_actions_for_flow_with_http_info`
|
350
517
|
alias get_flow_flow_actions_with_http_info get_actions_for_flow_with_http_info
|
351
518
|
|
519
|
+
# alias of `get_actions_for_flow_with_http_info`
|
520
|
+
alias get_flow_actions_with_http_info get_actions_for_flow_with_http_info
|
521
|
+
|
352
522
|
# Get Flow
|
353
523
|
# Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
354
524
|
# @param id [String]
|
355
525
|
# @param [Hash] opts the optional parameters
|
356
|
-
# @option opts [Array<String>] :
|
357
|
-
# @option opts [Array<String>] :
|
358
|
-
# @option opts [Array<String>] :
|
359
|
-
# @option opts [Array<String>] :
|
526
|
+
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
527
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
528
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
529
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
530
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
360
531
|
# @return [Hash<String, Object>]
|
361
532
|
def get_flow(id, opts = {})
|
362
533
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
@@ -367,10 +538,11 @@ module KlaviyoAPI
|
|
367
538
|
# Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
368
539
|
# @param id [String]
|
369
540
|
# @param [Hash] opts the optional parameters
|
370
|
-
# @option opts [Array<String>] :
|
371
|
-
# @option opts [Array<String>] :
|
372
|
-
# @option opts [Array<String>] :
|
373
|
-
# @option opts [Array<String>] :
|
541
|
+
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
542
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
543
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
544
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
545
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
374
546
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
375
547
|
def get_flow_with_http_info(id, opts = {})
|
376
548
|
if @api_client.config.debugging
|
@@ -380,11 +552,15 @@ module KlaviyoAPI
|
|
380
552
|
if @api_client.config.client_side_validation && id.nil?
|
381
553
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow"
|
382
554
|
end
|
555
|
+
allowable_values = ["definition"]
|
556
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_flow'] && !opts[:'additional_fields_flow'].all? { |item| allowable_values.include?(item) }
|
557
|
+
fail ArgumentError, "invalid value for \"additional_fields_flow\", must include one of #{allowable_values}"
|
558
|
+
end
|
383
559
|
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
384
560
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
385
561
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
386
562
|
end
|
387
|
-
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
563
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type", "definition", "definition.triggers", "definition.profile_filter", "definition.profile_filter.condition_groups", "definition.actions", "definition.entry_action_id"]
|
388
564
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
389
565
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
390
566
|
end
|
@@ -401,6 +577,7 @@ module KlaviyoAPI
|
|
401
577
|
|
402
578
|
# query parameters
|
403
579
|
query_params = opts[:query_params] || {}
|
580
|
+
query_params[:'additional-fields[flow]'] = @api_client.build_collection_param(opts[:'additional_fields_flow'], :csv) if !opts[:'additional_fields_flow'].nil?
|
404
581
|
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
405
582
|
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
406
583
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
@@ -409,7 +586,7 @@ module KlaviyoAPI
|
|
409
586
|
# header parameters
|
410
587
|
header_params = opts[:header_params] || {}
|
411
588
|
# klaviyo api revision
|
412
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
589
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
413
590
|
# HTTP header 'Accept' (if needed)
|
414
591
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
415
592
|
|
@@ -423,7 +600,7 @@ module KlaviyoAPI
|
|
423
600
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
424
601
|
|
425
602
|
# auth_names
|
426
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
603
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
427
604
|
|
428
605
|
new_options = opts.merge(
|
429
606
|
:operation => :"FlowsApi.get_flow",
|
@@ -446,10 +623,10 @@ module KlaviyoAPI
|
|
446
623
|
# Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
447
624
|
# @param id [String]
|
448
625
|
# @param [Hash] opts the optional parameters
|
449
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
450
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/
|
451
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
452
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
626
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
627
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
628
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
629
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
453
630
|
# @return [Hash<String, Object>]
|
454
631
|
def get_flow_action(id, opts = {})
|
455
632
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
@@ -460,10 +637,10 @@ module KlaviyoAPI
|
|
460
637
|
# Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
461
638
|
# @param id [String]
|
462
639
|
# @param [Hash] opts the optional parameters
|
463
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
464
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/
|
465
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
466
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
640
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
641
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
642
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
643
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
467
644
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
468
645
|
def get_flow_action_with_http_info(id, opts = {})
|
469
646
|
if @api_client.config.debugging
|
@@ -502,7 +679,7 @@ module KlaviyoAPI
|
|
502
679
|
# header parameters
|
503
680
|
header_params = opts[:header_params] || {}
|
504
681
|
# klaviyo api revision
|
505
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
682
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
506
683
|
# HTTP header 'Accept' (if needed)
|
507
684
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
508
685
|
|
@@ -516,7 +693,7 @@ module KlaviyoAPI
|
|
516
693
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
517
694
|
|
518
695
|
# auth_names
|
519
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
696
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
520
697
|
|
521
698
|
new_options = opts.merge(
|
522
699
|
:operation => :"FlowsApi.get_flow_action",
|
@@ -535,46 +712,73 @@ module KlaviyoAPI
|
|
535
712
|
return data, status_code, headers
|
536
713
|
end
|
537
714
|
|
538
|
-
# Get
|
539
|
-
# Get
|
715
|
+
# Get Messages For Flow Action
|
716
|
+
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
540
717
|
# @param id [String]
|
541
718
|
# @param [Hash] opts the optional parameters
|
542
|
-
# @option opts [Array<String>] :
|
719
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
720
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
721
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
722
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
723
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
543
724
|
# @return [Hash<String, Object>]
|
544
|
-
def
|
545
|
-
data, _status_code, _headers =
|
725
|
+
def get_flow_action_messages(id, opts = {})
|
726
|
+
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
546
727
|
data
|
547
728
|
end
|
548
729
|
|
549
|
-
#
|
550
|
-
|
730
|
+
# alias of `get_flow_action_messages`
|
731
|
+
alias get_messages_for_flow_action get_flow_action_messages
|
732
|
+
|
733
|
+
# Get Messages For Flow Action
|
734
|
+
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
551
735
|
# @param id [String]
|
552
736
|
# @param [Hash] opts the optional parameters
|
553
|
-
# @option opts [Array<String>] :
|
737
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
738
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
739
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
740
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
741
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
554
742
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
555
|
-
def
|
743
|
+
def get_flow_action_messages_with_http_info(id, opts = {})
|
556
744
|
if @api_client.config.debugging
|
557
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
745
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action_messages ...'
|
558
746
|
end
|
559
747
|
# verify the required parameter 'id' is set
|
560
748
|
if @api_client.config.client_side_validation && id.nil?
|
561
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
749
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_messages"
|
562
750
|
end
|
563
|
-
allowable_values = ["name", "
|
564
|
-
if @api_client.config.client_side_validation && opts[:'
|
565
|
-
fail ArgumentError, "invalid value for \"
|
751
|
+
allowable_values = ["name", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "content.title", "content.sound", "content.badge", "content.dynamic_image", "content.ios_link", "content.android_link", "content.on_open", "created", "updated"]
|
752
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
753
|
+
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
754
|
+
end
|
755
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
756
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be smaller than or equal to 50.'
|
757
|
+
end
|
758
|
+
|
759
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
760
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_messages, must be greater than or equal to 1.'
|
761
|
+
end
|
762
|
+
|
763
|
+
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
764
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
765
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
566
766
|
end
|
567
767
|
# resource path
|
568
|
-
local_var_path = '/api/flow-actions/{id}/flow'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
768
|
+
local_var_path = '/api/flow-actions/{id}/flow-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
569
769
|
|
570
770
|
# query parameters
|
571
771
|
query_params = opts[:query_params] || {}
|
572
|
-
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'
|
772
|
+
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
773
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
774
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
775
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
776
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
573
777
|
|
574
778
|
# header parameters
|
575
779
|
header_params = opts[:header_params] || {}
|
576
780
|
# klaviyo api revision
|
577
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
781
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
578
782
|
# HTTP header 'Accept' (if needed)
|
579
783
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
580
784
|
|
@@ -588,10 +792,10 @@ module KlaviyoAPI
|
|
588
792
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
589
793
|
|
590
794
|
# auth_names
|
591
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
795
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
592
796
|
|
593
797
|
new_options = opts.merge(
|
594
|
-
:operation => :"FlowsApi.
|
798
|
+
:operation => :"FlowsApi.get_flow_action_messages",
|
595
799
|
:header_params => header_params,
|
596
800
|
:query_params => query_params,
|
597
801
|
:form_params => form_params,
|
@@ -602,47 +806,57 @@ module KlaviyoAPI
|
|
602
806
|
|
603
807
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
604
808
|
if @api_client.config.debugging
|
605
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
809
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_action_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
606
810
|
end
|
607
811
|
return data, status_code, headers
|
608
812
|
end
|
609
813
|
|
610
|
-
#
|
814
|
+
# alias of `get_flow_action_messages_with_http_info`
|
815
|
+
alias get_messages_for_flow_action_with_http_info get_flow_action_messages_with_http_info
|
816
|
+
|
817
|
+
# Get Flow for Flow Action
|
611
818
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
612
819
|
# @param id [String]
|
613
820
|
# @param [Hash] opts the optional parameters
|
821
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
614
822
|
# @return [Hash<String, Object>]
|
615
|
-
def
|
616
|
-
data, _status_code, _headers =
|
823
|
+
def get_flow_for_flow_action(id, opts = {})
|
824
|
+
data, _status_code, _headers = get_flow_for_flow_action_with_http_info(id, opts)
|
617
825
|
data
|
618
826
|
end
|
619
827
|
|
620
|
-
# alias of `
|
621
|
-
alias
|
828
|
+
# alias of `get_flow_for_flow_action`
|
829
|
+
alias get_flow_action_flow get_flow_for_flow_action
|
622
830
|
|
623
|
-
# Get Flow
|
831
|
+
# Get Flow for Flow Action
|
624
832
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
625
833
|
# @param id [String]
|
626
834
|
# @param [Hash] opts the optional parameters
|
835
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
627
836
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
628
|
-
def
|
837
|
+
def get_flow_for_flow_action_with_http_info(id, opts = {})
|
629
838
|
if @api_client.config.debugging
|
630
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
839
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_for_flow_action ...'
|
631
840
|
end
|
632
841
|
# verify the required parameter 'id' is set
|
633
842
|
if @api_client.config.client_side_validation && id.nil?
|
634
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
843
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_for_flow_action"
|
844
|
+
end
|
845
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
846
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
847
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
635
848
|
end
|
636
849
|
# resource path
|
637
|
-
local_var_path = '/api/flow-actions/{id}/
|
850
|
+
local_var_path = '/api/flow-actions/{id}/flow'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
638
851
|
|
639
852
|
# query parameters
|
640
853
|
query_params = opts[:query_params] || {}
|
854
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
641
855
|
|
642
856
|
# header parameters
|
643
857
|
header_params = opts[:header_params] || {}
|
644
858
|
# klaviyo api revision
|
645
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
859
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
646
860
|
# HTTP header 'Accept' (if needed)
|
647
861
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
648
862
|
|
@@ -656,10 +870,10 @@ module KlaviyoAPI
|
|
656
870
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
657
871
|
|
658
872
|
# auth_names
|
659
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
873
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
660
874
|
|
661
875
|
new_options = opts.merge(
|
662
|
-
:operation => :"FlowsApi.
|
876
|
+
:operation => :"FlowsApi.get_flow_for_flow_action",
|
663
877
|
:header_params => header_params,
|
664
878
|
:query_params => query_params,
|
665
879
|
:form_params => form_params,
|
@@ -670,75 +884,50 @@ module KlaviyoAPI
|
|
670
884
|
|
671
885
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
672
886
|
if @api_client.config.debugging
|
673
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
887
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_for_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
674
888
|
end
|
675
889
|
return data, status_code, headers
|
676
890
|
end
|
677
891
|
|
678
|
-
# alias of `
|
679
|
-
alias
|
892
|
+
# alias of `get_flow_for_flow_action_with_http_info`
|
893
|
+
alias get_flow_action_flow_with_http_info get_flow_for_flow_action_with_http_info
|
680
894
|
|
681
|
-
# Get Flow
|
682
|
-
# Get the flow
|
895
|
+
# Get Flow ID for Flow Action
|
896
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
683
897
|
# @param id [String]
|
684
898
|
# @param [Hash] opts the optional parameters
|
685
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
686
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
687
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
688
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
689
899
|
# @return [Hash<String, Object>]
|
690
|
-
def
|
691
|
-
data, _status_code, _headers =
|
900
|
+
def get_flow_id_for_flow_action(id, opts = {})
|
901
|
+
data, _status_code, _headers = get_flow_id_for_flow_action_with_http_info(id, opts)
|
692
902
|
data
|
693
903
|
end
|
694
904
|
|
695
|
-
#
|
696
|
-
|
905
|
+
# alias of `get_flow_id_for_flow_action`
|
906
|
+
alias get_flow_action_relationships_flow get_flow_id_for_flow_action
|
907
|
+
|
908
|
+
# Get Flow ID for Flow Action
|
909
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
697
910
|
# @param id [String]
|
698
911
|
# @param [Hash] opts the optional parameters
|
699
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
700
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
701
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
702
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
703
912
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
704
|
-
def
|
913
|
+
def get_flow_id_for_flow_action_with_http_info(id, opts = {})
|
705
914
|
if @api_client.config.debugging
|
706
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
915
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_id_for_flow_action ...'
|
707
916
|
end
|
708
917
|
# verify the required parameter 'id' is set
|
709
918
|
if @api_client.config.client_side_validation && id.nil?
|
710
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
711
|
-
end
|
712
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
713
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
714
|
-
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
715
|
-
end
|
716
|
-
allowable_values = ["name", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "content.title", "content.sound", "content.badge", "content.dynamic_image", "content.ios_link", "content.android_link", "content.on_open", "created", "updated"]
|
717
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
718
|
-
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
719
|
-
end
|
720
|
-
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
721
|
-
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
722
|
-
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
723
|
-
end
|
724
|
-
allowable_values = ["flow-action", "template"]
|
725
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
726
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
919
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_id_for_flow_action"
|
727
920
|
end
|
728
921
|
# resource path
|
729
|
-
local_var_path = '/api/flow-
|
922
|
+
local_var_path = '/api/flow-actions/{id}/relationships/flow'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
730
923
|
|
731
924
|
# query parameters
|
732
925
|
query_params = opts[:query_params] || {}
|
733
|
-
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
734
|
-
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
735
|
-
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
736
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
737
926
|
|
738
927
|
# header parameters
|
739
928
|
header_params = opts[:header_params] || {}
|
740
929
|
# klaviyo api revision
|
741
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
930
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
742
931
|
# HTTP header 'Accept' (if needed)
|
743
932
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
744
933
|
|
@@ -752,10 +941,10 @@ module KlaviyoAPI
|
|
752
941
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
753
942
|
|
754
943
|
# auth_names
|
755
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
944
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
756
945
|
|
757
946
|
new_options = opts.merge(
|
758
|
-
:operation => :"FlowsApi.
|
947
|
+
:operation => :"FlowsApi.get_flow_id_for_flow_action",
|
759
948
|
:header_params => header_params,
|
760
949
|
:query_params => query_params,
|
761
950
|
:form_params => form_params,
|
@@ -766,123 +955,75 @@ module KlaviyoAPI
|
|
766
955
|
|
767
956
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
768
957
|
if @api_client.config.debugging
|
769
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
958
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_id_for_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
770
959
|
end
|
771
960
|
return data, status_code, headers
|
772
961
|
end
|
773
962
|
|
774
|
-
#
|
775
|
-
|
963
|
+
# alias of `get_flow_id_for_flow_action_with_http_info`
|
964
|
+
alias get_flow_action_relationships_flow_with_http_info get_flow_id_for_flow_action_with_http_info
|
965
|
+
|
966
|
+
# Get Flow Message
|
967
|
+
# Get the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
776
968
|
# @param id [String]
|
777
969
|
# @param [Hash] opts the optional parameters
|
778
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
970
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
971
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
972
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
973
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
779
974
|
# @return [Hash<String, Object>]
|
780
|
-
def
|
781
|
-
data, _status_code, _headers =
|
975
|
+
def get_flow_message(id, opts = {})
|
976
|
+
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
782
977
|
data
|
783
978
|
end
|
784
979
|
|
785
|
-
# Get Flow
|
786
|
-
# Get the flow
|
980
|
+
# Get Flow Message
|
981
|
+
# Get the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
787
982
|
# @param id [String]
|
788
983
|
# @param [Hash] opts the optional parameters
|
789
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
984
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
985
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
986
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
987
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
790
988
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
791
|
-
def
|
989
|
+
def get_flow_message_with_http_info(id, opts = {})
|
792
990
|
if @api_client.config.debugging
|
793
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
991
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_message ...'
|
794
992
|
end
|
795
993
|
# verify the required parameter 'id' is set
|
796
994
|
if @api_client.config.client_side_validation && id.nil?
|
797
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
995
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message"
|
798
996
|
end
|
799
997
|
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_options", "send_options.use_smart_sending", "send_options.is_transactional", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language"]
|
800
998
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
801
999
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
802
1000
|
end
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
# query parameters
|
807
|
-
query_params = opts[:query_params] || {}
|
808
|
-
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
809
|
-
|
810
|
-
# header parameters
|
811
|
-
header_params = opts[:header_params] || {}
|
812
|
-
# klaviyo api revision
|
813
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
814
|
-
# HTTP header 'Accept' (if needed)
|
815
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
816
|
-
|
817
|
-
# form parameters
|
818
|
-
form_params = opts[:form_params] || {}
|
819
|
-
|
820
|
-
# http body (model)
|
821
|
-
post_body = opts[:debug_body]
|
822
|
-
|
823
|
-
# return_type
|
824
|
-
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
825
|
-
|
826
|
-
# auth_names
|
827
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
828
|
-
|
829
|
-
new_options = opts.merge(
|
830
|
-
:operation => :"FlowsApi.get_flow_message_action",
|
831
|
-
:header_params => header_params,
|
832
|
-
:query_params => query_params,
|
833
|
-
:form_params => form_params,
|
834
|
-
:body => post_body,
|
835
|
-
:auth_names => auth_names,
|
836
|
-
:return_type => return_type
|
837
|
-
)
|
838
|
-
|
839
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
840
|
-
if @api_client.config.debugging
|
841
|
-
@api_client.config.logger.debug "API called: FlowsApi#get_flow_message_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
842
|
-
end
|
843
|
-
return data, status_code, headers
|
844
|
-
end
|
845
|
-
|
846
|
-
# Get Flow Tags
|
847
|
-
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
848
|
-
# @param id [String]
|
849
|
-
# @param [Hash] opts the optional parameters
|
850
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
851
|
-
# @return [Hash<String, Object>]
|
852
|
-
def get_flow_tags(id, opts = {})
|
853
|
-
data, _status_code, _headers = get_flow_tags_with_http_info(id, opts)
|
854
|
-
data
|
855
|
-
end
|
856
|
-
|
857
|
-
# Get Flow Tags
|
858
|
-
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
859
|
-
# @param id [String]
|
860
|
-
# @param [Hash] opts the optional parameters
|
861
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
862
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
863
|
-
def get_flow_tags_with_http_info(id, opts = {})
|
864
|
-
if @api_client.config.debugging
|
865
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_tags ...'
|
1001
|
+
allowable_values = ["name", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "content.title", "content.sound", "content.badge", "content.dynamic_image", "content.ios_link", "content.android_link", "content.on_open", "created", "updated"]
|
1002
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
1003
|
+
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
866
1004
|
end
|
867
|
-
|
868
|
-
if @api_client.config.client_side_validation &&
|
869
|
-
fail ArgumentError, "
|
1005
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
1006
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
1007
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
870
1008
|
end
|
871
|
-
allowable_values = ["
|
872
|
-
if @api_client.config.client_side_validation && opts[:'
|
873
|
-
fail ArgumentError, "invalid value for \"
|
1009
|
+
allowable_values = ["flow-action", "template"]
|
1010
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1011
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
874
1012
|
end
|
875
1013
|
# resource path
|
876
|
-
local_var_path = '/api/
|
1014
|
+
local_var_path = '/api/flow-messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
877
1015
|
|
878
1016
|
# query parameters
|
879
1017
|
query_params = opts[:query_params] || {}
|
880
|
-
query_params[:'fields[
|
1018
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
1019
|
+
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
1020
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
1021
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
881
1022
|
|
882
1023
|
# header parameters
|
883
1024
|
header_params = opts[:header_params] || {}
|
884
1025
|
# klaviyo api revision
|
885
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1026
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
886
1027
|
# HTTP header 'Accept' (if needed)
|
887
1028
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
888
1029
|
|
@@ -896,10 +1037,10 @@ module KlaviyoAPI
|
|
896
1037
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
897
1038
|
|
898
1039
|
# auth_names
|
899
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1040
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
900
1041
|
|
901
1042
|
new_options = opts.merge(
|
902
|
-
:operation => :"FlowsApi.
|
1043
|
+
:operation => :"FlowsApi.get_flow_message",
|
903
1044
|
:header_params => header_params,
|
904
1045
|
:query_params => query_params,
|
905
1046
|
:form_params => form_params,
|
@@ -910,7 +1051,7 @@ module KlaviyoAPI
|
|
910
1051
|
|
911
1052
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
912
1053
|
if @api_client.config.debugging
|
913
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1054
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
914
1055
|
end
|
915
1056
|
return data, status_code, headers
|
916
1057
|
end
|
@@ -918,14 +1059,14 @@ module KlaviyoAPI
|
|
918
1059
|
# Get Flows
|
919
1060
|
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
920
1061
|
# @param [Hash] opts the optional parameters
|
921
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
922
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
923
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
924
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
925
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
926
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1062
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1063
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1064
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1065
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
1066
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1067
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
927
1068
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
928
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1069
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
929
1070
|
# @return [Hash<String, Object>]
|
930
1071
|
def get_flows(opts = {})
|
931
1072
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
@@ -935,14 +1076,14 @@ module KlaviyoAPI
|
|
935
1076
|
# Get Flows
|
936
1077
|
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
937
1078
|
# @param [Hash] opts the optional parameters
|
938
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/
|
939
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/
|
940
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
941
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
942
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
943
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1079
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1080
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1081
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1082
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
1083
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1084
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
944
1085
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
945
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1086
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
946
1087
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
947
1088
|
def get_flows_with_http_info(opts = {})
|
948
1089
|
if @api_client.config.debugging
|
@@ -993,7 +1134,7 @@ module KlaviyoAPI
|
|
993
1134
|
# header parameters
|
994
1135
|
header_params = opts[:header_params] || {}
|
995
1136
|
# klaviyo api revision
|
996
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1137
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
997
1138
|
# HTTP header 'Accept' (if needed)
|
998
1139
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
999
1140
|
|
@@ -1007,7 +1148,7 @@ module KlaviyoAPI
|
|
1007
1148
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1008
1149
|
|
1009
1150
|
# auth_names
|
1010
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1151
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1011
1152
|
|
1012
1153
|
new_options = opts.merge(
|
1013
1154
|
:operation => :"FlowsApi.get_flows",
|
@@ -1030,10 +1171,10 @@ module KlaviyoAPI
|
|
1030
1171
|
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1031
1172
|
# @param id [String]
|
1032
1173
|
# @param [Hash] opts the optional parameters
|
1033
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1034
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1174
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1175
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1035
1176
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1036
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1177
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1037
1178
|
# @return [Hash<String, Object>]
|
1038
1179
|
def get_message_ids_for_flow_action(id, opts = {})
|
1039
1180
|
data, _status_code, _headers = get_message_ids_for_flow_action_with_http_info(id, opts)
|
@@ -1047,10 +1188,10 @@ module KlaviyoAPI
|
|
1047
1188
|
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1048
1189
|
# @param id [String]
|
1049
1190
|
# @param [Hash] opts the optional parameters
|
1050
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/
|
1051
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/
|
1191
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1192
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1052
1193
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1053
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/
|
1194
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1054
1195
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1055
1196
|
def get_message_ids_for_flow_action_with_http_info(id, opts = {})
|
1056
1197
|
if @api_client.config.debugging
|
@@ -1085,7 +1226,7 @@ module KlaviyoAPI
|
|
1085
1226
|
# header parameters
|
1086
1227
|
header_params = opts[:header_params] || {}
|
1087
1228
|
# klaviyo api revision
|
1088
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1229
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1089
1230
|
# HTTP header 'Accept' (if needed)
|
1090
1231
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1091
1232
|
|
@@ -1099,7 +1240,7 @@ module KlaviyoAPI
|
|
1099
1240
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1100
1241
|
|
1101
1242
|
# auth_names
|
1102
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1243
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1103
1244
|
|
1104
1245
|
new_options = opts.merge(
|
1105
1246
|
:operation => :"FlowsApi.get_message_ids_for_flow_action",
|
@@ -1121,70 +1262,42 @@ module KlaviyoAPI
|
|
1121
1262
|
# alias of `get_message_ids_for_flow_action_with_http_info`
|
1122
1263
|
alias get_flow_action_relationships_messages_with_http_info get_message_ids_for_flow_action_with_http_info
|
1123
1264
|
|
1124
|
-
# Get
|
1125
|
-
#
|
1265
|
+
# Get Tag IDs for Flow
|
1266
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1126
1267
|
# @param id [String]
|
1127
1268
|
# @param [Hash] opts the optional parameters
|
1128
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1129
|
-
# @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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1130
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
1131
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1132
1269
|
# @return [Hash<String, Object>]
|
1133
|
-
def
|
1134
|
-
data, _status_code, _headers =
|
1270
|
+
def get_tag_ids_for_flow(id, opts = {})
|
1271
|
+
data, _status_code, _headers = get_tag_ids_for_flow_with_http_info(id, opts)
|
1135
1272
|
data
|
1136
1273
|
end
|
1137
1274
|
|
1138
|
-
# alias of `
|
1139
|
-
alias
|
1275
|
+
# alias of `get_tag_ids_for_flow`
|
1276
|
+
alias get_flow_relationships_tags get_tag_ids_for_flow
|
1140
1277
|
|
1141
|
-
# Get
|
1142
|
-
#
|
1278
|
+
# Get Tag IDs for Flow
|
1279
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1143
1280
|
# @param id [String]
|
1144
1281
|
# @param [Hash] opts the optional parameters
|
1145
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1146
|
-
# @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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1147
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
1148
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1149
1282
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1150
|
-
def
|
1283
|
+
def get_tag_ids_for_flow_with_http_info(id, opts = {})
|
1151
1284
|
if @api_client.config.debugging
|
1152
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1285
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_tag_ids_for_flow ...'
|
1153
1286
|
end
|
1154
1287
|
# verify the required parameter 'id' is set
|
1155
1288
|
if @api_client.config.client_side_validation && id.nil?
|
1156
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
1157
|
-
end
|
1158
|
-
allowable_values = ["name", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "content.title", "content.sound", "content.badge", "content.dynamic_image", "content.ios_link", "content.android_link", "content.on_open", "created", "updated"]
|
1159
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
1160
|
-
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
1161
|
-
end
|
1162
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
1163
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_messages_for_flow_action, must be smaller than or equal to 100.'
|
1164
|
-
end
|
1165
|
-
|
1166
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1167
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_messages_for_flow_action, must be greater than or equal to 1.'
|
1168
|
-
end
|
1169
|
-
|
1170
|
-
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
1171
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1172
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1289
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_tag_ids_for_flow"
|
1173
1290
|
end
|
1174
1291
|
# resource path
|
1175
|
-
local_var_path = '/api/
|
1292
|
+
local_var_path = '/api/flows/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1176
1293
|
|
1177
1294
|
# query parameters
|
1178
1295
|
query_params = opts[:query_params] || {}
|
1179
|
-
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
1180
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1181
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1182
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1183
1296
|
|
1184
1297
|
# header parameters
|
1185
1298
|
header_params = opts[:header_params] || {}
|
1186
1299
|
# klaviyo api revision
|
1187
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1300
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1188
1301
|
# HTTP header 'Accept' (if needed)
|
1189
1302
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1190
1303
|
|
@@ -1198,10 +1311,10 @@ module KlaviyoAPI
|
|
1198
1311
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1199
1312
|
|
1200
1313
|
# auth_names
|
1201
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1314
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1202
1315
|
|
1203
1316
|
new_options = opts.merge(
|
1204
|
-
:operation => :"FlowsApi.
|
1317
|
+
:operation => :"FlowsApi.get_tag_ids_for_flow",
|
1205
1318
|
:header_params => header_params,
|
1206
1319
|
:query_params => query_params,
|
1207
1320
|
:form_params => form_params,
|
@@ -1212,50 +1325,57 @@ module KlaviyoAPI
|
|
1212
1325
|
|
1213
1326
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1214
1327
|
if @api_client.config.debugging
|
1215
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1328
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_tag_ids_for_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1216
1329
|
end
|
1217
1330
|
return data, status_code, headers
|
1218
1331
|
end
|
1219
1332
|
|
1220
|
-
# alias of `
|
1221
|
-
alias
|
1333
|
+
# alias of `get_tag_ids_for_flow_with_http_info`
|
1334
|
+
alias get_flow_relationships_tags_with_http_info get_tag_ids_for_flow_with_http_info
|
1222
1335
|
|
1223
|
-
# Get
|
1224
|
-
# Return
|
1336
|
+
# Get Tags for Flow
|
1337
|
+
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1225
1338
|
# @param id [String]
|
1226
1339
|
# @param [Hash] opts the optional parameters
|
1340
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1227
1341
|
# @return [Hash<String, Object>]
|
1228
|
-
def
|
1229
|
-
data, _status_code, _headers =
|
1342
|
+
def get_tags_for_flow(id, opts = {})
|
1343
|
+
data, _status_code, _headers = get_tags_for_flow_with_http_info(id, opts)
|
1230
1344
|
data
|
1231
1345
|
end
|
1232
1346
|
|
1233
|
-
# alias of `
|
1234
|
-
alias
|
1347
|
+
# alias of `get_tags_for_flow`
|
1348
|
+
alias get_flow_tags get_tags_for_flow
|
1235
1349
|
|
1236
|
-
# Get
|
1237
|
-
# Return
|
1350
|
+
# Get Tags for Flow
|
1351
|
+
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1238
1352
|
# @param id [String]
|
1239
1353
|
# @param [Hash] opts the optional parameters
|
1354
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1240
1355
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1241
|
-
def
|
1356
|
+
def get_tags_for_flow_with_http_info(id, opts = {})
|
1242
1357
|
if @api_client.config.debugging
|
1243
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1358
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_tags_for_flow ...'
|
1244
1359
|
end
|
1245
1360
|
# verify the required parameter 'id' is set
|
1246
1361
|
if @api_client.config.client_side_validation && id.nil?
|
1247
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
1362
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_tags_for_flow"
|
1363
|
+
end
|
1364
|
+
allowable_values = ["name"]
|
1365
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1366
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1248
1367
|
end
|
1249
1368
|
# resource path
|
1250
|
-
local_var_path = '/api/flows/{id}/
|
1369
|
+
local_var_path = '/api/flows/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1251
1370
|
|
1252
1371
|
# query parameters
|
1253
1372
|
query_params = opts[:query_params] || {}
|
1373
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1254
1374
|
|
1255
1375
|
# header parameters
|
1256
1376
|
header_params = opts[:header_params] || {}
|
1257
1377
|
# klaviyo api revision
|
1258
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1378
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1259
1379
|
# HTTP header 'Accept' (if needed)
|
1260
1380
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1261
1381
|
|
@@ -1269,10 +1389,10 @@ module KlaviyoAPI
|
|
1269
1389
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1270
1390
|
|
1271
1391
|
# auth_names
|
1272
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1392
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1273
1393
|
|
1274
1394
|
new_options = opts.merge(
|
1275
|
-
:operation => :"FlowsApi.
|
1395
|
+
:operation => :"FlowsApi.get_tags_for_flow",
|
1276
1396
|
:header_params => header_params,
|
1277
1397
|
:query_params => query_params,
|
1278
1398
|
:form_params => form_params,
|
@@ -1283,19 +1403,19 @@ module KlaviyoAPI
|
|
1283
1403
|
|
1284
1404
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1285
1405
|
if @api_client.config.debugging
|
1286
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1406
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_tags_for_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1287
1407
|
end
|
1288
1408
|
return data, status_code, headers
|
1289
1409
|
end
|
1290
1410
|
|
1291
|
-
# alias of `
|
1292
|
-
alias
|
1411
|
+
# alias of `get_tags_for_flow_with_http_info`
|
1412
|
+
alias get_flow_tags_with_http_info get_tags_for_flow_with_http_info
|
1293
1413
|
|
1294
1414
|
# Get Template for Flow Message
|
1295
1415
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1296
1416
|
# @param id [String]
|
1297
1417
|
# @param [Hash] opts the optional parameters
|
1298
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/
|
1418
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1299
1419
|
# @return [Hash<String, Object>]
|
1300
1420
|
def get_template_for_flow_message(id, opts = {})
|
1301
1421
|
data, _status_code, _headers = get_template_for_flow_message_with_http_info(id, opts)
|
@@ -1309,7 +1429,7 @@ module KlaviyoAPI
|
|
1309
1429
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1310
1430
|
# @param id [String]
|
1311
1431
|
# @param [Hash] opts the optional parameters
|
1312
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/
|
1432
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1313
1433
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1314
1434
|
def get_template_for_flow_message_with_http_info(id, opts = {})
|
1315
1435
|
if @api_client.config.debugging
|
@@ -1333,7 +1453,7 @@ module KlaviyoAPI
|
|
1333
1453
|
# header parameters
|
1334
1454
|
header_params = opts[:header_params] || {}
|
1335
1455
|
# klaviyo api revision
|
1336
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1456
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1337
1457
|
# HTTP header 'Accept' (if needed)
|
1338
1458
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1339
1459
|
|
@@ -1347,7 +1467,7 @@ module KlaviyoAPI
|
|
1347
1467
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1348
1468
|
|
1349
1469
|
# auth_names
|
1350
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1470
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1351
1471
|
|
1352
1472
|
new_options = opts.merge(
|
1353
1473
|
:operation => :"FlowsApi.get_template_for_flow_message",
|
@@ -1404,7 +1524,7 @@ module KlaviyoAPI
|
|
1404
1524
|
# header parameters
|
1405
1525
|
header_params = opts[:header_params] || {}
|
1406
1526
|
# klaviyo api revision
|
1407
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1527
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1408
1528
|
# HTTP header 'Accept' (if needed)
|
1409
1529
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1410
1530
|
|
@@ -1418,7 +1538,7 @@ module KlaviyoAPI
|
|
1418
1538
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1419
1539
|
|
1420
1540
|
# auth_names
|
1421
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1541
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1422
1542
|
|
1423
1543
|
new_options = opts.merge(
|
1424
1544
|
:operation => :"FlowsApi.get_template_id_for_flow_message",
|
@@ -1478,7 +1598,7 @@ module KlaviyoAPI
|
|
1478
1598
|
# header parameters
|
1479
1599
|
header_params = opts[:header_params] || {}
|
1480
1600
|
# klaviyo api revision
|
1481
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1601
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1482
1602
|
# HTTP header 'Accept' (if needed)
|
1483
1603
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1484
1604
|
# HTTP header 'Content-Type'
|
@@ -1497,7 +1617,7 @@ module KlaviyoAPI
|
|
1497
1617
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1498
1618
|
|
1499
1619
|
# auth_names
|
1500
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1620
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1501
1621
|
|
1502
1622
|
new_options = opts.merge(
|
1503
1623
|
:operation => :"FlowsApi.update_flow",
|