klaviyo-api-sdk 8.0.0 → 10.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 +289 -0
- data/README.md +1414 -402
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1764 -1446
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +329 -281
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +11 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +140 -122
- data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
- data/lib/klaviyo-api-sdk/api/forms_api.rb +80 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +40 -28
- data/lib/klaviyo-api-sdk/api/lists_api.rb +328 -153
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +590 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +1054 -548
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +341 -19
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
- data/lib/klaviyo-api-sdk/api/tags_api.rb +745 -625
- data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +274 -0
- data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +245 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +3 -3
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +248 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +2 -7
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -3
- metadata +64 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2024-
|
6
|
+
The version of the OpenAPI document: 2024-10-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -43,7 +43,7 @@ module KlaviyoAPI
|
|
43
43
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.delete_flow"
|
44
44
|
end
|
45
45
|
# resource path
|
46
|
-
local_var_path = '/api/flows/{id}
|
46
|
+
local_var_path = '/api/flows/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
47
47
|
|
48
48
|
# query parameters
|
49
49
|
query_params = opts[:query_params] || {}
|
@@ -51,9 +51,9 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
54
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
57
|
|
58
58
|
# form parameters
|
59
59
|
form_params = opts[:form_params] || {}
|
@@ -84,69 +84,44 @@ module KlaviyoAPI
|
|
84
84
|
return data, status_code, headers
|
85
85
|
end
|
86
86
|
|
87
|
-
# Get Flow
|
88
|
-
# Get a flow
|
87
|
+
# Get Action ID for Flow Message
|
88
|
+
# 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
89
|
# @param id [String]
|
90
90
|
# @param [Hash] opts the optional parameters
|
91
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
92
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
93
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
94
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
95
91
|
# @return [Hash<String, Object>]
|
96
|
-
def
|
97
|
-
data, _status_code, _headers =
|
92
|
+
def get_action_id_for_flow_message(id, opts = {})
|
93
|
+
data, _status_code, _headers = get_action_id_for_flow_message_with_http_info(id, opts)
|
98
94
|
data
|
99
95
|
end
|
100
96
|
|
101
|
-
#
|
102
|
-
|
97
|
+
# alias of `get_action_id_for_flow_message`
|
98
|
+
alias get_flow_message_relationships_action get_action_id_for_flow_message
|
99
|
+
|
100
|
+
# Get Action ID for Flow Message
|
101
|
+
# 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`
|
103
102
|
# @param id [String]
|
104
103
|
# @param [Hash] opts the optional parameters
|
105
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
106
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
107
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
108
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
109
104
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
110
|
-
def
|
105
|
+
def get_action_id_for_flow_message_with_http_info(id, opts = {})
|
111
106
|
if @api_client.config.debugging
|
112
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
107
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_action_id_for_flow_message ...'
|
113
108
|
end
|
114
109
|
# verify the required parameter 'id' is set
|
115
110
|
if @api_client.config.client_side_validation && id.nil?
|
116
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
117
|
-
end
|
118
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "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"]
|
119
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
120
|
-
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
121
|
-
end
|
122
|
-
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
123
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
124
|
-
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
125
|
-
end
|
126
|
-
allowable_values = ["name"]
|
127
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
128
|
-
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
129
|
-
end
|
130
|
-
allowable_values = ["flow-actions", "tags"]
|
131
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
132
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
111
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_id_for_flow_message"
|
133
112
|
end
|
134
113
|
# resource path
|
135
|
-
local_var_path = '/api/
|
114
|
+
local_var_path = '/api/flow-messages/{id}/relationships/flow-action'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
136
115
|
|
137
116
|
# query parameters
|
138
117
|
query_params = opts[:query_params] || {}
|
139
|
-
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
140
|
-
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
141
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
142
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
143
118
|
|
144
119
|
# header parameters
|
145
120
|
header_params = opts[:header_params] || {}
|
146
121
|
# klaviyo api revision
|
147
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
122
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
148
123
|
# HTTP header 'Accept' (if needed)
|
149
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
150
125
|
|
151
126
|
# form parameters
|
152
127
|
form_params = opts[:form_params] || {}
|
@@ -161,7 +136,7 @@ module KlaviyoAPI
|
|
161
136
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
162
137
|
|
163
138
|
new_options = opts.merge(
|
164
|
-
:operation => :"FlowsApi.
|
139
|
+
:operation => :"FlowsApi.get_action_id_for_flow_message",
|
165
140
|
:header_params => header_params,
|
166
141
|
:query_params => query_params,
|
167
142
|
:form_params => form_params,
|
@@ -172,74 +147,73 @@ module KlaviyoAPI
|
|
172
147
|
|
173
148
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
174
149
|
if @api_client.config.debugging
|
175
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
150
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_action_id_for_flow_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
176
151
|
end
|
177
152
|
return data, status_code, headers
|
178
153
|
end
|
179
154
|
|
180
|
-
#
|
181
|
-
|
182
|
-
|
155
|
+
# alias of `get_action_id_for_flow_message_with_http_info`
|
156
|
+
alias get_flow_message_relationships_action_with_http_info get_action_id_for_flow_message_with_http_info
|
157
|
+
|
158
|
+
# 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. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
160
|
+
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
183
161
|
# @param [Hash] opts the optional parameters
|
184
|
-
# @option opts [
|
185
|
-
# @option opts [
|
186
|
-
# @option opts [
|
187
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
162
|
+
# @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>`action_type`: `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`
|
163
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
164
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
188
165
|
# @return [Hash<String, Object>]
|
189
|
-
def
|
190
|
-
data, _status_code, _headers =
|
166
|
+
def get_action_ids_for_flow(id, opts = {})
|
167
|
+
data, _status_code, _headers = get_action_ids_for_flow_with_http_info(id, opts)
|
191
168
|
data
|
192
169
|
end
|
193
170
|
|
194
|
-
#
|
195
|
-
|
196
|
-
|
171
|
+
# alias of `get_action_ids_for_flow`
|
172
|
+
alias get_flow_relationships_flow_actions get_action_ids_for_flow
|
173
|
+
|
174
|
+
# 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. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
176
|
+
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
197
177
|
# @param [Hash] opts the optional parameters
|
198
|
-
# @option opts [
|
199
|
-
# @option opts [
|
200
|
-
# @option opts [
|
201
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
178
|
+
# @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>`action_type`: `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`
|
179
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
180
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
202
181
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
203
|
-
def
|
182
|
+
def get_action_ids_for_flow_with_http_info(id, opts = {})
|
204
183
|
if @api_client.config.debugging
|
205
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
184
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_action_ids_for_flow ...'
|
206
185
|
end
|
207
186
|
# verify the required parameter 'id' is set
|
208
187
|
if @api_client.config.client_side_validation && id.nil?
|
209
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
210
|
-
end
|
211
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "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"]
|
212
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
213
|
-
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
188
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_ids_for_flow"
|
214
189
|
end
|
215
|
-
|
216
|
-
|
217
|
-
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
190
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
191
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_action_ids_for_flow, must be smaller than or equal to 100.'
|
218
192
|
end
|
219
|
-
|
220
|
-
if @api_client.config.client_side_validation && opts[:'
|
221
|
-
fail ArgumentError,
|
193
|
+
|
194
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
195
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_action_ids_for_flow, must be greater than or equal to 1.'
|
222
196
|
end
|
223
|
-
|
224
|
-
|
225
|
-
|
197
|
+
|
198
|
+
allowable_values = ["created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
199
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
200
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
226
201
|
end
|
227
202
|
# resource path
|
228
|
-
local_var_path = '/api/
|
203
|
+
local_var_path = '/api/flows/{id}/relationships/flow-actions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
229
204
|
|
230
205
|
# query parameters
|
231
206
|
query_params = opts[:query_params] || {}
|
232
|
-
query_params[:'
|
233
|
-
query_params[:'
|
234
|
-
query_params[:'
|
235
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
207
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
208
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
209
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
236
210
|
|
237
211
|
# header parameters
|
238
212
|
header_params = opts[:header_params] || {}
|
239
213
|
# klaviyo api revision
|
240
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
214
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
241
215
|
# HTTP header 'Accept' (if needed)
|
242
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
216
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
243
217
|
|
244
218
|
# form parameters
|
245
219
|
form_params = opts[:form_params] || {}
|
@@ -254,7 +228,7 @@ module KlaviyoAPI
|
|
254
228
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
255
229
|
|
256
230
|
new_options = opts.merge(
|
257
|
-
:operation => :"FlowsApi.
|
231
|
+
:operation => :"FlowsApi.get_action_ids_for_flow",
|
258
232
|
:header_params => header_params,
|
259
233
|
:query_params => query_params,
|
260
234
|
:form_params => form_params,
|
@@ -265,53 +239,83 @@ module KlaviyoAPI
|
|
265
239
|
|
266
240
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
267
241
|
if @api_client.config.debugging
|
268
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
242
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_action_ids_for_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
269
243
|
end
|
270
244
|
return data, status_code, headers
|
271
245
|
end
|
272
246
|
|
273
|
-
#
|
274
|
-
|
247
|
+
# alias of `get_action_ids_for_flow_with_http_info`
|
248
|
+
alias get_flow_relationships_flow_actions_with_http_info get_action_ids_for_flow_with_http_info
|
249
|
+
|
250
|
+
# Get Actions for Flow
|
251
|
+
# 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`
|
275
252
|
# @param id [String]
|
276
253
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @option opts [Array<String>] :
|
254
|
+
# @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
|
255
|
+
# @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>`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`
|
256
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
257
|
+
# @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/v2024-10-15/reference/api-overview#sorting
|
278
259
|
# @return [Hash<String, Object>]
|
279
|
-
def
|
280
|
-
data, _status_code, _headers =
|
260
|
+
def get_actions_for_flow(id, opts = {})
|
261
|
+
data, _status_code, _headers = get_actions_for_flow_with_http_info(id, opts)
|
281
262
|
data
|
282
263
|
end
|
283
264
|
|
284
|
-
#
|
285
|
-
|
265
|
+
# alias of `get_actions_for_flow`
|
266
|
+
alias get_flow_flow_actions get_actions_for_flow
|
267
|
+
|
268
|
+
# Get Actions for Flow
|
269
|
+
# 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`
|
286
270
|
# @param id [String]
|
287
271
|
# @param [Hash] opts the optional parameters
|
288
|
-
# @option opts [Array<String>] :
|
272
|
+
# @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
|
273
|
+
# @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>`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`
|
274
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
275
|
+
# @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/v2024-10-15/reference/api-overview#sorting
|
289
277
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
290
|
-
def
|
278
|
+
def get_actions_for_flow_with_http_info(id, opts = {})
|
291
279
|
if @api_client.config.debugging
|
292
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
280
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_actions_for_flow ...'
|
293
281
|
end
|
294
282
|
# verify the required parameter 'id' is set
|
295
283
|
if @api_client.config.client_side_validation && id.nil?
|
296
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
284
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_actions_for_flow"
|
297
285
|
end
|
298
|
-
allowable_values = ["
|
299
|
-
if @api_client.config.client_side_validation && opts[:'
|
300
|
-
fail ArgumentError, "invalid value for \"
|
286
|
+
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"]
|
287
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
288
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
289
|
+
end
|
290
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
291
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_actions_for_flow, must be smaller than or equal to 50.'
|
292
|
+
end
|
293
|
+
|
294
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
295
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_actions_for_flow, must be greater than or equal to 1.'
|
296
|
+
end
|
297
|
+
|
298
|
+
allowable_values = ["action_type", "-action_type", "created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
299
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
300
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
301
301
|
end
|
302
302
|
# resource path
|
303
|
-
local_var_path = '/api/
|
303
|
+
local_var_path = '/api/flows/{id}/flow-actions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
304
304
|
|
305
305
|
# query parameters
|
306
306
|
query_params = opts[:query_params] || {}
|
307
|
-
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'
|
307
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
308
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
309
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
310
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
311
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
308
312
|
|
309
313
|
# header parameters
|
310
314
|
header_params = opts[:header_params] || {}
|
311
315
|
# klaviyo api revision
|
312
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
316
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
313
317
|
# HTTP header 'Accept' (if needed)
|
314
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
318
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
315
319
|
|
316
320
|
# form parameters
|
317
321
|
form_params = opts[:form_params] || {}
|
@@ -326,7 +330,7 @@ module KlaviyoAPI
|
|
326
330
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
327
331
|
|
328
332
|
new_options = opts.merge(
|
329
|
-
:operation => :"FlowsApi.
|
333
|
+
:operation => :"FlowsApi.get_actions_for_flow",
|
330
334
|
:header_params => header_params,
|
331
335
|
:query_params => query_params,
|
332
336
|
:form_params => form_params,
|
@@ -337,74 +341,77 @@ module KlaviyoAPI
|
|
337
341
|
|
338
342
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
339
343
|
if @api_client.config.debugging
|
340
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
344
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_actions_for_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
341
345
|
end
|
342
346
|
return data, status_code, headers
|
343
347
|
end
|
344
348
|
|
345
|
-
#
|
346
|
-
|
349
|
+
# alias of `get_actions_for_flow_with_http_info`
|
350
|
+
alias get_flow_flow_actions_with_http_info get_actions_for_flow_with_http_info
|
351
|
+
|
352
|
+
# Get Flow
|
353
|
+
# Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
347
354
|
# @param id [String]
|
348
355
|
# @param [Hash] opts the optional parameters
|
349
|
-
# @option opts [Array<String>] :
|
350
|
-
# @option opts [String] :
|
351
|
-
# @option opts [
|
352
|
-
# @option opts [String] :
|
356
|
+
# @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
|
357
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
358
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
359
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
353
360
|
# @return [Hash<String, Object>]
|
354
|
-
def
|
355
|
-
data, _status_code, _headers =
|
361
|
+
def get_flow(id, opts = {})
|
362
|
+
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
356
363
|
data
|
357
364
|
end
|
358
365
|
|
359
|
-
# Get Flow
|
360
|
-
# Get
|
366
|
+
# Get Flow
|
367
|
+
# Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
361
368
|
# @param id [String]
|
362
369
|
# @param [Hash] opts the optional parameters
|
363
|
-
# @option opts [Array<String>] :
|
364
|
-
# @option opts [String] :
|
365
|
-
# @option opts [
|
366
|
-
# @option opts [String] :
|
370
|
+
# @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
|
371
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
372
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
373
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
367
374
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
368
|
-
def
|
375
|
+
def get_flow_with_http_info(id, opts = {})
|
369
376
|
if @api_client.config.debugging
|
370
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
377
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow ...'
|
371
378
|
end
|
372
379
|
# verify the required parameter 'id' is set
|
373
380
|
if @api_client.config.client_side_validation && id.nil?
|
374
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
381
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow"
|
375
382
|
end
|
376
|
-
allowable_values = ["
|
377
|
-
if @api_client.config.client_side_validation && opts[:'
|
378
|
-
fail ArgumentError, "invalid value for \"
|
383
|
+
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
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
385
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
379
386
|
end
|
380
|
-
|
381
|
-
|
387
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
388
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
389
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
382
390
|
end
|
383
|
-
|
384
|
-
if @api_client.config.client_side_validation &&
|
385
|
-
fail ArgumentError,
|
391
|
+
allowable_values = ["name"]
|
392
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
393
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
386
394
|
end
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
395
|
+
allowable_values = ["flow-actions", "tags"]
|
396
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
397
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
391
398
|
end
|
392
399
|
# resource path
|
393
|
-
local_var_path = '/api/
|
400
|
+
local_var_path = '/api/flows/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
394
401
|
|
395
402
|
# query parameters
|
396
403
|
query_params = opts[:query_params] || {}
|
397
|
-
query_params[:'fields[flow-
|
398
|
-
query_params[:'
|
399
|
-
query_params[:'
|
400
|
-
query_params[:'
|
404
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
405
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
406
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
407
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
401
408
|
|
402
409
|
# header parameters
|
403
410
|
header_params = opts[:header_params] || {}
|
404
411
|
# klaviyo api revision
|
405
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
412
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
406
413
|
# HTTP header 'Accept' (if needed)
|
407
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
414
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
408
415
|
|
409
416
|
# form parameters
|
410
417
|
form_params = opts[:form_params] || {}
|
@@ -419,7 +426,7 @@ module KlaviyoAPI
|
|
419
426
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
420
427
|
|
421
428
|
new_options = opts.merge(
|
422
|
-
:operation => :"FlowsApi.
|
429
|
+
:operation => :"FlowsApi.get_flow",
|
423
430
|
:header_params => header_params,
|
424
431
|
:query_params => query_params,
|
425
432
|
:form_params => form_params,
|
@@ -430,46 +437,74 @@ module KlaviyoAPI
|
|
430
437
|
|
431
438
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
432
439
|
if @api_client.config.debugging
|
433
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
440
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
434
441
|
end
|
435
442
|
return data, status_code, headers
|
436
443
|
end
|
437
444
|
|
438
|
-
# Get Flow Action
|
439
|
-
# Get
|
445
|
+
# Get Flow Action
|
446
|
+
# 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`
|
440
447
|
# @param id [String]
|
441
448
|
# @param [Hash] opts the optional parameters
|
449
|
+
# @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
|
450
|
+
# @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
|
451
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
452
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
442
453
|
# @return [Hash<String, Object>]
|
443
|
-
def
|
444
|
-
data, _status_code, _headers =
|
454
|
+
def get_flow_action(id, opts = {})
|
455
|
+
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
445
456
|
data
|
446
457
|
end
|
447
458
|
|
448
|
-
# Get Flow Action
|
449
|
-
# Get
|
459
|
+
# Get Flow Action
|
460
|
+
# 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`
|
450
461
|
# @param id [String]
|
451
462
|
# @param [Hash] opts the optional parameters
|
463
|
+
# @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
|
464
|
+
# @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
|
465
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
466
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
452
467
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
453
|
-
def
|
468
|
+
def get_flow_action_with_http_info(id, opts = {})
|
454
469
|
if @api_client.config.debugging
|
455
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
470
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action ...'
|
456
471
|
end
|
457
472
|
# verify the required parameter 'id' is set
|
458
473
|
if @api_client.config.client_side_validation && id.nil?
|
459
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
474
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action"
|
475
|
+
end
|
476
|
+
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"]
|
477
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
478
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
479
|
+
end
|
480
|
+
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"]
|
481
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
482
|
+
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
483
|
+
end
|
484
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
485
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
486
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
487
|
+
end
|
488
|
+
allowable_values = ["flow", "flow-messages"]
|
489
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
490
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
460
491
|
end
|
461
492
|
# resource path
|
462
|
-
local_var_path = '/api/flow-actions/{id}
|
493
|
+
local_var_path = '/api/flow-actions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
463
494
|
|
464
495
|
# query parameters
|
465
496
|
query_params = opts[:query_params] || {}
|
497
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
498
|
+
query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
|
499
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
500
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
466
501
|
|
467
502
|
# header parameters
|
468
503
|
header_params = opts[:header_params] || {}
|
469
504
|
# klaviyo api revision
|
470
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
505
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
471
506
|
# HTTP header 'Accept' (if needed)
|
472
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
507
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
473
508
|
|
474
509
|
# form parameters
|
475
510
|
form_params = opts[:form_params] || {}
|
@@ -484,7 +519,7 @@ module KlaviyoAPI
|
|
484
519
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
485
520
|
|
486
521
|
new_options = opts.merge(
|
487
|
-
:operation => :"FlowsApi.
|
522
|
+
:operation => :"FlowsApi.get_flow_action",
|
488
523
|
:header_params => header_params,
|
489
524
|
:query_params => query_params,
|
490
525
|
:form_params => form_params,
|
@@ -495,70 +530,53 @@ module KlaviyoAPI
|
|
495
530
|
|
496
531
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
497
532
|
if @api_client.config.debugging
|
498
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
533
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
499
534
|
end
|
500
535
|
return data, status_code, headers
|
501
536
|
end
|
502
537
|
|
503
|
-
# Get Flow
|
504
|
-
# Get
|
538
|
+
# Get Flow For Flow Action
|
539
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
505
540
|
# @param id [String]
|
506
541
|
# @param [Hash] opts the optional parameters
|
507
|
-
# @option opts [String] :
|
508
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
509
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
510
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
542
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
511
543
|
# @return [Hash<String, Object>]
|
512
|
-
def
|
513
|
-
data, _status_code, _headers =
|
544
|
+
def get_flow_action_flow(id, opts = {})
|
545
|
+
data, _status_code, _headers = get_flow_action_flow_with_http_info(id, opts)
|
514
546
|
data
|
515
547
|
end
|
516
548
|
|
517
|
-
# Get Flow
|
518
|
-
# Get
|
549
|
+
# Get Flow For Flow Action
|
550
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
519
551
|
# @param id [String]
|
520
552
|
# @param [Hash] opts the optional parameters
|
521
|
-
# @option opts [String] :
|
522
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
523
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
524
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
553
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
525
554
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
526
|
-
def
|
555
|
+
def get_flow_action_flow_with_http_info(id, opts = {})
|
527
556
|
if @api_client.config.debugging
|
528
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
557
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_action_flow ...'
|
529
558
|
end
|
530
559
|
# verify the required parameter 'id' is set
|
531
560
|
if @api_client.config.client_side_validation && id.nil?
|
532
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
533
|
-
end
|
534
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
535
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_relationships_messages, must be smaller than or equal to 50.'
|
536
|
-
end
|
537
|
-
|
538
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
539
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_action_relationships_messages, must be greater than or equal to 1.'
|
561
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_flow"
|
540
562
|
end
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
563
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
564
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
565
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
545
566
|
end
|
546
567
|
# resource path
|
547
|
-
local_var_path = '/api/flow-actions/{id}/
|
568
|
+
local_var_path = '/api/flow-actions/{id}/flow'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
548
569
|
|
549
570
|
# query parameters
|
550
571
|
query_params = opts[:query_params] || {}
|
551
|
-
query_params[:'
|
552
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
553
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
554
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
572
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
555
573
|
|
556
574
|
# header parameters
|
557
575
|
header_params = opts[:header_params] || {}
|
558
576
|
# klaviyo api revision
|
559
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
577
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
560
578
|
# HTTP header 'Accept' (if needed)
|
561
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
579
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
562
580
|
|
563
581
|
# form parameters
|
564
582
|
form_params = opts[:form_params] || {}
|
@@ -573,7 +591,7 @@ module KlaviyoAPI
|
|
573
591
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
574
592
|
|
575
593
|
new_options = opts.merge(
|
576
|
-
:operation => :"FlowsApi.
|
594
|
+
:operation => :"FlowsApi.get_flow_action_flow",
|
577
595
|
:header_params => header_params,
|
578
596
|
:query_params => query_params,
|
579
597
|
:form_params => form_params,
|
@@ -584,77 +602,49 @@ module KlaviyoAPI
|
|
584
602
|
|
585
603
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
586
604
|
if @api_client.config.debugging
|
587
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
605
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_action_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
588
606
|
end
|
589
607
|
return data, status_code, headers
|
590
608
|
end
|
591
609
|
|
592
|
-
# Get Flow Flow
|
593
|
-
# Get
|
610
|
+
# Get Flow ID for Flow Action
|
611
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
594
612
|
# @param id [String]
|
595
613
|
# @param [Hash] opts the optional parameters
|
596
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
597
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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`
|
598
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
599
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
600
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
601
614
|
# @return [Hash<String, Object>]
|
602
|
-
def
|
603
|
-
data, _status_code, _headers =
|
615
|
+
def get_flow_id_for_flow_action(id, opts = {})
|
616
|
+
data, _status_code, _headers = get_flow_id_for_flow_action_with_http_info(id, opts)
|
604
617
|
data
|
605
618
|
end
|
606
619
|
|
607
|
-
#
|
608
|
-
|
620
|
+
# alias of `get_flow_id_for_flow_action`
|
621
|
+
alias get_flow_action_relationships_flow get_flow_id_for_flow_action
|
622
|
+
|
623
|
+
# Get Flow ID for Flow Action
|
624
|
+
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
609
625
|
# @param id [String]
|
610
626
|
# @param [Hash] opts the optional parameters
|
611
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
612
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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`
|
613
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
614
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
615
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
616
627
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
617
|
-
def
|
628
|
+
def get_flow_id_for_flow_action_with_http_info(id, opts = {})
|
618
629
|
if @api_client.config.debugging
|
619
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
630
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_id_for_flow_action ...'
|
620
631
|
end
|
621
632
|
# verify the required parameter 'id' is set
|
622
633
|
if @api_client.config.client_side_validation && id.nil?
|
623
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
624
|
-
end
|
625
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "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"]
|
626
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
627
|
-
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
628
|
-
end
|
629
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
630
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_flow_actions, must be smaller than or equal to 50.'
|
631
|
-
end
|
632
|
-
|
633
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
634
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flow_flow_actions, must be greater than or equal to 1.'
|
635
|
-
end
|
636
|
-
|
637
|
-
allowable_values = ["action_type", "-action_type", "created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
|
638
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
639
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
634
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_id_for_flow_action"
|
640
635
|
end
|
641
636
|
# resource path
|
642
|
-
local_var_path = '/api/
|
637
|
+
local_var_path = '/api/flow-actions/{id}/relationships/flow'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
643
638
|
|
644
639
|
# query parameters
|
645
640
|
query_params = opts[:query_params] || {}
|
646
|
-
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
647
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
648
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
649
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
650
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
651
641
|
|
652
642
|
# header parameters
|
653
643
|
header_params = opts[:header_params] || {}
|
654
644
|
# klaviyo api revision
|
655
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
645
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
656
646
|
# HTTP header 'Accept' (if needed)
|
657
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
647
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
658
648
|
|
659
649
|
# form parameters
|
660
650
|
form_params = opts[:form_params] || {}
|
@@ -669,7 +659,7 @@ module KlaviyoAPI
|
|
669
659
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
670
660
|
|
671
661
|
new_options = opts.merge(
|
672
|
-
:operation => :"FlowsApi.
|
662
|
+
:operation => :"FlowsApi.get_flow_id_for_flow_action",
|
673
663
|
:header_params => header_params,
|
674
664
|
:query_params => query_params,
|
675
665
|
:form_params => form_params,
|
@@ -680,19 +670,22 @@ module KlaviyoAPI
|
|
680
670
|
|
681
671
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
682
672
|
if @api_client.config.debugging
|
683
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
673
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_id_for_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
684
674
|
end
|
685
675
|
return data, status_code, headers
|
686
676
|
end
|
687
677
|
|
678
|
+
# alias of `get_flow_id_for_flow_action_with_http_info`
|
679
|
+
alias get_flow_action_relationships_flow_with_http_info get_flow_id_for_flow_action_with_http_info
|
680
|
+
|
688
681
|
# Get Flow Message
|
689
682
|
# 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`
|
690
683
|
# @param id [String]
|
691
684
|
# @param [Hash] opts the optional parameters
|
692
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-
|
693
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-
|
694
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-
|
695
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
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
|
696
689
|
# @return [Hash<String, Object>]
|
697
690
|
def get_flow_message(id, opts = {})
|
698
691
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
@@ -703,10 +696,10 @@ module KlaviyoAPI
|
|
703
696
|
# 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`
|
704
697
|
# @param id [String]
|
705
698
|
# @param [Hash] opts the optional parameters
|
706
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-
|
707
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2024-
|
708
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-
|
709
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
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
|
710
703
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
711
704
|
def get_flow_message_with_http_info(id, opts = {})
|
712
705
|
if @api_client.config.debugging
|
@@ -716,11 +709,11 @@ module KlaviyoAPI
|
|
716
709
|
if @api_client.config.client_side_validation && id.nil?
|
717
710
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message"
|
718
711
|
end
|
719
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "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"]
|
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"]
|
720
713
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
721
714
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
722
715
|
end
|
723
|
-
allowable_values = ["name", "channel", "content", "created", "updated"]
|
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"]
|
724
717
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
725
718
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
726
719
|
end
|
@@ -733,7 +726,7 @@ module KlaviyoAPI
|
|
733
726
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
734
727
|
end
|
735
728
|
# resource path
|
736
|
-
local_var_path = '/api/flow-messages/{id}
|
729
|
+
local_var_path = '/api/flow-messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
737
730
|
|
738
731
|
# query parameters
|
739
732
|
query_params = opts[:query_params] || {}
|
@@ -745,9 +738,9 @@ module KlaviyoAPI
|
|
745
738
|
# header parameters
|
746
739
|
header_params = opts[:header_params] || {}
|
747
740
|
# klaviyo api revision
|
748
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
741
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
749
742
|
# HTTP header 'Accept' (if needed)
|
750
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
743
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
751
744
|
|
752
745
|
# form parameters
|
753
746
|
form_params = opts[:form_params] || {}
|
@@ -782,7 +775,7 @@ module KlaviyoAPI
|
|
782
775
|
# 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`
|
783
776
|
# @param id [String]
|
784
777
|
# @param [Hash] opts the optional parameters
|
785
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-
|
778
|
+
# @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
|
786
779
|
# @return [Hash<String, Object>]
|
787
780
|
def get_flow_message_action(id, opts = {})
|
788
781
|
data, _status_code, _headers = get_flow_message_action_with_http_info(id, opts)
|
@@ -793,7 +786,7 @@ module KlaviyoAPI
|
|
793
786
|
# 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`
|
794
787
|
# @param id [String]
|
795
788
|
# @param [Hash] opts the optional parameters
|
796
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-
|
789
|
+
# @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
|
797
790
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
798
791
|
def get_flow_message_action_with_http_info(id, opts = {})
|
799
792
|
if @api_client.config.debugging
|
@@ -803,12 +796,12 @@ module KlaviyoAPI
|
|
803
796
|
if @api_client.config.client_side_validation && id.nil?
|
804
797
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message_action"
|
805
798
|
end
|
806
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "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"]
|
799
|
+
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"]
|
807
800
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
808
801
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
809
802
|
end
|
810
803
|
# resource path
|
811
|
-
local_var_path = '/api/flow-messages/{id}/flow-action
|
804
|
+
local_var_path = '/api/flow-messages/{id}/flow-action'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
812
805
|
|
813
806
|
# query parameters
|
814
807
|
query_params = opts[:query_params] || {}
|
@@ -817,9 +810,9 @@ module KlaviyoAPI
|
|
817
810
|
# header parameters
|
818
811
|
header_params = opts[:header_params] || {}
|
819
812
|
# klaviyo api revision
|
820
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
813
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
821
814
|
# HTTP header 'Accept' (if needed)
|
822
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
815
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
823
816
|
|
824
817
|
# form parameters
|
825
818
|
form_params = opts[:form_params] || {}
|
@@ -850,41 +843,48 @@ module KlaviyoAPI
|
|
850
843
|
return data, status_code, headers
|
851
844
|
end
|
852
845
|
|
853
|
-
# Get Flow
|
854
|
-
#
|
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`
|
855
848
|
# @param id [String]
|
856
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
|
857
851
|
# @return [Hash<String, Object>]
|
858
|
-
def
|
859
|
-
data, _status_code, _headers =
|
852
|
+
def get_flow_tags(id, opts = {})
|
853
|
+
data, _status_code, _headers = get_flow_tags_with_http_info(id, opts)
|
860
854
|
data
|
861
855
|
end
|
862
856
|
|
863
|
-
# Get Flow
|
864
|
-
#
|
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`
|
865
859
|
# @param id [String]
|
866
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
|
867
862
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
868
|
-
def
|
863
|
+
def get_flow_tags_with_http_info(id, opts = {})
|
869
864
|
if @api_client.config.debugging
|
870
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
865
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_tags ...'
|
871
866
|
end
|
872
867
|
# verify the required parameter 'id' is set
|
873
868
|
if @api_client.config.client_side_validation && id.nil?
|
874
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
869
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_tags"
|
870
|
+
end
|
871
|
+
allowable_values = ["name"]
|
872
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
873
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
875
874
|
end
|
876
875
|
# resource path
|
877
|
-
local_var_path = '/api/
|
876
|
+
local_var_path = '/api/flows/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
878
877
|
|
879
878
|
# query parameters
|
880
879
|
query_params = opts[:query_params] || {}
|
880
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
881
881
|
|
882
882
|
# header parameters
|
883
883
|
header_params = opts[:header_params] || {}
|
884
884
|
# klaviyo api revision
|
885
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
885
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
886
886
|
# HTTP header 'Accept' (if needed)
|
887
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
887
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
888
888
|
|
889
889
|
# form parameters
|
890
890
|
form_params = opts[:form_params] || {}
|
@@ -899,7 +899,7 @@ module KlaviyoAPI
|
|
899
899
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
900
900
|
|
901
901
|
new_options = opts.merge(
|
902
|
-
:operation => :"FlowsApi.
|
902
|
+
:operation => :"FlowsApi.get_flow_tags",
|
903
903
|
:header_params => header_params,
|
904
904
|
:query_params => query_params,
|
905
905
|
:form_params => form_params,
|
@@ -910,46 +910,92 @@ module KlaviyoAPI
|
|
910
910
|
|
911
911
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
912
912
|
if @api_client.config.debugging
|
913
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
913
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flow_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
914
914
|
end
|
915
915
|
return data, status_code, headers
|
916
916
|
end
|
917
917
|
|
918
|
-
# Get
|
919
|
-
# Returns
|
920
|
-
# @param id [String]
|
918
|
+
# Get Flows
|
919
|
+
# 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`
|
921
920
|
# @param [Hash] opts the optional parameters
|
921
|
+
# @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
|
922
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
923
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
924
|
+
# @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>`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`
|
925
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
926
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
927
|
+
# @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/v2024-10-15/reference/api-overview#sorting
|
922
929
|
# @return [Hash<String, Object>]
|
923
|
-
def
|
924
|
-
data, _status_code, _headers =
|
930
|
+
def get_flows(opts = {})
|
931
|
+
data, _status_code, _headers = get_flows_with_http_info(opts)
|
925
932
|
data
|
926
933
|
end
|
927
934
|
|
928
|
-
# Get
|
929
|
-
# Returns
|
930
|
-
# @param id [String]
|
935
|
+
# Get Flows
|
936
|
+
# 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`
|
931
937
|
# @param [Hash] opts the optional parameters
|
938
|
+
# @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
|
939
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
940
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
941
|
+
# @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>`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`
|
942
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
943
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
944
|
+
# @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/v2024-10-15/reference/api-overview#sorting
|
932
946
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
933
|
-
def
|
947
|
+
def get_flows_with_http_info(opts = {})
|
934
948
|
if @api_client.config.debugging
|
935
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
949
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flows ...'
|
936
950
|
end
|
937
|
-
|
938
|
-
if @api_client.config.client_side_validation &&
|
939
|
-
fail ArgumentError, "
|
951
|
+
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"]
|
952
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
953
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
954
|
+
end
|
955
|
+
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
956
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
957
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
958
|
+
end
|
959
|
+
allowable_values = ["name"]
|
960
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
961
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
962
|
+
end
|
963
|
+
allowable_values = ["flow-actions", "tags"]
|
964
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
965
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
966
|
+
end
|
967
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
968
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be smaller than or equal to 50.'
|
969
|
+
end
|
970
|
+
|
971
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
972
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be greater than or equal to 1.'
|
973
|
+
end
|
974
|
+
|
975
|
+
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "status", "-status", "trigger_type", "-trigger_type", "updated", "-updated"]
|
976
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
977
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
940
978
|
end
|
941
979
|
# resource path
|
942
|
-
local_var_path = '/api/
|
980
|
+
local_var_path = '/api/flows'
|
943
981
|
|
944
982
|
# query parameters
|
945
983
|
query_params = opts[:query_params] || {}
|
984
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
985
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
986
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
987
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
988
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
989
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
990
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
991
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
946
992
|
|
947
993
|
# header parameters
|
948
994
|
header_params = opts[:header_params] || {}
|
949
995
|
# klaviyo api revision
|
950
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
996
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
951
997
|
# HTTP header 'Accept' (if needed)
|
952
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
998
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
953
999
|
|
954
1000
|
# form parameters
|
955
1001
|
form_params = opts[:form_params] || {}
|
@@ -964,7 +1010,7 @@ module KlaviyoAPI
|
|
964
1010
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
965
1011
|
|
966
1012
|
new_options = opts.merge(
|
967
|
-
:operation => :"FlowsApi.
|
1013
|
+
:operation => :"FlowsApi.get_flows",
|
968
1014
|
:header_params => header_params,
|
969
1015
|
:query_params => query_params,
|
970
1016
|
:form_params => form_params,
|
@@ -975,53 +1021,73 @@ module KlaviyoAPI
|
|
975
1021
|
|
976
1022
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
977
1023
|
if @api_client.config.debugging
|
978
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1024
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
979
1025
|
end
|
980
1026
|
return data, status_code, headers
|
981
1027
|
end
|
982
1028
|
|
983
|
-
# Get Flow
|
984
|
-
#
|
1029
|
+
# Get Message IDs for Flow Action
|
1030
|
+
# 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`
|
985
1031
|
# @param id [String]
|
986
1032
|
# @param [Hash] opts the optional parameters
|
987
|
-
# @option opts [
|
1033
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `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`
|
1034
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1035
|
+
# @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/v2024-10-15/reference/api-overview#sorting
|
988
1037
|
# @return [Hash<String, Object>]
|
989
|
-
def
|
990
|
-
data, _status_code, _headers =
|
1038
|
+
def get_message_ids_for_flow_action(id, opts = {})
|
1039
|
+
data, _status_code, _headers = get_message_ids_for_flow_action_with_http_info(id, opts)
|
991
1040
|
data
|
992
1041
|
end
|
993
1042
|
|
994
|
-
#
|
995
|
-
|
1043
|
+
# alias of `get_message_ids_for_flow_action`
|
1044
|
+
alias get_flow_action_relationships_messages get_message_ids_for_flow_action
|
1045
|
+
|
1046
|
+
# Get Message IDs for Flow Action
|
1047
|
+
# 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`
|
996
1048
|
# @param id [String]
|
997
1049
|
# @param [Hash] opts the optional parameters
|
998
|
-
# @option opts [
|
1050
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `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`
|
1051
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1052
|
+
# @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/v2024-10-15/reference/api-overview#sorting
|
999
1054
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1000
|
-
def
|
1055
|
+
def get_message_ids_for_flow_action_with_http_info(id, opts = {})
|
1001
1056
|
if @api_client.config.debugging
|
1002
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1057
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_message_ids_for_flow_action ...'
|
1003
1058
|
end
|
1004
1059
|
# verify the required parameter 'id' is set
|
1005
1060
|
if @api_client.config.client_side_validation && id.nil?
|
1006
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
1061
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_message_ids_for_flow_action"
|
1007
1062
|
end
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1063
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
1064
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_message_ids_for_flow_action, must be smaller than or equal to 50.'
|
1065
|
+
end
|
1066
|
+
|
1067
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1068
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_message_ids_for_flow_action, must be greater than or equal to 1.'
|
1069
|
+
end
|
1070
|
+
|
1071
|
+
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
1072
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1073
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1011
1074
|
end
|
1012
1075
|
# resource path
|
1013
|
-
local_var_path = '/api/flow-
|
1076
|
+
local_var_path = '/api/flow-actions/{id}/relationships/flow-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1014
1077
|
|
1015
1078
|
# query parameters
|
1016
1079
|
query_params = opts[:query_params] || {}
|
1017
|
-
query_params[:'
|
1080
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1081
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1082
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1083
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1018
1084
|
|
1019
1085
|
# header parameters
|
1020
1086
|
header_params = opts[:header_params] || {}
|
1021
1087
|
# klaviyo api revision
|
1022
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1088
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1023
1089
|
# HTTP header 'Accept' (if needed)
|
1024
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1090
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1025
1091
|
|
1026
1092
|
# form parameters
|
1027
1093
|
form_params = opts[:form_params] || {}
|
@@ -1036,7 +1102,7 @@ module KlaviyoAPI
|
|
1036
1102
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1037
1103
|
|
1038
1104
|
new_options = opts.merge(
|
1039
|
-
:operation => :"FlowsApi.
|
1105
|
+
:operation => :"FlowsApi.get_message_ids_for_flow_action",
|
1040
1106
|
:header_params => header_params,
|
1041
1107
|
:query_params => query_params,
|
1042
1108
|
:form_params => form_params,
|
@@ -1047,57 +1113,70 @@ module KlaviyoAPI
|
|
1047
1113
|
|
1048
1114
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1049
1115
|
if @api_client.config.debugging
|
1050
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1116
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_message_ids_for_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1051
1117
|
end
|
1052
1118
|
return data, status_code, headers
|
1053
1119
|
end
|
1054
1120
|
|
1055
|
-
#
|
1056
|
-
|
1121
|
+
# alias of `get_message_ids_for_flow_action_with_http_info`
|
1122
|
+
alias get_flow_action_relationships_messages_with_http_info get_message_ids_for_flow_action_with_http_info
|
1123
|
+
|
1124
|
+
# Get Messages for Flow Action
|
1125
|
+
# Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1057
1126
|
# @param id [String]
|
1058
1127
|
# @param [Hash] opts the optional parameters
|
1059
|
-
# @option opts [String] :
|
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`
|
1060
1130
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
1061
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-
|
1131
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1062
1132
|
# @return [Hash<String, Object>]
|
1063
|
-
def
|
1064
|
-
data, _status_code, _headers =
|
1133
|
+
def get_messages_for_flow_action(id, opts = {})
|
1134
|
+
data, _status_code, _headers = get_messages_for_flow_action_with_http_info(id, opts)
|
1065
1135
|
data
|
1066
1136
|
end
|
1067
1137
|
|
1068
|
-
#
|
1069
|
-
|
1138
|
+
# alias of `get_messages_for_flow_action`
|
1139
|
+
alias get_flow_action_messages get_messages_for_flow_action
|
1140
|
+
|
1141
|
+
# Get Messages for Flow Action
|
1142
|
+
# Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1070
1143
|
# @param id [String]
|
1071
1144
|
# @param [Hash] opts the optional parameters
|
1072
|
-
# @option opts [String] :
|
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`
|
1073
1147
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 100. (default to 50)
|
1074
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-
|
1148
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1075
1149
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1076
|
-
def
|
1150
|
+
def get_messages_for_flow_action_with_http_info(id, opts = {})
|
1077
1151
|
if @api_client.config.debugging
|
1078
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1152
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_messages_for_flow_action ...'
|
1079
1153
|
end
|
1080
1154
|
# verify the required parameter 'id' is set
|
1081
1155
|
if @api_client.config.client_side_validation && id.nil?
|
1082
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
1156
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_messages_for_flow_action"
|
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}"
|
1083
1161
|
end
|
1084
1162
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
1085
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.
|
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.'
|
1086
1164
|
end
|
1087
1165
|
|
1088
1166
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1089
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.
|
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.'
|
1090
1168
|
end
|
1091
1169
|
|
1092
|
-
allowable_values = ["created", "-created", "id", "-id", "
|
1170
|
+
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
1093
1171
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1094
1172
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1095
1173
|
end
|
1096
1174
|
# resource path
|
1097
|
-
local_var_path = '/api/
|
1175
|
+
local_var_path = '/api/flow-actions/{id}/flow-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1098
1176
|
|
1099
1177
|
# query parameters
|
1100
1178
|
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?
|
1101
1180
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1102
1181
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1103
1182
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
@@ -1105,9 +1184,9 @@ module KlaviyoAPI
|
|
1105
1184
|
# header parameters
|
1106
1185
|
header_params = opts[:header_params] || {}
|
1107
1186
|
# klaviyo api revision
|
1108
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1187
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1109
1188
|
# HTTP header 'Accept' (if needed)
|
1110
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1189
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1111
1190
|
|
1112
1191
|
# form parameters
|
1113
1192
|
form_params = opts[:form_params] || {}
|
@@ -1122,7 +1201,7 @@ module KlaviyoAPI
|
|
1122
1201
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1123
1202
|
|
1124
1203
|
new_options = opts.merge(
|
1125
|
-
:operation => :"FlowsApi.
|
1204
|
+
:operation => :"FlowsApi.get_messages_for_flow_action",
|
1126
1205
|
:header_params => header_params,
|
1127
1206
|
:query_params => query_params,
|
1128
1207
|
:form_params => form_params,
|
@@ -1133,36 +1212,42 @@ module KlaviyoAPI
|
|
1133
1212
|
|
1134
1213
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1135
1214
|
if @api_client.config.debugging
|
1136
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1215
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_messages_for_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1137
1216
|
end
|
1138
1217
|
return data, status_code, headers
|
1139
1218
|
end
|
1140
1219
|
|
1141
|
-
#
|
1220
|
+
# alias of `get_messages_for_flow_action_with_http_info`
|
1221
|
+
alias get_flow_action_messages_with_http_info get_messages_for_flow_action_with_http_info
|
1222
|
+
|
1223
|
+
# Get Tag IDs for Flow
|
1142
1224
|
# 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
1225
|
# @param id [String]
|
1144
1226
|
# @param [Hash] opts the optional parameters
|
1145
1227
|
# @return [Hash<String, Object>]
|
1146
|
-
def
|
1147
|
-
data, _status_code, _headers =
|
1228
|
+
def get_tag_ids_for_flow(id, opts = {})
|
1229
|
+
data, _status_code, _headers = get_tag_ids_for_flow_with_http_info(id, opts)
|
1148
1230
|
data
|
1149
1231
|
end
|
1150
1232
|
|
1151
|
-
#
|
1233
|
+
# alias of `get_tag_ids_for_flow`
|
1234
|
+
alias get_flow_relationships_tags get_tag_ids_for_flow
|
1235
|
+
|
1236
|
+
# Get Tag IDs for Flow
|
1152
1237
|
# 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`
|
1153
1238
|
# @param id [String]
|
1154
1239
|
# @param [Hash] opts the optional parameters
|
1155
1240
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1156
|
-
def
|
1241
|
+
def get_tag_ids_for_flow_with_http_info(id, opts = {})
|
1157
1242
|
if @api_client.config.debugging
|
1158
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1243
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_tag_ids_for_flow ...'
|
1159
1244
|
end
|
1160
1245
|
# verify the required parameter 'id' is set
|
1161
1246
|
if @api_client.config.client_side_validation && id.nil?
|
1162
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
1247
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_tag_ids_for_flow"
|
1163
1248
|
end
|
1164
1249
|
# resource path
|
1165
|
-
local_var_path = '/api/flows/{id}/relationships/tags
|
1250
|
+
local_var_path = '/api/flows/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1166
1251
|
|
1167
1252
|
# query parameters
|
1168
1253
|
query_params = opts[:query_params] || {}
|
@@ -1170,9 +1255,9 @@ module KlaviyoAPI
|
|
1170
1255
|
# header parameters
|
1171
1256
|
header_params = opts[:header_params] || {}
|
1172
1257
|
# klaviyo api revision
|
1173
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1258
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1174
1259
|
# HTTP header 'Accept' (if needed)
|
1175
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1260
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1176
1261
|
|
1177
1262
|
# form parameters
|
1178
1263
|
form_params = opts[:form_params] || {}
|
@@ -1187,7 +1272,7 @@ module KlaviyoAPI
|
|
1187
1272
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1188
1273
|
|
1189
1274
|
new_options = opts.merge(
|
1190
|
-
:operation => :"FlowsApi.
|
1275
|
+
:operation => :"FlowsApi.get_tag_ids_for_flow",
|
1191
1276
|
:header_params => header_params,
|
1192
1277
|
:query_params => query_params,
|
1193
1278
|
:form_params => form_params,
|
@@ -1198,53 +1283,59 @@ module KlaviyoAPI
|
|
1198
1283
|
|
1199
1284
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1200
1285
|
if @api_client.config.debugging
|
1201
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1286
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_tag_ids_for_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1202
1287
|
end
|
1203
1288
|
return data, status_code, headers
|
1204
1289
|
end
|
1205
1290
|
|
1206
|
-
#
|
1207
|
-
|
1291
|
+
# alias of `get_tag_ids_for_flow_with_http_info`
|
1292
|
+
alias get_flow_relationships_tags_with_http_info get_tag_ids_for_flow_with_http_info
|
1293
|
+
|
1294
|
+
# Get Template for Flow Message
|
1295
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1208
1296
|
# @param id [String]
|
1209
1297
|
# @param [Hash] opts the optional parameters
|
1210
|
-
# @option opts [Array<String>] :
|
1298
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1211
1299
|
# @return [Hash<String, Object>]
|
1212
|
-
def
|
1213
|
-
data, _status_code, _headers =
|
1300
|
+
def get_template_for_flow_message(id, opts = {})
|
1301
|
+
data, _status_code, _headers = get_template_for_flow_message_with_http_info(id, opts)
|
1214
1302
|
data
|
1215
1303
|
end
|
1216
1304
|
|
1217
|
-
#
|
1218
|
-
|
1305
|
+
# alias of `get_template_for_flow_message`
|
1306
|
+
alias get_flow_message_template get_template_for_flow_message
|
1307
|
+
|
1308
|
+
# Get Template for Flow Message
|
1309
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1219
1310
|
# @param id [String]
|
1220
1311
|
# @param [Hash] opts the optional parameters
|
1221
|
-
# @option opts [Array<String>] :
|
1312
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1222
1313
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1223
|
-
def
|
1314
|
+
def get_template_for_flow_message_with_http_info(id, opts = {})
|
1224
1315
|
if @api_client.config.debugging
|
1225
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1316
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_template_for_flow_message ...'
|
1226
1317
|
end
|
1227
1318
|
# verify the required parameter 'id' is set
|
1228
1319
|
if @api_client.config.client_side_validation && id.nil?
|
1229
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.
|
1320
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_template_for_flow_message"
|
1230
1321
|
end
|
1231
|
-
allowable_values = ["name"]
|
1232
|
-
if @api_client.config.client_side_validation && opts[:'
|
1233
|
-
fail ArgumentError, "invalid value for \"
|
1322
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
1323
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
1324
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
1234
1325
|
end
|
1235
1326
|
# resource path
|
1236
|
-
local_var_path = '/api/
|
1327
|
+
local_var_path = '/api/flow-messages/{id}/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1237
1328
|
|
1238
1329
|
# query parameters
|
1239
1330
|
query_params = opts[:query_params] || {}
|
1240
|
-
query_params[:'fields[
|
1331
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
1241
1332
|
|
1242
1333
|
# header parameters
|
1243
1334
|
header_params = opts[:header_params] || {}
|
1244
1335
|
# klaviyo api revision
|
1245
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1336
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1246
1337
|
# HTTP header 'Accept' (if needed)
|
1247
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1338
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1248
1339
|
|
1249
1340
|
# form parameters
|
1250
1341
|
form_params = opts[:form_params] || {}
|
@@ -1259,7 +1350,7 @@ module KlaviyoAPI
|
|
1259
1350
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1260
1351
|
|
1261
1352
|
new_options = opts.merge(
|
1262
|
-
:operation => :"FlowsApi.
|
1353
|
+
:operation => :"FlowsApi.get_template_for_flow_message",
|
1263
1354
|
:header_params => header_params,
|
1264
1355
|
:query_params => query_params,
|
1265
1356
|
:form_params => form_params,
|
@@ -1270,92 +1361,52 @@ module KlaviyoAPI
|
|
1270
1361
|
|
1271
1362
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1272
1363
|
if @api_client.config.debugging
|
1273
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1364
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_template_for_flow_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1274
1365
|
end
|
1275
1366
|
return data, status_code, headers
|
1276
1367
|
end
|
1277
1368
|
|
1278
|
-
#
|
1279
|
-
|
1369
|
+
# alias of `get_template_for_flow_message_with_http_info`
|
1370
|
+
alias get_flow_message_template_with_http_info get_template_for_flow_message_with_http_info
|
1371
|
+
|
1372
|
+
# Get Template ID for Flow Message
|
1373
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1374
|
+
# @param id [String]
|
1280
1375
|
# @param [Hash] opts the optional parameters
|
1281
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1282
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1283
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1284
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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`
|
1285
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
1286
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1287
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1288
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1289
1376
|
# @return [Hash<String, Object>]
|
1290
|
-
def
|
1291
|
-
data, _status_code, _headers =
|
1377
|
+
def get_template_id_for_flow_message(id, opts = {})
|
1378
|
+
data, _status_code, _headers = get_template_id_for_flow_message_with_http_info(id, opts)
|
1292
1379
|
data
|
1293
1380
|
end
|
1294
1381
|
|
1295
|
-
#
|
1296
|
-
|
1382
|
+
# alias of `get_template_id_for_flow_message`
|
1383
|
+
alias get_flow_message_relationships_template get_template_id_for_flow_message
|
1384
|
+
|
1385
|
+
# Get Template ID for Flow Message
|
1386
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1387
|
+
# @param id [String]
|
1297
1388
|
# @param [Hash] opts the optional parameters
|
1298
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1299
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1300
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1301
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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`
|
1302
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
1303
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1304
|
-
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1305
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1306
1389
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1307
|
-
def
|
1390
|
+
def get_template_id_for_flow_message_with_http_info(id, opts = {})
|
1308
1391
|
if @api_client.config.debugging
|
1309
|
-
@api_client.config.logger.debug 'Calling API: FlowsApi.
|
1310
|
-
end
|
1311
|
-
allowable_values = ["action_type", "status", "created", "updated", "settings", "tracking_options", "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"]
|
1312
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
1313
|
-
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
1314
|
-
end
|
1315
|
-
allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
|
1316
|
-
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
1317
|
-
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
1318
|
-
end
|
1319
|
-
allowable_values = ["name"]
|
1320
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1321
|
-
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1322
|
-
end
|
1323
|
-
allowable_values = ["flow-actions", "tags"]
|
1324
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1325
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1326
|
-
end
|
1327
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
1328
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be smaller than or equal to 50.'
|
1329
|
-
end
|
1330
|
-
|
1331
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1332
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FlowsApi.get_flows, must be greater than or equal to 1.'
|
1392
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.get_template_id_for_flow_message ...'
|
1333
1393
|
end
|
1334
|
-
|
1335
|
-
|
1336
|
-
|
1337
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1394
|
+
# verify the required parameter 'id' is set
|
1395
|
+
if @api_client.config.client_side_validation && id.nil?
|
1396
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_template_id_for_flow_message"
|
1338
1397
|
end
|
1339
1398
|
# resource path
|
1340
|
-
local_var_path = '/api/
|
1399
|
+
local_var_path = '/api/flow-messages/{id}/relationships/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1341
1400
|
|
1342
1401
|
# query parameters
|
1343
1402
|
query_params = opts[:query_params] || {}
|
1344
|
-
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
1345
|
-
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
1346
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1347
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1348
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1349
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1350
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1351
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1352
1403
|
|
1353
1404
|
# header parameters
|
1354
1405
|
header_params = opts[:header_params] || {}
|
1355
1406
|
# klaviyo api revision
|
1356
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1407
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1357
1408
|
# HTTP header 'Accept' (if needed)
|
1358
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1409
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1359
1410
|
|
1360
1411
|
# form parameters
|
1361
1412
|
form_params = opts[:form_params] || {}
|
@@ -1370,7 +1421,7 @@ module KlaviyoAPI
|
|
1370
1421
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1371
1422
|
|
1372
1423
|
new_options = opts.merge(
|
1373
|
-
:operation => :"FlowsApi.
|
1424
|
+
:operation => :"FlowsApi.get_template_id_for_flow_message",
|
1374
1425
|
:header_params => header_params,
|
1375
1426
|
:query_params => query_params,
|
1376
1427
|
:form_params => form_params,
|
@@ -1381,11 +1432,14 @@ module KlaviyoAPI
|
|
1381
1432
|
|
1382
1433
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1383
1434
|
if @api_client.config.debugging
|
1384
|
-
@api_client.config.logger.debug "API called: FlowsApi#
|
1435
|
+
@api_client.config.logger.debug "API called: FlowsApi#get_template_id_for_flow_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1385
1436
|
end
|
1386
1437
|
return data, status_code, headers
|
1387
1438
|
end
|
1388
1439
|
|
1440
|
+
# alias of `get_template_id_for_flow_message_with_http_info`
|
1441
|
+
alias get_flow_message_relationships_template_with_http_info get_template_id_for_flow_message_with_http_info
|
1442
|
+
|
1389
1443
|
# Update Flow Status
|
1390
1444
|
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
1391
1445
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
@@ -1416,7 +1470,7 @@ module KlaviyoAPI
|
|
1416
1470
|
fail ArgumentError, "Missing the required parameter 'flow_update_query' when calling FlowsApi.update_flow"
|
1417
1471
|
end
|
1418
1472
|
# resource path
|
1419
|
-
local_var_path = '/api/flows/{id}
|
1473
|
+
local_var_path = '/api/flows/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1420
1474
|
|
1421
1475
|
# query parameters
|
1422
1476
|
query_params = opts[:query_params] || {}
|
@@ -1424,11 +1478,11 @@ module KlaviyoAPI
|
|
1424
1478
|
# header parameters
|
1425
1479
|
header_params = opts[:header_params] || {}
|
1426
1480
|
# klaviyo api revision
|
1427
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1481
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1428
1482
|
# HTTP header 'Accept' (if needed)
|
1429
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1483
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1430
1484
|
# HTTP header 'Content-Type'
|
1431
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1485
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1432
1486
|
if !content_type.nil?
|
1433
1487
|
header_params['Content-Type'] = content_type
|
1434
1488
|
end
|