klaviyo-api-sdk 11.0.0 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -0
- data/README.md +677 -357
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +422 -159
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +405 -307
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +170 -149
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +147 -135
- data/lib/klaviyo-api-sdk/api/flows_api.rb +431 -311
- data/lib/klaviyo-api-sdk/api/forms_api.rb +76 -44
- data/lib/klaviyo-api-sdk/api/images_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/lists_api.rb +416 -362
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -148
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +242 -212
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +63 -21
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +101 -25
- data/lib/klaviyo-api-sdk/api/segments_api.rb +226 -202
- data/lib/klaviyo-api-sdk/api/tags_api.rb +167 -101
- data/lib/klaviyo-api-sdk/api/templates_api.rb +45 -45
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +19 -10
- data/lib/klaviyo-api-sdk/models/ab_test_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{audiences_sub_object.rb → audiences.rb} +9 -5
- data/lib/klaviyo-api-sdk/models/audiences_update.rb +236 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +230 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/branch_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +3 -3
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +11 -42
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_content.rb → campaign_message_create_query_resource_object_attributes_definition.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +219 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +14 -5
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +9 -29
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +107 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -3
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +108 -0
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +35 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +2 -2
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_item_op_data_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +265 -0
- data/lib/klaviyo-api-sdk/models/code_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +224 -0
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +1 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +312 -0
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/custom_object_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_content_sub_object.rb → email_content.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +244 -0
- data/lib/klaviyo-api-sdk/models/email_send_options.rb +223 -0
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object.rb → email_tracking_options.rb} +50 -38
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{sto_schedule_options.rb → flow_create_query.rb} +14 -15
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +269 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +122 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +111 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +364 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +286 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +394 -0
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +386 -0
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +259 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +294 -0
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +224 -0
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_strategy_sub_object.rb → internal_service_action.rb} +46 -33
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/link.rb +220 -0
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → list_update_action_data.rb} +34 -43
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/{static_schedule_options.rb → local_static_send.rb} +46 -22
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +328 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +266 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +118 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +247 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options_sub_object.rb → mobile_push_message_standard_definition_update.rb} +40 -23
- data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +259 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +243 -0
- data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object_custom_tracking_params_inner.rb → mobile_push_options_badge.rb} +5 -4
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +105 -0
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +259 -0
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +301 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/other_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +262 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +349 -0
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +273 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +105 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +328 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +301 -0
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +395 -0
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +238 -0
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +8 -3
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +20 -6
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/published_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +224 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +246 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{email_send_options_sub_object.rb → push_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +235 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +224 -0
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +224 -0
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{render_options_sub_object.rb → render_options.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/review_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +220 -0
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +109 -0
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +224 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +238 -0
- data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +110 -0
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +224 -0
- data/lib/klaviyo-api-sdk/models/scheduled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/scheduled_trigger.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +234 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_data.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{sms_content_sub_object_create.rb → sms_content_create.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options_sub_object.rb → sms_send_options.rb} +7 -5
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +228 -0
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/split_action.rb +255 -0
- data/lib/klaviyo-api-sdk/models/split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/split_links.rb +226 -0
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{throttled_schedule_options.rb → static_send_strategy.rb} +26 -17
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +276 -0
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +288 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +269 -0
- data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +325 -0
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +310 -0
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_condition_group_conditions_inner.rb +114 -0
- data/lib/klaviyo-api-sdk/models/union_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +228 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +259 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +273 -0
- data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +109 -0
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/utm_param.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → utm_param_info.rb} +17 -33
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +6 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +2 -2
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +219 -0
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +192 -18
- metadata +193 -19
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: 2025-01-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -54,7 +54,7 @@ module KlaviyoAPI
|
|
54
54
|
# header parameters
|
55
55
|
header_params = opts[:header_params] || {}
|
56
56
|
# klaviyo api revision
|
57
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
57
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
58
58
|
# HTTP header 'Accept' (if needed)
|
59
59
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
60
60
|
# HTTP header 'Content-Type'
|
@@ -73,7 +73,7 @@ module KlaviyoAPI
|
|
73
73
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
74
74
|
|
75
75
|
# auth_names
|
76
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
76
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
77
77
|
|
78
78
|
new_options = opts.merge(
|
79
79
|
:operation => :"CampaignsApi.assign_template_to_campaign_message",
|
@@ -136,7 +136,7 @@ module KlaviyoAPI
|
|
136
136
|
# header parameters
|
137
137
|
header_params = opts[:header_params] || {}
|
138
138
|
# klaviyo api revision
|
139
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
139
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
140
140
|
# HTTP header 'Accept' (if needed)
|
141
141
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
142
142
|
# HTTP header 'Content-Type'
|
@@ -155,7 +155,7 @@ module KlaviyoAPI
|
|
155
155
|
return_type = opts[:debug_return_type]
|
156
156
|
|
157
157
|
# auth_names
|
158
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
158
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
159
159
|
|
160
160
|
new_options = opts.merge(
|
161
161
|
:operation => :"CampaignsApi.cancel_campaign_send",
|
@@ -209,7 +209,7 @@ module KlaviyoAPI
|
|
209
209
|
# header parameters
|
210
210
|
header_params = opts[:header_params] || {}
|
211
211
|
# klaviyo api revision
|
212
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
212
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
213
213
|
# HTTP header 'Accept' (if needed)
|
214
214
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
215
215
|
# HTTP header 'Content-Type'
|
@@ -228,7 +228,7 @@ module KlaviyoAPI
|
|
228
228
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
229
229
|
|
230
230
|
# auth_names
|
231
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
231
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
232
232
|
|
233
233
|
new_options = opts.merge(
|
234
234
|
:operation => :"CampaignsApi.create_campaign",
|
@@ -282,7 +282,7 @@ module KlaviyoAPI
|
|
282
282
|
# header parameters
|
283
283
|
header_params = opts[:header_params] || {}
|
284
284
|
# klaviyo api revision
|
285
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
286
286
|
# HTTP header 'Accept' (if needed)
|
287
287
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
288
288
|
# HTTP header 'Content-Type'
|
@@ -301,7 +301,7 @@ module KlaviyoAPI
|
|
301
301
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
302
302
|
|
303
303
|
# auth_names
|
304
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
304
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
305
305
|
|
306
306
|
new_options = opts.merge(
|
307
307
|
:operation => :"CampaignsApi.create_campaign_clone",
|
@@ -355,7 +355,7 @@ module KlaviyoAPI
|
|
355
355
|
# header parameters
|
356
356
|
header_params = opts[:header_params] || {}
|
357
357
|
# klaviyo api revision
|
358
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
358
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
359
359
|
# HTTP header 'Accept' (if needed)
|
360
360
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
361
361
|
|
@@ -369,7 +369,7 @@ module KlaviyoAPI
|
|
369
369
|
return_type = opts[:debug_return_type]
|
370
370
|
|
371
371
|
# auth_names
|
372
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
372
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
373
373
|
|
374
374
|
new_options = opts.merge(
|
375
375
|
:operation => :"CampaignsApi.delete_campaign",
|
@@ -392,10 +392,10 @@ module KlaviyoAPI
|
|
392
392
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
393
393
|
# @param id [String] The campaign ID to be retrieved
|
394
394
|
# @param [Hash] opts the optional parameters
|
395
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/
|
396
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
397
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
398
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
395
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
396
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
397
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
398
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
399
399
|
# @return [Hash<String, Object>]
|
400
400
|
def get_campaign(id, opts = {})
|
401
401
|
data, _status_code, _headers = get_campaign_with_http_info(id, opts)
|
@@ -406,10 +406,10 @@ module KlaviyoAPI
|
|
406
406
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
407
407
|
# @param id [String] The campaign ID to be retrieved
|
408
408
|
# @param [Hash] opts the optional parameters
|
409
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/
|
410
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
411
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/
|
412
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/
|
409
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
410
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
411
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
412
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
413
413
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
414
414
|
def get_campaign_with_http_info(id, opts = {})
|
415
415
|
if @api_client.config.debugging
|
@@ -419,11 +419,11 @@ module KlaviyoAPI
|
|
419
419
|
if @api_client.config.client_side_validation && id.nil?
|
420
420
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign"
|
421
421
|
end
|
422
|
-
allowable_values = ["
|
422
|
+
allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
|
423
423
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
424
424
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
425
425
|
end
|
426
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.
|
426
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
427
427
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
428
428
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
429
429
|
end
|
@@ -448,7 +448,7 @@ module KlaviyoAPI
|
|
448
448
|
# header parameters
|
449
449
|
header_params = opts[:header_params] || {}
|
450
450
|
# klaviyo api revision
|
451
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
451
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
452
452
|
# HTTP header 'Accept' (if needed)
|
453
453
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
454
454
|
|
@@ -462,7 +462,7 @@ module KlaviyoAPI
|
|
462
462
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
463
463
|
|
464
464
|
# auth_names
|
465
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
465
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
466
466
|
|
467
467
|
new_options = opts.merge(
|
468
468
|
:operation => :"CampaignsApi.get_campaign",
|
@@ -485,7 +485,7 @@ module KlaviyoAPI
|
|
485
485
|
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
486
486
|
# @param id [String]
|
487
487
|
# @param [Hash] opts the optional parameters
|
488
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
488
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
489
489
|
# @return [Hash<String, Object>]
|
490
490
|
def get_campaign_for_campaign_message(id, opts = {})
|
491
491
|
data, _status_code, _headers = get_campaign_for_campaign_message_with_http_info(id, opts)
|
@@ -499,7 +499,7 @@ module KlaviyoAPI
|
|
499
499
|
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
500
500
|
# @param id [String]
|
501
501
|
# @param [Hash] opts the optional parameters
|
502
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
502
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
503
503
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
504
504
|
def get_campaign_for_campaign_message_with_http_info(id, opts = {})
|
505
505
|
if @api_client.config.debugging
|
@@ -509,7 +509,7 @@ module KlaviyoAPI
|
|
509
509
|
if @api_client.config.client_side_validation && id.nil?
|
510
510
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_for_campaign_message"
|
511
511
|
end
|
512
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.
|
512
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
513
513
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
514
514
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
515
515
|
end
|
@@ -523,7 +523,7 @@ module KlaviyoAPI
|
|
523
523
|
# header parameters
|
524
524
|
header_params = opts[:header_params] || {}
|
525
525
|
# klaviyo api revision
|
526
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
526
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
527
527
|
# HTTP header 'Accept' (if needed)
|
528
528
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
529
529
|
|
@@ -537,7 +537,7 @@ module KlaviyoAPI
|
|
537
537
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
538
538
|
|
539
539
|
# auth_names
|
540
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
540
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
541
541
|
|
542
542
|
new_options = opts.merge(
|
543
543
|
:operation => :"CampaignsApi.get_campaign_for_campaign_message",
|
@@ -594,7 +594,7 @@ module KlaviyoAPI
|
|
594
594
|
# header parameters
|
595
595
|
header_params = opts[:header_params] || {}
|
596
596
|
# klaviyo api revision
|
597
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
597
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
598
598
|
# HTTP header 'Accept' (if needed)
|
599
599
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
600
600
|
|
@@ -608,7 +608,7 @@ module KlaviyoAPI
|
|
608
608
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
609
609
|
|
610
610
|
# auth_names
|
611
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
611
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
612
612
|
|
613
613
|
new_options = opts.merge(
|
614
614
|
:operation => :"CampaignsApi.get_campaign_id_for_campaign_message",
|
@@ -634,10 +634,11 @@ module KlaviyoAPI
|
|
634
634
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
635
635
|
# @param id [String] The message ID to be retrieved
|
636
636
|
# @param [Hash] opts the optional parameters
|
637
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/
|
638
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
639
|
-
# @option opts [Array<String>] :
|
640
|
-
# @option opts [Array<String>] :
|
637
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
638
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
639
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
640
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
641
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
641
642
|
# @return [Hash<String, Object>]
|
642
643
|
def get_campaign_message(id, opts = {})
|
643
644
|
data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
|
@@ -648,10 +649,11 @@ module KlaviyoAPI
|
|
648
649
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
649
650
|
# @param id [String] The message ID to be retrieved
|
650
651
|
# @param [Hash] opts the optional parameters
|
651
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/
|
652
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
653
|
-
# @option opts [Array<String>] :
|
654
|
-
# @option opts [Array<String>] :
|
652
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
653
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
654
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
655
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
656
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
655
657
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
656
658
|
def get_campaign_message_with_http_info(id, opts = {})
|
657
659
|
if @api_client.config.debugging
|
@@ -661,19 +663,23 @@ module KlaviyoAPI
|
|
661
663
|
if @api_client.config.client_side_validation && id.nil?
|
662
664
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message"
|
663
665
|
end
|
664
|
-
allowable_values = ["
|
666
|
+
allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
|
665
667
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
666
668
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
667
669
|
end
|
668
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.
|
670
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
669
671
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
670
672
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
671
673
|
end
|
674
|
+
allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"]
|
675
|
+
if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
|
676
|
+
fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
|
677
|
+
end
|
672
678
|
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
673
679
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
674
680
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
675
681
|
end
|
676
|
-
allowable_values = ["campaign", "template"]
|
682
|
+
allowable_values = ["campaign", "image", "template"]
|
677
683
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
678
684
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
679
685
|
end
|
@@ -684,13 +690,14 @@ module KlaviyoAPI
|
|
684
690
|
query_params = opts[:query_params] || {}
|
685
691
|
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
686
692
|
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
693
|
+
query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
|
687
694
|
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
688
695
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
689
696
|
|
690
697
|
# header parameters
|
691
698
|
header_params = opts[:header_params] || {}
|
692
699
|
# klaviyo api revision
|
693
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
700
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
694
701
|
# HTTP header 'Accept' (if needed)
|
695
702
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
696
703
|
|
@@ -704,7 +711,7 @@ module KlaviyoAPI
|
|
704
711
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
705
712
|
|
706
713
|
# auth_names
|
707
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
714
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
708
715
|
|
709
716
|
new_options = opts.merge(
|
710
717
|
:operation => :"CampaignsApi.get_campaign_message",
|
@@ -727,7 +734,7 @@ module KlaviyoAPI
|
|
727
734
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
728
735
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
729
736
|
# @param [Hash] opts the optional parameters
|
730
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/
|
737
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
731
738
|
# @return [Hash<String, Object>]
|
732
739
|
def get_campaign_recipient_estimation(id, opts = {})
|
733
740
|
data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
|
@@ -738,7 +745,7 @@ module KlaviyoAPI
|
|
738
745
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
739
746
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
740
747
|
# @param [Hash] opts the optional parameters
|
741
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/
|
748
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
742
749
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
743
750
|
def get_campaign_recipient_estimation_with_http_info(id, opts = {})
|
744
751
|
if @api_client.config.debugging
|
@@ -762,7 +769,7 @@ module KlaviyoAPI
|
|
762
769
|
# header parameters
|
763
770
|
header_params = opts[:header_params] || {}
|
764
771
|
# klaviyo api revision
|
765
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
772
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
766
773
|
# HTTP header 'Accept' (if needed)
|
767
774
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
768
775
|
|
@@ -776,7 +783,7 @@ module KlaviyoAPI
|
|
776
783
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
777
784
|
|
778
785
|
# auth_names
|
779
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
786
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
780
787
|
|
781
788
|
new_options = opts.merge(
|
782
789
|
:operation => :"CampaignsApi.get_campaign_recipient_estimation",
|
@@ -799,7 +806,7 @@ module KlaviyoAPI
|
|
799
806
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
800
807
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
801
808
|
# @param [Hash] opts the optional parameters
|
802
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/
|
809
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
803
810
|
# @return [Hash<String, Object>]
|
804
811
|
def get_campaign_recipient_estimation_job(id, opts = {})
|
805
812
|
data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
|
@@ -810,7 +817,7 @@ module KlaviyoAPI
|
|
810
817
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
811
818
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
812
819
|
# @param [Hash] opts the optional parameters
|
813
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/
|
820
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
814
821
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
815
822
|
def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
|
816
823
|
if @api_client.config.debugging
|
@@ -834,7 +841,7 @@ module KlaviyoAPI
|
|
834
841
|
# header parameters
|
835
842
|
header_params = opts[:header_params] || {}
|
836
843
|
# klaviyo api revision
|
837
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
844
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
838
845
|
# HTTP header 'Accept' (if needed)
|
839
846
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
840
847
|
|
@@ -848,7 +855,7 @@ module KlaviyoAPI
|
|
848
855
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
849
856
|
|
850
857
|
# auth_names
|
851
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
858
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
852
859
|
|
853
860
|
new_options = opts.merge(
|
854
861
|
:operation => :"CampaignsApi.get_campaign_recipient_estimation_job",
|
@@ -871,7 +878,7 @@ module KlaviyoAPI
|
|
871
878
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
872
879
|
# @param id [String] The ID of the campaign to send
|
873
880
|
# @param [Hash] opts the optional parameters
|
874
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/
|
881
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
875
882
|
# @return [Hash<String, Object>]
|
876
883
|
def get_campaign_send_job(id, opts = {})
|
877
884
|
data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
|
@@ -882,7 +889,7 @@ module KlaviyoAPI
|
|
882
889
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
883
890
|
# @param id [String] The ID of the campaign to send
|
884
891
|
# @param [Hash] opts the optional parameters
|
885
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/
|
892
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
886
893
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
887
894
|
def get_campaign_send_job_with_http_info(id, opts = {})
|
888
895
|
if @api_client.config.debugging
|
@@ -906,7 +913,7 @@ module KlaviyoAPI
|
|
906
913
|
# header parameters
|
907
914
|
header_params = opts[:header_params] || {}
|
908
915
|
# klaviyo api revision
|
909
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
916
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
910
917
|
# HTTP header 'Accept' (if needed)
|
911
918
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
912
919
|
|
@@ -920,7 +927,7 @@ module KlaviyoAPI
|
|
920
927
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
921
928
|
|
922
929
|
# auth_names
|
923
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
930
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
924
931
|
|
925
932
|
new_options = opts.merge(
|
926
933
|
:operation => :"CampaignsApi.get_campaign_send_job",
|
@@ -939,46 +946,78 @@ module KlaviyoAPI
|
|
939
946
|
return data, status_code, headers
|
940
947
|
end
|
941
948
|
|
942
|
-
# Get
|
943
|
-
#
|
944
|
-
# @param
|
949
|
+
# Get Campaigns
|
950
|
+
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns. `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
951
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
945
952
|
# @param [Hash] opts the optional parameters
|
946
|
-
# @option opts [Array<String>] :
|
953
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
954
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
955
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
956
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
957
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
958
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
947
959
|
# @return [Hash<String, Object>]
|
948
|
-
def
|
949
|
-
data, _status_code, _headers =
|
960
|
+
def get_campaigns(filter, opts = {})
|
961
|
+
data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
|
950
962
|
data
|
951
963
|
end
|
952
964
|
|
953
|
-
# Get
|
954
|
-
#
|
955
|
-
# @param
|
965
|
+
# Get Campaigns
|
966
|
+
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns. `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
967
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
956
968
|
# @param [Hash] opts the optional parameters
|
957
|
-
# @option opts [Array<String>] :
|
969
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
970
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
971
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
972
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
973
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
974
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
958
975
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
959
|
-
def
|
976
|
+
def get_campaigns_with_http_info(filter, opts = {})
|
960
977
|
if @api_client.config.debugging
|
961
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
978
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...'
|
962
979
|
end
|
963
|
-
# verify the required parameter '
|
964
|
-
if @api_client.config.client_side_validation &&
|
965
|
-
fail ArgumentError, "Missing the required parameter '
|
980
|
+
# verify the required parameter 'filter' is set
|
981
|
+
if @api_client.config.client_side_validation && filter.nil?
|
982
|
+
fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns"
|
983
|
+
end
|
984
|
+
allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
|
985
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
986
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
987
|
+
end
|
988
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
989
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
990
|
+
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
966
991
|
end
|
967
992
|
allowable_values = ["name"]
|
968
993
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
969
994
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
970
995
|
end
|
996
|
+
allowable_values = ["campaign-messages", "tags"]
|
997
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
998
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
999
|
+
end
|
1000
|
+
allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at"]
|
1001
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1002
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1003
|
+
end
|
971
1004
|
# resource path
|
972
|
-
local_var_path = '/api/campaigns
|
1005
|
+
local_var_path = '/api/campaigns'
|
973
1006
|
|
974
1007
|
# query parameters
|
975
1008
|
query_params = opts[:query_params] || {}
|
1009
|
+
query_params[:'filter'] = filter
|
1010
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
1011
|
+
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
976
1012
|
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1013
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1014
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1015
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
977
1016
|
|
978
1017
|
# header parameters
|
979
1018
|
header_params = opts[:header_params] || {}
|
980
1019
|
# klaviyo api revision
|
981
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1020
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
982
1021
|
# HTTP header 'Accept' (if needed)
|
983
1022
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
984
1023
|
|
@@ -992,10 +1031,10 @@ module KlaviyoAPI
|
|
992
1031
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
993
1032
|
|
994
1033
|
# auth_names
|
995
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1034
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
996
1035
|
|
997
1036
|
new_options = opts.merge(
|
998
|
-
:operation => :"CampaignsApi.
|
1037
|
+
:operation => :"CampaignsApi.get_campaigns",
|
999
1038
|
:header_params => header_params,
|
1000
1039
|
:query_params => query_params,
|
1001
1040
|
:form_params => form_params,
|
@@ -1006,83 +1045,125 @@ module KlaviyoAPI
|
|
1006
1045
|
|
1007
1046
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1008
1047
|
if @api_client.config.debugging
|
1009
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1048
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1010
1049
|
end
|
1011
1050
|
return data, status_code, headers
|
1012
1051
|
end
|
1013
1052
|
|
1014
|
-
# Get
|
1015
|
-
#
|
1016
|
-
# @param
|
1053
|
+
# Get Image for Campaign Message
|
1054
|
+
# Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
|
1055
|
+
# @param id [String]
|
1017
1056
|
# @param [Hash] opts the optional parameters
|
1018
|
-
# @option opts [Array<String>] :
|
1019
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1020
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1021
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1022
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1023
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1057
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1024
1058
|
# @return [Hash<String, Object>]
|
1025
|
-
def
|
1026
|
-
data, _status_code, _headers =
|
1059
|
+
def get_image_for_campaign_message(id, opts = {})
|
1060
|
+
data, _status_code, _headers = get_image_for_campaign_message_with_http_info(id, opts)
|
1027
1061
|
data
|
1028
1062
|
end
|
1029
1063
|
|
1030
|
-
#
|
1031
|
-
|
1032
|
-
|
1064
|
+
# alias of `get_image_for_campaign_message`
|
1065
|
+
alias get_campaign_message_image get_image_for_campaign_message
|
1066
|
+
|
1067
|
+
# Get Image for Campaign Message
|
1068
|
+
# Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
|
1069
|
+
# @param id [String]
|
1033
1070
|
# @param [Hash] opts the optional parameters
|
1034
|
-
# @option opts [Array<String>] :
|
1035
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1036
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1037
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1038
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1039
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1071
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1040
1072
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1041
|
-
def
|
1073
|
+
def get_image_for_campaign_message_with_http_info(id, opts = {})
|
1042
1074
|
if @api_client.config.debugging
|
1043
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1075
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_image_for_campaign_message ...'
|
1044
1076
|
end
|
1045
|
-
# verify the required parameter '
|
1046
|
-
if @api_client.config.client_side_validation &&
|
1047
|
-
fail ArgumentError, "Missing the required parameter '
|
1048
|
-
end
|
1049
|
-
allowable_values = ["label", "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", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
|
1050
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
1051
|
-
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
1077
|
+
# verify the required parameter 'id' is set
|
1078
|
+
if @api_client.config.client_side_validation && id.nil?
|
1079
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_image_for_campaign_message"
|
1052
1080
|
end
|
1053
|
-
allowable_values = ["name", "
|
1054
|
-
if @api_client.config.client_side_validation && opts[:'
|
1055
|
-
fail ArgumentError, "invalid value for \"
|
1081
|
+
allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"]
|
1082
|
+
if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
|
1083
|
+
fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
|
1056
1084
|
end
|
1057
|
-
|
1058
|
-
|
1059
|
-
|
1085
|
+
# resource path
|
1086
|
+
local_var_path = '/api/campaign-messages/{id}/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1087
|
+
|
1088
|
+
# query parameters
|
1089
|
+
query_params = opts[:query_params] || {}
|
1090
|
+
query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
|
1091
|
+
|
1092
|
+
# header parameters
|
1093
|
+
header_params = opts[:header_params] || {}
|
1094
|
+
# klaviyo api revision
|
1095
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1096
|
+
# HTTP header 'Accept' (if needed)
|
1097
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1098
|
+
|
1099
|
+
# form parameters
|
1100
|
+
form_params = opts[:form_params] || {}
|
1101
|
+
|
1102
|
+
# http body (model)
|
1103
|
+
post_body = opts[:debug_body]
|
1104
|
+
|
1105
|
+
# return_type
|
1106
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1107
|
+
|
1108
|
+
# auth_names
|
1109
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1110
|
+
|
1111
|
+
new_options = opts.merge(
|
1112
|
+
:operation => :"CampaignsApi.get_image_for_campaign_message",
|
1113
|
+
:header_params => header_params,
|
1114
|
+
:query_params => query_params,
|
1115
|
+
:form_params => form_params,
|
1116
|
+
:body => post_body,
|
1117
|
+
:auth_names => auth_names,
|
1118
|
+
:return_type => return_type
|
1119
|
+
)
|
1120
|
+
|
1121
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1122
|
+
if @api_client.config.debugging
|
1123
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_image_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1060
1124
|
end
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
1125
|
+
return data, status_code, headers
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
# alias of `get_image_for_campaign_message_with_http_info`
|
1129
|
+
alias get_campaign_message_image_with_http_info get_image_for_campaign_message_with_http_info
|
1130
|
+
|
1131
|
+
# Get Image ID for Campaign Message
|
1132
|
+
# Returns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
|
1133
|
+
# @param id [String]
|
1134
|
+
# @param [Hash] opts the optional parameters
|
1135
|
+
# @return [Hash<String, Object>]
|
1136
|
+
def get_image_id_for_campaign_message(id, opts = {})
|
1137
|
+
data, _status_code, _headers = get_image_id_for_campaign_message_with_http_info(id, opts)
|
1138
|
+
data
|
1139
|
+
end
|
1140
|
+
|
1141
|
+
# alias of `get_image_id_for_campaign_message`
|
1142
|
+
alias get_campaign_message_relationships_image get_image_id_for_campaign_message
|
1143
|
+
|
1144
|
+
# Get Image ID for Campaign Message
|
1145
|
+
# Returns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
|
1146
|
+
# @param id [String]
|
1147
|
+
# @param [Hash] opts the optional parameters
|
1148
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1149
|
+
def get_image_id_for_campaign_message_with_http_info(id, opts = {})
|
1150
|
+
if @api_client.config.debugging
|
1151
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_image_id_for_campaign_message ...'
|
1064
1152
|
end
|
1065
|
-
|
1066
|
-
if @api_client.config.client_side_validation &&
|
1067
|
-
fail ArgumentError, "
|
1153
|
+
# verify the required parameter 'id' is set
|
1154
|
+
if @api_client.config.client_side_validation && id.nil?
|
1155
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_image_id_for_campaign_message"
|
1068
1156
|
end
|
1069
1157
|
# resource path
|
1070
|
-
local_var_path = '/api/
|
1158
|
+
local_var_path = '/api/campaign-messages/{id}/relationships/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1071
1159
|
|
1072
1160
|
# query parameters
|
1073
1161
|
query_params = opts[:query_params] || {}
|
1074
|
-
query_params[:'filter'] = filter
|
1075
|
-
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
1076
|
-
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
1077
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1078
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1079
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1080
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1081
1162
|
|
1082
1163
|
# header parameters
|
1083
1164
|
header_params = opts[:header_params] || {}
|
1084
1165
|
# klaviyo api revision
|
1085
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1166
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1086
1167
|
# HTTP header 'Accept' (if needed)
|
1087
1168
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1088
1169
|
|
@@ -1096,10 +1177,10 @@ module KlaviyoAPI
|
|
1096
1177
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1097
1178
|
|
1098
1179
|
# auth_names
|
1099
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1180
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1100
1181
|
|
1101
1182
|
new_options = opts.merge(
|
1102
|
-
:operation => :"CampaignsApi.
|
1183
|
+
:operation => :"CampaignsApi.get_image_id_for_campaign_message",
|
1103
1184
|
:header_params => header_params,
|
1104
1185
|
:query_params => query_params,
|
1105
1186
|
:form_params => form_params,
|
@@ -1110,11 +1191,14 @@ module KlaviyoAPI
|
|
1110
1191
|
|
1111
1192
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1112
1193
|
if @api_client.config.debugging
|
1113
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1194
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_image_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1114
1195
|
end
|
1115
1196
|
return data, status_code, headers
|
1116
1197
|
end
|
1117
1198
|
|
1199
|
+
# alias of `get_image_id_for_campaign_message_with_http_info`
|
1200
|
+
alias get_campaign_message_relationships_image_with_http_info get_image_id_for_campaign_message_with_http_info
|
1201
|
+
|
1118
1202
|
# Get Message IDs for Campaign
|
1119
1203
|
# Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1120
1204
|
# @param id [String]
|
@@ -1128,6 +1212,9 @@ module KlaviyoAPI
|
|
1128
1212
|
# alias of `get_message_ids_for_campaign`
|
1129
1213
|
alias get_campaign_relationships_campaign_messages get_message_ids_for_campaign
|
1130
1214
|
|
1215
|
+
# alias of `get_message_ids_for_campaign`
|
1216
|
+
alias get_campaign_relationships_messages get_message_ids_for_campaign
|
1217
|
+
|
1131
1218
|
# Get Message IDs for Campaign
|
1132
1219
|
# Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1133
1220
|
# @param id [String]
|
@@ -1150,7 +1237,7 @@ module KlaviyoAPI
|
|
1150
1237
|
# header parameters
|
1151
1238
|
header_params = opts[:header_params] || {}
|
1152
1239
|
# klaviyo api revision
|
1153
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1240
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1154
1241
|
# HTTP header 'Accept' (if needed)
|
1155
1242
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1156
1243
|
|
@@ -1164,7 +1251,7 @@ module KlaviyoAPI
|
|
1164
1251
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1165
1252
|
|
1166
1253
|
# auth_names
|
1167
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1254
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1168
1255
|
|
1169
1256
|
new_options = opts.merge(
|
1170
1257
|
:operation => :"CampaignsApi.get_message_ids_for_campaign",
|
@@ -1186,14 +1273,18 @@ module KlaviyoAPI
|
|
1186
1273
|
# alias of `get_message_ids_for_campaign_with_http_info`
|
1187
1274
|
alias get_campaign_relationships_campaign_messages_with_http_info get_message_ids_for_campaign_with_http_info
|
1188
1275
|
|
1276
|
+
# alias of `get_message_ids_for_campaign_with_http_info`
|
1277
|
+
alias get_campaign_relationships_messages_with_http_info get_message_ids_for_campaign_with_http_info
|
1278
|
+
|
1189
1279
|
# Get Messages for Campaign
|
1190
1280
|
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1191
1281
|
# @param id [String]
|
1192
1282
|
# @param [Hash] opts the optional parameters
|
1193
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/
|
1194
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
1195
|
-
# @option opts [Array<String>] :
|
1196
|
-
# @option opts [Array<String>] :
|
1283
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1284
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1285
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1286
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1287
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1197
1288
|
# @return [Hash<String, Object>]
|
1198
1289
|
def get_messages_for_campaign(id, opts = {})
|
1199
1290
|
data, _status_code, _headers = get_messages_for_campaign_with_http_info(id, opts)
|
@@ -1203,14 +1294,18 @@ module KlaviyoAPI
|
|
1203
1294
|
# alias of `get_messages_for_campaign`
|
1204
1295
|
alias get_campaign_campaign_messages get_messages_for_campaign
|
1205
1296
|
|
1297
|
+
# alias of `get_messages_for_campaign`
|
1298
|
+
alias get_campaign_messages get_messages_for_campaign
|
1299
|
+
|
1206
1300
|
# Get Messages for Campaign
|
1207
1301
|
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1208
1302
|
# @param id [String]
|
1209
1303
|
# @param [Hash] opts the optional parameters
|
1210
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/
|
1211
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/
|
1212
|
-
# @option opts [Array<String>] :
|
1213
|
-
# @option opts [Array<String>] :
|
1304
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1305
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1306
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1307
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1308
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
1214
1309
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1215
1310
|
def get_messages_for_campaign_with_http_info(id, opts = {})
|
1216
1311
|
if @api_client.config.debugging
|
@@ -1220,19 +1315,23 @@ module KlaviyoAPI
|
|
1220
1315
|
if @api_client.config.client_side_validation && id.nil?
|
1221
1316
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_messages_for_campaign"
|
1222
1317
|
end
|
1223
|
-
allowable_values = ["
|
1318
|
+
allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
|
1224
1319
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
1225
1320
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
1226
1321
|
end
|
1227
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.
|
1322
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
1228
1323
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
1229
1324
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
1230
1325
|
end
|
1326
|
+
allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"]
|
1327
|
+
if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
|
1328
|
+
fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
|
1329
|
+
end
|
1231
1330
|
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
1232
1331
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
1233
1332
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
1234
1333
|
end
|
1235
|
-
allowable_values = ["campaign", "template"]
|
1334
|
+
allowable_values = ["campaign", "image", "template"]
|
1236
1335
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1237
1336
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1238
1337
|
end
|
@@ -1243,13 +1342,14 @@ module KlaviyoAPI
|
|
1243
1342
|
query_params = opts[:query_params] || {}
|
1244
1343
|
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
1245
1344
|
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
1345
|
+
query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
|
1246
1346
|
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
1247
1347
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1248
1348
|
|
1249
1349
|
# header parameters
|
1250
1350
|
header_params = opts[:header_params] || {}
|
1251
1351
|
# klaviyo api revision
|
1252
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1352
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1253
1353
|
# HTTP header 'Accept' (if needed)
|
1254
1354
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1255
1355
|
|
@@ -1263,7 +1363,7 @@ module KlaviyoAPI
|
|
1263
1363
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1264
1364
|
|
1265
1365
|
# auth_names
|
1266
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1366
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1267
1367
|
|
1268
1368
|
new_options = opts.merge(
|
1269
1369
|
:operation => :"CampaignsApi.get_messages_for_campaign",
|
@@ -1285,6 +1385,9 @@ module KlaviyoAPI
|
|
1285
1385
|
# alias of `get_messages_for_campaign_with_http_info`
|
1286
1386
|
alias get_campaign_campaign_messages_with_http_info get_messages_for_campaign_with_http_info
|
1287
1387
|
|
1388
|
+
# alias of `get_messages_for_campaign_with_http_info`
|
1389
|
+
alias get_campaign_messages_with_http_info get_messages_for_campaign_with_http_info
|
1390
|
+
|
1288
1391
|
# Get Tag IDs for Campaign
|
1289
1392
|
# Returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
1290
1393
|
# @param id [String]
|
@@ -1320,7 +1423,7 @@ module KlaviyoAPI
|
|
1320
1423
|
# header parameters
|
1321
1424
|
header_params = opts[:header_params] || {}
|
1322
1425
|
# klaviyo api revision
|
1323
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1426
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1324
1427
|
# HTTP header 'Accept' (if needed)
|
1325
1428
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1326
1429
|
|
@@ -1334,7 +1437,7 @@ module KlaviyoAPI
|
|
1334
1437
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1335
1438
|
|
1336
1439
|
# auth_names
|
1337
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1440
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1338
1441
|
|
1339
1442
|
new_options = opts.merge(
|
1340
1443
|
:operation => :"CampaignsApi.get_tag_ids_for_campaign",
|
@@ -1356,11 +1459,89 @@ module KlaviyoAPI
|
|
1356
1459
|
# alias of `get_tag_ids_for_campaign_with_http_info`
|
1357
1460
|
alias get_campaign_relationships_tags_with_http_info get_tag_ids_for_campaign_with_http_info
|
1358
1461
|
|
1462
|
+
# Get Tags for Campaign
|
1463
|
+
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
1464
|
+
# @param id [String]
|
1465
|
+
# @param [Hash] opts the optional parameters
|
1466
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1467
|
+
# @return [Hash<String, Object>]
|
1468
|
+
def get_tags_for_campaign(id, opts = {})
|
1469
|
+
data, _status_code, _headers = get_tags_for_campaign_with_http_info(id, opts)
|
1470
|
+
data
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# alias of `get_tags_for_campaign`
|
1474
|
+
alias get_campaign_tags get_tags_for_campaign
|
1475
|
+
|
1476
|
+
# Get Tags for Campaign
|
1477
|
+
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
1478
|
+
# @param id [String]
|
1479
|
+
# @param [Hash] opts the optional parameters
|
1480
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1481
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1482
|
+
def get_tags_for_campaign_with_http_info(id, opts = {})
|
1483
|
+
if @api_client.config.debugging
|
1484
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_tags_for_campaign ...'
|
1485
|
+
end
|
1486
|
+
# verify the required parameter 'id' is set
|
1487
|
+
if @api_client.config.client_side_validation && id.nil?
|
1488
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_tags_for_campaign"
|
1489
|
+
end
|
1490
|
+
allowable_values = ["name"]
|
1491
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1492
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1493
|
+
end
|
1494
|
+
# resource path
|
1495
|
+
local_var_path = '/api/campaigns/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1496
|
+
|
1497
|
+
# query parameters
|
1498
|
+
query_params = opts[:query_params] || {}
|
1499
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1500
|
+
|
1501
|
+
# header parameters
|
1502
|
+
header_params = opts[:header_params] || {}
|
1503
|
+
# klaviyo api revision
|
1504
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1505
|
+
# HTTP header 'Accept' (if needed)
|
1506
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1507
|
+
|
1508
|
+
# form parameters
|
1509
|
+
form_params = opts[:form_params] || {}
|
1510
|
+
|
1511
|
+
# http body (model)
|
1512
|
+
post_body = opts[:debug_body]
|
1513
|
+
|
1514
|
+
# return_type
|
1515
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1516
|
+
|
1517
|
+
# auth_names
|
1518
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1519
|
+
|
1520
|
+
new_options = opts.merge(
|
1521
|
+
:operation => :"CampaignsApi.get_tags_for_campaign",
|
1522
|
+
:header_params => header_params,
|
1523
|
+
:query_params => query_params,
|
1524
|
+
:form_params => form_params,
|
1525
|
+
:body => post_body,
|
1526
|
+
:auth_names => auth_names,
|
1527
|
+
:return_type => return_type
|
1528
|
+
)
|
1529
|
+
|
1530
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1531
|
+
if @api_client.config.debugging
|
1532
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_tags_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1533
|
+
end
|
1534
|
+
return data, status_code, headers
|
1535
|
+
end
|
1536
|
+
|
1537
|
+
# alias of `get_tags_for_campaign_with_http_info`
|
1538
|
+
alias get_campaign_tags_with_http_info get_tags_for_campaign_with_http_info
|
1539
|
+
|
1359
1540
|
# Get Template for Campaign Message
|
1360
1541
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1361
1542
|
# @param id [String]
|
1362
1543
|
# @param [Hash] opts the optional parameters
|
1363
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/
|
1544
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1364
1545
|
# @return [Hash<String, Object>]
|
1365
1546
|
def get_template_for_campaign_message(id, opts = {})
|
1366
1547
|
data, _status_code, _headers = get_template_for_campaign_message_with_http_info(id, opts)
|
@@ -1374,7 +1555,7 @@ module KlaviyoAPI
|
|
1374
1555
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1375
1556
|
# @param id [String]
|
1376
1557
|
# @param [Hash] opts the optional parameters
|
1377
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/
|
1558
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
1378
1559
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1379
1560
|
def get_template_for_campaign_message_with_http_info(id, opts = {})
|
1380
1561
|
if @api_client.config.debugging
|
@@ -1398,7 +1579,7 @@ module KlaviyoAPI
|
|
1398
1579
|
# header parameters
|
1399
1580
|
header_params = opts[:header_params] || {}
|
1400
1581
|
# klaviyo api revision
|
1401
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1582
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1402
1583
|
# HTTP header 'Accept' (if needed)
|
1403
1584
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1404
1585
|
|
@@ -1412,7 +1593,7 @@ module KlaviyoAPI
|
|
1412
1593
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1413
1594
|
|
1414
1595
|
# auth_names
|
1415
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1596
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1416
1597
|
|
1417
1598
|
new_options = opts.merge(
|
1418
1599
|
:operation => :"CampaignsApi.get_template_for_campaign_message",
|
@@ -1469,7 +1650,7 @@ module KlaviyoAPI
|
|
1469
1650
|
# header parameters
|
1470
1651
|
header_params = opts[:header_params] || {}
|
1471
1652
|
# klaviyo api revision
|
1472
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1653
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1473
1654
|
# HTTP header 'Accept' (if needed)
|
1474
1655
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1475
1656
|
|
@@ -1483,7 +1664,7 @@ module KlaviyoAPI
|
|
1483
1664
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1484
1665
|
|
1485
1666
|
# auth_names
|
1486
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1667
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1487
1668
|
|
1488
1669
|
new_options = opts.merge(
|
1489
1670
|
:operation => :"CampaignsApi.get_template_id_for_campaign_message",
|
@@ -1540,7 +1721,7 @@ module KlaviyoAPI
|
|
1540
1721
|
# header parameters
|
1541
1722
|
header_params = opts[:header_params] || {}
|
1542
1723
|
# klaviyo api revision
|
1543
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1724
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1544
1725
|
# HTTP header 'Accept' (if needed)
|
1545
1726
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1546
1727
|
# HTTP header 'Content-Type'
|
@@ -1559,7 +1740,7 @@ module KlaviyoAPI
|
|
1559
1740
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1560
1741
|
|
1561
1742
|
# auth_names
|
1562
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1743
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1563
1744
|
|
1564
1745
|
new_options = opts.merge(
|
1565
1746
|
:operation => :"CampaignsApi.refresh_campaign_recipient_estimation",
|
@@ -1616,7 +1797,7 @@ module KlaviyoAPI
|
|
1616
1797
|
# header parameters
|
1617
1798
|
header_params = opts[:header_params] || {}
|
1618
1799
|
# klaviyo api revision
|
1619
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1800
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1620
1801
|
# HTTP header 'Accept' (if needed)
|
1621
1802
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1622
1803
|
# HTTP header 'Content-Type'
|
@@ -1635,7 +1816,7 @@ module KlaviyoAPI
|
|
1635
1816
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1636
1817
|
|
1637
1818
|
# auth_names
|
1638
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1819
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1639
1820
|
|
1640
1821
|
new_options = opts.merge(
|
1641
1822
|
:operation => :"CampaignsApi.send_campaign",
|
@@ -1695,7 +1876,7 @@ module KlaviyoAPI
|
|
1695
1876
|
# header parameters
|
1696
1877
|
header_params = opts[:header_params] || {}
|
1697
1878
|
# klaviyo api revision
|
1698
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1879
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1699
1880
|
# HTTP header 'Accept' (if needed)
|
1700
1881
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1701
1882
|
# HTTP header 'Content-Type'
|
@@ -1714,7 +1895,7 @@ module KlaviyoAPI
|
|
1714
1895
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1715
1896
|
|
1716
1897
|
# auth_names
|
1717
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1898
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1718
1899
|
|
1719
1900
|
new_options = opts.merge(
|
1720
1901
|
:operation => :"CampaignsApi.update_campaign",
|
@@ -1771,7 +1952,7 @@ module KlaviyoAPI
|
|
1771
1952
|
# header parameters
|
1772
1953
|
header_params = opts[:header_params] || {}
|
1773
1954
|
# klaviyo api revision
|
1774
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "
|
1955
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
1775
1956
|
# HTTP header 'Accept' (if needed)
|
1776
1957
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1777
1958
|
# HTTP header 'Content-Type'
|
@@ -1790,7 +1971,7 @@ module KlaviyoAPI
|
|
1790
1971
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1791
1972
|
|
1792
1973
|
# auth_names
|
1793
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1974
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1794
1975
|
|
1795
1976
|
new_options = opts.merge(
|
1796
1977
|
:operation => :"CampaignsApi.update_campaign_message",
|
@@ -1808,5 +1989,87 @@ module KlaviyoAPI
|
|
1808
1989
|
end
|
1809
1990
|
return data, status_code, headers
|
1810
1991
|
end
|
1992
|
+
|
1993
|
+
# Update Image for Campaign Message
|
1994
|
+
# Update a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write` `images:read`
|
1995
|
+
# @param id [String]
|
1996
|
+
# @param campaign_message_image_update_query [CampaignMessageImageUpdateQuery]
|
1997
|
+
# @param [Hash] opts the optional parameters
|
1998
|
+
# @return [nil]
|
1999
|
+
def update_image_for_campaign_message(id, campaign_message_image_update_query, opts = {})
|
2000
|
+
update_image_for_campaign_message_with_http_info(id, campaign_message_image_update_query, opts)
|
2001
|
+
nil
|
2002
|
+
end
|
2003
|
+
|
2004
|
+
# alias of `update_image_for_campaign_message`
|
2005
|
+
alias update_campaign_message_relationships_image update_image_for_campaign_message
|
2006
|
+
|
2007
|
+
# Update Image for Campaign Message
|
2008
|
+
# Update a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write` `images:read`
|
2009
|
+
# @param id [String]
|
2010
|
+
# @param campaign_message_image_update_query [CampaignMessageImageUpdateQuery]
|
2011
|
+
# @param [Hash] opts the optional parameters
|
2012
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2013
|
+
def update_image_for_campaign_message_with_http_info(id, campaign_message_image_update_query, opts = {})
|
2014
|
+
if @api_client.config.debugging
|
2015
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.update_image_for_campaign_message ...'
|
2016
|
+
end
|
2017
|
+
# verify the required parameter 'id' is set
|
2018
|
+
if @api_client.config.client_side_validation && id.nil?
|
2019
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_image_for_campaign_message"
|
2020
|
+
end
|
2021
|
+
# verify the required parameter 'campaign_message_image_update_query' is set
|
2022
|
+
if @api_client.config.client_side_validation && campaign_message_image_update_query.nil?
|
2023
|
+
fail ArgumentError, "Missing the required parameter 'campaign_message_image_update_query' when calling CampaignsApi.update_image_for_campaign_message"
|
2024
|
+
end
|
2025
|
+
# resource path
|
2026
|
+
local_var_path = '/api/campaign-messages/{id}/relationships/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
2027
|
+
|
2028
|
+
# query parameters
|
2029
|
+
query_params = opts[:query_params] || {}
|
2030
|
+
|
2031
|
+
# header parameters
|
2032
|
+
header_params = opts[:header_params] || {}
|
2033
|
+
# klaviyo api revision
|
2034
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
|
2035
|
+
# HTTP header 'Accept' (if needed)
|
2036
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2037
|
+
# HTTP header 'Content-Type'
|
2038
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
2039
|
+
if !content_type.nil?
|
2040
|
+
header_params['Content-Type'] = content_type
|
2041
|
+
end
|
2042
|
+
|
2043
|
+
# form parameters
|
2044
|
+
form_params = opts[:form_params] || {}
|
2045
|
+
|
2046
|
+
# http body (model)
|
2047
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_message_image_update_query)
|
2048
|
+
|
2049
|
+
# return_type
|
2050
|
+
return_type = opts[:debug_return_type]
|
2051
|
+
|
2052
|
+
# auth_names
|
2053
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2054
|
+
|
2055
|
+
new_options = opts.merge(
|
2056
|
+
:operation => :"CampaignsApi.update_image_for_campaign_message",
|
2057
|
+
:header_params => header_params,
|
2058
|
+
:query_params => query_params,
|
2059
|
+
:form_params => form_params,
|
2060
|
+
:body => post_body,
|
2061
|
+
:auth_names => auth_names,
|
2062
|
+
:return_type => return_type
|
2063
|
+
)
|
2064
|
+
|
2065
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
2066
|
+
if @api_client.config.debugging
|
2067
|
+
@api_client.config.logger.debug "API called: CampaignsApi#update_image_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2068
|
+
end
|
2069
|
+
return data, status_code, headers
|
2070
|
+
end
|
2071
|
+
|
2072
|
+
# alias of `update_image_for_campaign_message_with_http_info`
|
2073
|
+
alias update_campaign_message_relationships_image_with_http_info update_image_for_campaign_message_with_http_info
|
1811
2074
|
end
|
1812
2075
|
end
|