klaviyo-api-sdk 9.0.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +1272 -524
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1720 -1576
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +317 -287
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +5 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +134 -122
- data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
- data/lib/klaviyo-api-sdk/api/forms_api.rb +56 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +28 -28
- data/lib/klaviyo-api-sdk/api/lists_api.rb +316 -153
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +582 -19
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +1046 -603
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +323 -19
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
- data/lib/klaviyo-api-sdk/api/tags_api.rb +741 -645
- data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +274 -0
- data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +245 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +3 -3
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +14 -10
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +90 -22
- metadata +59 -4
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2024-
|
6
|
+
The version of the OpenAPI document: 2024-10-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -19,31 +19,34 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
# Creates a
|
24
|
-
# @param
|
22
|
+
# Assign Template to Campaign Message
|
23
|
+
# Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
24
|
+
# @param campaign_message_assign_template_query [CampaignMessageAssignTemplateQuery] Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Hash<String, Object>]
|
27
|
-
def
|
28
|
-
data, _status_code, _headers =
|
27
|
+
def assign_template_to_campaign_message(campaign_message_assign_template_query, opts = {})
|
28
|
+
data, _status_code, _headers = assign_template_to_campaign_message_with_http_info(campaign_message_assign_template_query, opts)
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
|
-
#
|
33
|
-
|
34
|
-
|
32
|
+
# alias of `assign_template_to_campaign_message`
|
33
|
+
alias create_campaign_message_assign_template assign_template_to_campaign_message
|
34
|
+
|
35
|
+
# Assign Template to Campaign Message
|
36
|
+
# Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
37
|
+
# @param campaign_message_assign_template_query [CampaignMessageAssignTemplateQuery] Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
|
35
38
|
# @param [Hash] opts the optional parameters
|
36
39
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
37
|
-
def
|
40
|
+
def assign_template_to_campaign_message_with_http_info(campaign_message_assign_template_query, opts = {})
|
38
41
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
42
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.assign_template_to_campaign_message ...'
|
40
43
|
end
|
41
|
-
# verify the required parameter '
|
42
|
-
if @api_client.config.client_side_validation &&
|
43
|
-
fail ArgumentError, "Missing the required parameter '
|
44
|
+
# verify the required parameter 'campaign_message_assign_template_query' is set
|
45
|
+
if @api_client.config.client_side_validation && campaign_message_assign_template_query.nil?
|
46
|
+
fail ArgumentError, "Missing the required parameter 'campaign_message_assign_template_query' when calling CampaignsApi.assign_template_to_campaign_message"
|
44
47
|
end
|
45
48
|
# resource path
|
46
|
-
local_var_path = '/api/
|
49
|
+
local_var_path = '/api/campaign-message-assign-template'
|
47
50
|
|
48
51
|
# query parameters
|
49
52
|
query_params = opts[:query_params] || {}
|
@@ -51,11 +54,11 @@ module KlaviyoAPI
|
|
51
54
|
# header parameters
|
52
55
|
header_params = opts[:header_params] || {}
|
53
56
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
57
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
55
58
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
59
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
60
|
# HTTP header 'Content-Type'
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
61
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
59
62
|
if !content_type.nil?
|
60
63
|
header_params['Content-Type'] = content_type
|
61
64
|
end
|
@@ -64,7 +67,7 @@ module KlaviyoAPI
|
|
64
67
|
form_params = opts[:form_params] || {}
|
65
68
|
|
66
69
|
# http body (model)
|
67
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
70
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_message_assign_template_query)
|
68
71
|
|
69
72
|
# return_type
|
70
73
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -73,7 +76,7 @@ module KlaviyoAPI
|
|
73
76
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
74
77
|
|
75
78
|
new_options = opts.merge(
|
76
|
-
:operation => :"CampaignsApi.
|
79
|
+
:operation => :"CampaignsApi.assign_template_to_campaign_message",
|
77
80
|
:header_params => header_params,
|
78
81
|
:query_params => query_params,
|
79
82
|
:form_params => form_params,
|
@@ -84,106 +87,48 @@ module KlaviyoAPI
|
|
84
87
|
|
85
88
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
86
89
|
if @api_client.config.debugging
|
87
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
90
|
+
@api_client.config.logger.debug "API called: CampaignsApi#assign_template_to_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
91
|
end
|
89
92
|
return data, status_code, headers
|
90
93
|
end
|
91
94
|
|
92
|
-
#
|
93
|
-
|
94
|
-
# @param campaign_clone_query [CampaignCloneQuery] Clones a campaign from an existing campaign
|
95
|
-
# @param [Hash] opts the optional parameters
|
96
|
-
# @return [Hash<String, Object>]
|
97
|
-
def create_campaign_clone(campaign_clone_query, opts = {})
|
98
|
-
data, _status_code, _headers = create_campaign_clone_with_http_info(campaign_clone_query, opts)
|
99
|
-
data
|
100
|
-
end
|
95
|
+
# alias of `assign_template_to_campaign_message_with_http_info`
|
96
|
+
alias create_campaign_message_assign_template_with_http_info assign_template_to_campaign_message_with_http_info
|
101
97
|
|
102
|
-
#
|
103
|
-
#
|
104
|
-
# @param
|
98
|
+
# Cancel Campaign Send
|
99
|
+
# Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
100
|
+
# @param id [String] The ID of the currently sending campaign to cancel or revert
|
101
|
+
# @param campaign_send_job_partial_update_query [CampaignSendJobPartialUpdateQuery] Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
|
105
102
|
# @param [Hash] opts the optional parameters
|
106
|
-
# @return [
|
107
|
-
def
|
108
|
-
|
109
|
-
|
110
|
-
end
|
111
|
-
# verify the required parameter 'campaign_clone_query' is set
|
112
|
-
if @api_client.config.client_side_validation && campaign_clone_query.nil?
|
113
|
-
fail ArgumentError, "Missing the required parameter 'campaign_clone_query' when calling CampaignsApi.create_campaign_clone"
|
114
|
-
end
|
115
|
-
# resource path
|
116
|
-
local_var_path = '/api/campaign-clone/'
|
117
|
-
|
118
|
-
# query parameters
|
119
|
-
query_params = opts[:query_params] || {}
|
120
|
-
|
121
|
-
# header parameters
|
122
|
-
header_params = opts[:header_params] || {}
|
123
|
-
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
|
125
|
-
# HTTP header 'Accept' (if needed)
|
126
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
|
-
# HTTP header 'Content-Type'
|
128
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
129
|
-
if !content_type.nil?
|
130
|
-
header_params['Content-Type'] = content_type
|
131
|
-
end
|
132
|
-
|
133
|
-
# form parameters
|
134
|
-
form_params = opts[:form_params] || {}
|
135
|
-
|
136
|
-
# http body (model)
|
137
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_clone_query)
|
138
|
-
|
139
|
-
# return_type
|
140
|
-
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
141
|
-
|
142
|
-
# auth_names
|
143
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
144
|
-
|
145
|
-
new_options = opts.merge(
|
146
|
-
:operation => :"CampaignsApi.create_campaign_clone",
|
147
|
-
:header_params => header_params,
|
148
|
-
:query_params => query_params,
|
149
|
-
:form_params => form_params,
|
150
|
-
:body => post_body,
|
151
|
-
:auth_names => auth_names,
|
152
|
-
:return_type => return_type
|
153
|
-
)
|
154
|
-
|
155
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
156
|
-
if @api_client.config.debugging
|
157
|
-
@api_client.config.logger.debug "API called: CampaignsApi#create_campaign_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
158
|
-
end
|
159
|
-
return data, status_code, headers
|
103
|
+
# @return [nil]
|
104
|
+
def cancel_campaign_send(id, campaign_send_job_partial_update_query, opts = {})
|
105
|
+
cancel_campaign_send_with_http_info(id, campaign_send_job_partial_update_query, opts)
|
106
|
+
nil
|
160
107
|
end
|
161
108
|
|
162
|
-
#
|
163
|
-
|
164
|
-
# @param campaign_message_assign_template_query [CampaignMessageAssignTemplateQuery] Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
|
165
|
-
# @param [Hash] opts the optional parameters
|
166
|
-
# @return [Hash<String, Object>]
|
167
|
-
def create_campaign_message_assign_template(campaign_message_assign_template_query, opts = {})
|
168
|
-
data, _status_code, _headers = create_campaign_message_assign_template_with_http_info(campaign_message_assign_template_query, opts)
|
169
|
-
data
|
170
|
-
end
|
109
|
+
# alias of `cancel_campaign_send`
|
110
|
+
alias update_campaign_send_job cancel_campaign_send
|
171
111
|
|
172
|
-
#
|
173
|
-
#
|
174
|
-
# @param
|
112
|
+
# Cancel Campaign Send
|
113
|
+
# Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
114
|
+
# @param id [String] The ID of the currently sending campaign to cancel or revert
|
115
|
+
# @param campaign_send_job_partial_update_query [CampaignSendJobPartialUpdateQuery] Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
|
175
116
|
# @param [Hash] opts the optional parameters
|
176
|
-
# @return [Array<(
|
177
|
-
def
|
117
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
118
|
+
def cancel_campaign_send_with_http_info(id, campaign_send_job_partial_update_query, opts = {})
|
178
119
|
if @api_client.config.debugging
|
179
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
120
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.cancel_campaign_send ...'
|
180
121
|
end
|
181
|
-
# verify the required parameter '
|
182
|
-
if @api_client.config.client_side_validation &&
|
183
|
-
fail ArgumentError, "Missing the required parameter '
|
122
|
+
# verify the required parameter 'id' is set
|
123
|
+
if @api_client.config.client_side_validation && id.nil?
|
124
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.cancel_campaign_send"
|
125
|
+
end
|
126
|
+
# verify the required parameter 'campaign_send_job_partial_update_query' is set
|
127
|
+
if @api_client.config.client_side_validation && campaign_send_job_partial_update_query.nil?
|
128
|
+
fail ArgumentError, "Missing the required parameter 'campaign_send_job_partial_update_query' when calling CampaignsApi.cancel_campaign_send"
|
184
129
|
end
|
185
130
|
# resource path
|
186
|
-
local_var_path = '/api/campaign-
|
131
|
+
local_var_path = '/api/campaign-send-jobs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
187
132
|
|
188
133
|
# query parameters
|
189
134
|
query_params = opts[:query_params] || {}
|
@@ -191,11 +136,11 @@ module KlaviyoAPI
|
|
191
136
|
# header parameters
|
192
137
|
header_params = opts[:header_params] || {}
|
193
138
|
# klaviyo api revision
|
194
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
139
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
195
140
|
# HTTP header 'Accept' (if needed)
|
196
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
141
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
197
142
|
# HTTP header 'Content-Type'
|
198
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
143
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
199
144
|
if !content_type.nil?
|
200
145
|
header_params['Content-Type'] = content_type
|
201
146
|
end
|
@@ -204,16 +149,16 @@ module KlaviyoAPI
|
|
204
149
|
form_params = opts[:form_params] || {}
|
205
150
|
|
206
151
|
# http body (model)
|
207
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
152
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_send_job_partial_update_query)
|
208
153
|
|
209
154
|
# return_type
|
210
|
-
return_type = opts[:debug_return_type]
|
155
|
+
return_type = opts[:debug_return_type]
|
211
156
|
|
212
157
|
# auth_names
|
213
158
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
214
159
|
|
215
160
|
new_options = opts.merge(
|
216
|
-
:operation => :"CampaignsApi.
|
161
|
+
:operation => :"CampaignsApi.cancel_campaign_send",
|
217
162
|
:header_params => header_params,
|
218
163
|
:query_params => query_params,
|
219
164
|
:form_params => form_params,
|
@@ -222,38 +167,41 @@ module KlaviyoAPI
|
|
222
167
|
:return_type => return_type
|
223
168
|
)
|
224
169
|
|
225
|
-
data, status_code, headers = @api_client.call_api(:
|
170
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
226
171
|
if @api_client.config.debugging
|
227
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
172
|
+
@api_client.config.logger.debug "API called: CampaignsApi#cancel_campaign_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
228
173
|
end
|
229
174
|
return data, status_code, headers
|
230
175
|
end
|
231
176
|
|
232
|
-
#
|
233
|
-
|
234
|
-
|
177
|
+
# alias of `cancel_campaign_send_with_http_info`
|
178
|
+
alias update_campaign_send_job_with_http_info cancel_campaign_send_with_http_info
|
179
|
+
|
180
|
+
# Create Campaign
|
181
|
+
# Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
182
|
+
# @param campaign_create_query [CampaignCreateQuery] Creates a campaign from parameters
|
235
183
|
# @param [Hash] opts the optional parameters
|
236
184
|
# @return [Hash<String, Object>]
|
237
|
-
def
|
238
|
-
data, _status_code, _headers =
|
185
|
+
def create_campaign(campaign_create_query, opts = {})
|
186
|
+
data, _status_code, _headers = create_campaign_with_http_info(campaign_create_query, opts)
|
239
187
|
data
|
240
188
|
end
|
241
189
|
|
242
|
-
# Create Campaign
|
243
|
-
#
|
244
|
-
# @param
|
190
|
+
# Create Campaign
|
191
|
+
# Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
192
|
+
# @param campaign_create_query [CampaignCreateQuery] Creates a campaign from parameters
|
245
193
|
# @param [Hash] opts the optional parameters
|
246
194
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
247
|
-
def
|
195
|
+
def create_campaign_with_http_info(campaign_create_query, opts = {})
|
248
196
|
if @api_client.config.debugging
|
249
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
197
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.create_campaign ...'
|
250
198
|
end
|
251
|
-
# verify the required parameter '
|
252
|
-
if @api_client.config.client_side_validation &&
|
253
|
-
fail ArgumentError, "Missing the required parameter '
|
199
|
+
# verify the required parameter 'campaign_create_query' is set
|
200
|
+
if @api_client.config.client_side_validation && campaign_create_query.nil?
|
201
|
+
fail ArgumentError, "Missing the required parameter 'campaign_create_query' when calling CampaignsApi.create_campaign"
|
254
202
|
end
|
255
203
|
# resource path
|
256
|
-
local_var_path = '/api/
|
204
|
+
local_var_path = '/api/campaigns'
|
257
205
|
|
258
206
|
# query parameters
|
259
207
|
query_params = opts[:query_params] || {}
|
@@ -261,11 +209,11 @@ module KlaviyoAPI
|
|
261
209
|
# header parameters
|
262
210
|
header_params = opts[:header_params] || {}
|
263
211
|
# klaviyo api revision
|
264
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
212
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
265
213
|
# HTTP header 'Accept' (if needed)
|
266
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
267
215
|
# HTTP header 'Content-Type'
|
268
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
216
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
269
217
|
if !content_type.nil?
|
270
218
|
header_params['Content-Type'] = content_type
|
271
219
|
end
|
@@ -274,7 +222,7 @@ module KlaviyoAPI
|
|
274
222
|
form_params = opts[:form_params] || {}
|
275
223
|
|
276
224
|
# http body (model)
|
277
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
225
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_create_query)
|
278
226
|
|
279
227
|
# return_type
|
280
228
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -283,7 +231,7 @@ module KlaviyoAPI
|
|
283
231
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
284
232
|
|
285
233
|
new_options = opts.merge(
|
286
|
-
:operation => :"CampaignsApi.
|
234
|
+
:operation => :"CampaignsApi.create_campaign",
|
287
235
|
:header_params => header_params,
|
288
236
|
:query_params => query_params,
|
289
237
|
:form_params => form_params,
|
@@ -294,36 +242,39 @@ module KlaviyoAPI
|
|
294
242
|
|
295
243
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
296
244
|
if @api_client.config.debugging
|
297
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
245
|
+
@api_client.config.logger.debug "API called: CampaignsApi#create_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
298
246
|
end
|
299
247
|
return data, status_code, headers
|
300
248
|
end
|
301
249
|
|
302
|
-
# Create Campaign
|
303
|
-
#
|
304
|
-
# @param
|
250
|
+
# Create Campaign Clone
|
251
|
+
# Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
252
|
+
# @param campaign_clone_query [CampaignCloneQuery] Clones a campaign from an existing campaign
|
305
253
|
# @param [Hash] opts the optional parameters
|
306
254
|
# @return [Hash<String, Object>]
|
307
|
-
def
|
308
|
-
data, _status_code, _headers =
|
255
|
+
def create_campaign_clone(campaign_clone_query, opts = {})
|
256
|
+
data, _status_code, _headers = create_campaign_clone_with_http_info(campaign_clone_query, opts)
|
309
257
|
data
|
310
258
|
end
|
311
259
|
|
312
|
-
#
|
313
|
-
|
314
|
-
|
260
|
+
# alias of `create_campaign_clone`
|
261
|
+
alias clone_campaign create_campaign_clone
|
262
|
+
|
263
|
+
# Create Campaign Clone
|
264
|
+
# Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
265
|
+
# @param campaign_clone_query [CampaignCloneQuery] Clones a campaign from an existing campaign
|
315
266
|
# @param [Hash] opts the optional parameters
|
316
267
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
317
|
-
def
|
268
|
+
def create_campaign_clone_with_http_info(campaign_clone_query, opts = {})
|
318
269
|
if @api_client.config.debugging
|
319
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
270
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.create_campaign_clone ...'
|
320
271
|
end
|
321
|
-
# verify the required parameter '
|
322
|
-
if @api_client.config.client_side_validation &&
|
323
|
-
fail ArgumentError, "Missing the required parameter '
|
272
|
+
# verify the required parameter 'campaign_clone_query' is set
|
273
|
+
if @api_client.config.client_side_validation && campaign_clone_query.nil?
|
274
|
+
fail ArgumentError, "Missing the required parameter 'campaign_clone_query' when calling CampaignsApi.create_campaign_clone"
|
324
275
|
end
|
325
276
|
# resource path
|
326
|
-
local_var_path = '/api/campaign-
|
277
|
+
local_var_path = '/api/campaign-clone'
|
327
278
|
|
328
279
|
# query parameters
|
329
280
|
query_params = opts[:query_params] || {}
|
@@ -331,11 +282,11 @@ module KlaviyoAPI
|
|
331
282
|
# header parameters
|
332
283
|
header_params = opts[:header_params] || {}
|
333
284
|
# klaviyo api revision
|
334
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
335
286
|
# HTTP header 'Accept' (if needed)
|
336
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
287
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
337
288
|
# HTTP header 'Content-Type'
|
338
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
289
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
339
290
|
if !content_type.nil?
|
340
291
|
header_params['Content-Type'] = content_type
|
341
292
|
end
|
@@ -344,7 +295,7 @@ module KlaviyoAPI
|
|
344
295
|
form_params = opts[:form_params] || {}
|
345
296
|
|
346
297
|
# http body (model)
|
347
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
298
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_clone_query)
|
348
299
|
|
349
300
|
# return_type
|
350
301
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -353,7 +304,7 @@ module KlaviyoAPI
|
|
353
304
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
354
305
|
|
355
306
|
new_options = opts.merge(
|
356
|
-
:operation => :"CampaignsApi.
|
307
|
+
:operation => :"CampaignsApi.create_campaign_clone",
|
357
308
|
:header_params => header_params,
|
358
309
|
:query_params => query_params,
|
359
310
|
:form_params => form_params,
|
@@ -364,11 +315,14 @@ module KlaviyoAPI
|
|
364
315
|
|
365
316
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
366
317
|
if @api_client.config.debugging
|
367
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
318
|
+
@api_client.config.logger.debug "API called: CampaignsApi#create_campaign_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
368
319
|
end
|
369
320
|
return data, status_code, headers
|
370
321
|
end
|
371
322
|
|
323
|
+
# alias of `create_campaign_clone_with_http_info`
|
324
|
+
alias clone_campaign_with_http_info create_campaign_clone_with_http_info
|
325
|
+
|
372
326
|
# Delete Campaign
|
373
327
|
# Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
374
328
|
# @param id [String] The campaign ID to be deleted
|
@@ -393,7 +347,7 @@ module KlaviyoAPI
|
|
393
347
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.delete_campaign"
|
394
348
|
end
|
395
349
|
# resource path
|
396
|
-
local_var_path = '/api/campaigns/{id}
|
350
|
+
local_var_path = '/api/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
397
351
|
|
398
352
|
# query parameters
|
399
353
|
query_params = opts[:query_params] || {}
|
@@ -401,9 +355,9 @@ module KlaviyoAPI
|
|
401
355
|
# header parameters
|
402
356
|
header_params = opts[:header_params] || {}
|
403
357
|
# klaviyo api revision
|
404
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
358
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
405
359
|
# HTTP header 'Accept' (if needed)
|
406
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
360
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
407
361
|
|
408
362
|
# form parameters
|
409
363
|
form_params = opts[:form_params] || {}
|
@@ -438,10 +392,10 @@ module KlaviyoAPI
|
|
438
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`
|
439
393
|
# @param id [String] The campaign ID to be retrieved
|
440
394
|
# @param [Hash] opts the optional parameters
|
441
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-
|
442
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-
|
443
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-
|
444
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
395
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
396
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
397
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
398
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
445
399
|
# @return [Hash<String, Object>]
|
446
400
|
def get_campaign(id, opts = {})
|
447
401
|
data, _status_code, _headers = get_campaign_with_http_info(id, opts)
|
@@ -452,10 +406,10 @@ module KlaviyoAPI
|
|
452
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`
|
453
407
|
# @param id [String] The campaign ID to be retrieved
|
454
408
|
# @param [Hash] opts the optional parameters
|
455
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-
|
456
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-
|
457
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-
|
458
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
409
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
410
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
411
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
412
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
459
413
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
460
414
|
def get_campaign_with_http_info(id, opts = {})
|
461
415
|
if @api_client.config.debugging
|
@@ -465,11 +419,11 @@ module KlaviyoAPI
|
|
465
419
|
if @api_client.config.client_side_validation && id.nil?
|
466
420
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign"
|
467
421
|
end
|
468
|
-
allowable_values = ["label", "channel", "content", "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"]
|
422
|
+
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"]
|
469
423
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
470
424
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
471
425
|
end
|
472
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
426
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
473
427
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
474
428
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
475
429
|
end
|
@@ -482,7 +436,7 @@ module KlaviyoAPI
|
|
482
436
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
483
437
|
end
|
484
438
|
# resource path
|
485
|
-
local_var_path = '/api/campaigns/{id}
|
439
|
+
local_var_path = '/api/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
486
440
|
|
487
441
|
# query parameters
|
488
442
|
query_params = opts[:query_params] || {}
|
@@ -494,9 +448,9 @@ module KlaviyoAPI
|
|
494
448
|
# header parameters
|
495
449
|
header_params = opts[:header_params] || {}
|
496
450
|
# klaviyo api revision
|
497
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
451
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
498
452
|
# HTTP header 'Accept' (if needed)
|
499
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
453
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
500
454
|
|
501
455
|
# form parameters
|
502
456
|
form_params = opts[:form_params] || {}
|
@@ -527,69 +481,51 @@ module KlaviyoAPI
|
|
527
481
|
return data, status_code, headers
|
528
482
|
end
|
529
483
|
|
530
|
-
# Get Campaign Campaign
|
531
|
-
# Return
|
484
|
+
# Get Campaign for Campaign Message
|
485
|
+
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
532
486
|
# @param id [String]
|
533
487
|
# @param [Hash] opts the optional parameters
|
534
|
-
# @option opts [Array<String>] :
|
535
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
536
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
537
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
488
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
538
489
|
# @return [Hash<String, Object>]
|
539
|
-
def
|
540
|
-
data, _status_code, _headers =
|
490
|
+
def get_campaign_for_campaign_message(id, opts = {})
|
491
|
+
data, _status_code, _headers = get_campaign_for_campaign_message_with_http_info(id, opts)
|
541
492
|
data
|
542
493
|
end
|
543
494
|
|
544
|
-
#
|
545
|
-
|
495
|
+
# alias of `get_campaign_for_campaign_message`
|
496
|
+
alias get_campaign_message_campaign get_campaign_for_campaign_message
|
497
|
+
|
498
|
+
# Get Campaign for Campaign Message
|
499
|
+
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
546
500
|
# @param id [String]
|
547
501
|
# @param [Hash] opts the optional parameters
|
548
|
-
# @option opts [Array<String>] :
|
549
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
550
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
551
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
502
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
552
503
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
553
|
-
def
|
504
|
+
def get_campaign_for_campaign_message_with_http_info(id, opts = {})
|
554
505
|
if @api_client.config.debugging
|
555
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
506
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_for_campaign_message ...'
|
556
507
|
end
|
557
508
|
# verify the required parameter 'id' is set
|
558
509
|
if @api_client.config.client_side_validation && id.nil?
|
559
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
560
|
-
end
|
561
|
-
allowable_values = ["label", "channel", "content", "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"]
|
562
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
563
|
-
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
510
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_for_campaign_message"
|
564
511
|
end
|
565
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
512
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
566
513
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
567
514
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
568
515
|
end
|
569
|
-
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
570
|
-
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
571
|
-
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
572
|
-
end
|
573
|
-
allowable_values = ["campaign", "template"]
|
574
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
575
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
576
|
-
end
|
577
516
|
# resource path
|
578
|
-
local_var_path = '/api/
|
517
|
+
local_var_path = '/api/campaign-messages/{id}/campaign'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
579
518
|
|
580
519
|
# query parameters
|
581
520
|
query_params = opts[:query_params] || {}
|
582
|
-
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
583
521
|
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
584
|
-
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
585
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
586
522
|
|
587
523
|
# header parameters
|
588
524
|
header_params = opts[:header_params] || {}
|
589
525
|
# klaviyo api revision
|
590
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
526
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
591
527
|
# HTTP header 'Accept' (if needed)
|
592
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
528
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
593
529
|
|
594
530
|
# form parameters
|
595
531
|
form_params = opts[:form_params] || {}
|
@@ -604,7 +540,7 @@ module KlaviyoAPI
|
|
604
540
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
605
541
|
|
606
542
|
new_options = opts.merge(
|
607
|
-
:operation => :"CampaignsApi.
|
543
|
+
:operation => :"CampaignsApi.get_campaign_for_campaign_message",
|
608
544
|
:header_params => header_params,
|
609
545
|
:query_params => query_params,
|
610
546
|
:form_params => form_params,
|
@@ -615,74 +551,52 @@ module KlaviyoAPI
|
|
615
551
|
|
616
552
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
617
553
|
if @api_client.config.debugging
|
618
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
554
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
619
555
|
end
|
620
556
|
return data, status_code, headers
|
621
557
|
end
|
622
558
|
|
623
|
-
#
|
624
|
-
|
625
|
-
|
559
|
+
# alias of `get_campaign_for_campaign_message_with_http_info`
|
560
|
+
alias get_campaign_message_campaign_with_http_info get_campaign_for_campaign_message_with_http_info
|
561
|
+
|
562
|
+
# Get Campaign ID for Campaign Message
|
563
|
+
# Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
564
|
+
# @param id [String]
|
626
565
|
# @param [Hash] opts the optional parameters
|
627
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
628
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
629
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
630
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
631
566
|
# @return [Hash<String, Object>]
|
632
|
-
def
|
633
|
-
data, _status_code, _headers =
|
567
|
+
def get_campaign_id_for_campaign_message(id, opts = {})
|
568
|
+
data, _status_code, _headers = get_campaign_id_for_campaign_message_with_http_info(id, opts)
|
634
569
|
data
|
635
570
|
end
|
636
571
|
|
637
|
-
#
|
638
|
-
|
639
|
-
|
572
|
+
# alias of `get_campaign_id_for_campaign_message`
|
573
|
+
alias get_campaign_message_relationships_campaign get_campaign_id_for_campaign_message
|
574
|
+
|
575
|
+
# Get Campaign ID for Campaign Message
|
576
|
+
# Returns the ID of the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
577
|
+
# @param id [String]
|
640
578
|
# @param [Hash] opts the optional parameters
|
641
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
642
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
643
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
644
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
645
579
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
646
|
-
def
|
580
|
+
def get_campaign_id_for_campaign_message_with_http_info(id, opts = {})
|
647
581
|
if @api_client.config.debugging
|
648
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
582
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_id_for_campaign_message ...'
|
649
583
|
end
|
650
584
|
# verify the required parameter 'id' is set
|
651
585
|
if @api_client.config.client_side_validation && id.nil?
|
652
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
653
|
-
end
|
654
|
-
allowable_values = ["label", "channel", "content", "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"]
|
655
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
656
|
-
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
657
|
-
end
|
658
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
659
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
660
|
-
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
661
|
-
end
|
662
|
-
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
663
|
-
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
664
|
-
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
665
|
-
end
|
666
|
-
allowable_values = ["campaign", "template"]
|
667
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
668
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
586
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_id_for_campaign_message"
|
669
587
|
end
|
670
588
|
# resource path
|
671
|
-
local_var_path = '/api/campaign-messages/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
589
|
+
local_var_path = '/api/campaign-messages/{id}/relationships/campaign'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
672
590
|
|
673
591
|
# query parameters
|
674
592
|
query_params = opts[:query_params] || {}
|
675
|
-
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
676
|
-
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
677
|
-
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
678
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
679
593
|
|
680
594
|
# header parameters
|
681
595
|
header_params = opts[:header_params] || {}
|
682
596
|
# klaviyo api revision
|
683
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
597
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
684
598
|
# HTTP header 'Accept' (if needed)
|
685
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
599
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
686
600
|
|
687
601
|
# form parameters
|
688
602
|
form_params = opts[:form_params] || {}
|
@@ -697,7 +611,7 @@ module KlaviyoAPI
|
|
697
611
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
698
612
|
|
699
613
|
new_options = opts.merge(
|
700
|
-
:operation => :"CampaignsApi.
|
614
|
+
:operation => :"CampaignsApi.get_campaign_id_for_campaign_message",
|
701
615
|
:header_params => header_params,
|
702
616
|
:query_params => query_params,
|
703
617
|
:form_params => form_params,
|
@@ -708,53 +622,77 @@ module KlaviyoAPI
|
|
708
622
|
|
709
623
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
710
624
|
if @api_client.config.debugging
|
711
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
625
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
712
626
|
end
|
713
627
|
return data, status_code, headers
|
714
628
|
end
|
715
629
|
|
716
|
-
#
|
717
|
-
|
718
|
-
|
630
|
+
# alias of `get_campaign_id_for_campaign_message_with_http_info`
|
631
|
+
alias get_campaign_message_relationships_campaign_with_http_info get_campaign_id_for_campaign_message_with_http_info
|
632
|
+
|
633
|
+
# Get Campaign Message
|
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
|
+
# @param id [String] The message ID to be retrieved
|
719
636
|
# @param [Hash] opts the optional parameters
|
720
|
-
# @option opts [Array<String>] :
|
637
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
638
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
639
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
640
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
721
641
|
# @return [Hash<String, Object>]
|
722
|
-
def
|
723
|
-
data, _status_code, _headers =
|
642
|
+
def get_campaign_message(id, opts = {})
|
643
|
+
data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
|
724
644
|
data
|
725
645
|
end
|
726
646
|
|
727
|
-
# Get Campaign Message
|
728
|
-
#
|
729
|
-
# @param id [String]
|
647
|
+
# Get Campaign Message
|
648
|
+
# 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
|
+
# @param id [String] The message ID to be retrieved
|
730
650
|
# @param [Hash] opts the optional parameters
|
731
|
-
# @option opts [Array<String>] :
|
651
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
652
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
653
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
654
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
732
655
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
733
|
-
def
|
656
|
+
def get_campaign_message_with_http_info(id, opts = {})
|
734
657
|
if @api_client.config.debugging
|
735
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
658
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_message ...'
|
736
659
|
end
|
737
660
|
# verify the required parameter 'id' is set
|
738
661
|
if @api_client.config.client_side_validation && id.nil?
|
739
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
662
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message"
|
663
|
+
end
|
664
|
+
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"]
|
665
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
666
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
740
667
|
end
|
741
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
668
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
742
669
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
743
670
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
744
671
|
end
|
672
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
673
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
674
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
675
|
+
end
|
676
|
+
allowable_values = ["campaign", "template"]
|
677
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
678
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
679
|
+
end
|
745
680
|
# resource path
|
746
|
-
local_var_path = '/api/campaign-messages/{id}
|
681
|
+
local_var_path = '/api/campaign-messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
747
682
|
|
748
683
|
# query parameters
|
749
684
|
query_params = opts[:query_params] || {}
|
685
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
750
686
|
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
687
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
688
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
751
689
|
|
752
690
|
# header parameters
|
753
691
|
header_params = opts[:header_params] || {}
|
754
692
|
# klaviyo api revision
|
755
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
756
694
|
# HTTP header 'Accept' (if needed)
|
757
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
695
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
758
696
|
|
759
697
|
# form parameters
|
760
698
|
form_params = opts[:form_params] || {}
|
@@ -769,7 +707,7 @@ module KlaviyoAPI
|
|
769
707
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
770
708
|
|
771
709
|
new_options = opts.merge(
|
772
|
-
:operation => :"CampaignsApi.
|
710
|
+
:operation => :"CampaignsApi.get_campaign_message",
|
773
711
|
:header_params => header_params,
|
774
712
|
:query_params => query_params,
|
775
713
|
:form_params => form_params,
|
@@ -780,46 +718,53 @@ module KlaviyoAPI
|
|
780
718
|
|
781
719
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
782
720
|
if @api_client.config.debugging
|
783
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
721
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
784
722
|
end
|
785
723
|
return data, status_code, headers
|
786
724
|
end
|
787
725
|
|
788
|
-
# Get Campaign
|
789
|
-
#
|
790
|
-
# @param id [String]
|
726
|
+
# Get Campaign Recipient Estimation
|
727
|
+
# 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
|
+
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
791
729
|
# @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/v2024-10-15/reference/api-overview#sparse-fieldsets
|
792
731
|
# @return [Hash<String, Object>]
|
793
|
-
def
|
794
|
-
data, _status_code, _headers =
|
732
|
+
def get_campaign_recipient_estimation(id, opts = {})
|
733
|
+
data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
|
795
734
|
data
|
796
735
|
end
|
797
736
|
|
798
|
-
# Get Campaign
|
799
|
-
#
|
800
|
-
# @param id [String]
|
737
|
+
# Get Campaign Recipient Estimation
|
738
|
+
# 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
|
+
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
801
740
|
# @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/v2024-10-15/reference/api-overview#sparse-fieldsets
|
802
742
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
803
|
-
def
|
743
|
+
def get_campaign_recipient_estimation_with_http_info(id, opts = {})
|
804
744
|
if @api_client.config.debugging
|
805
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
745
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_recipient_estimation ...'
|
806
746
|
end
|
807
747
|
# verify the required parameter 'id' is set
|
808
748
|
if @api_client.config.client_side_validation && id.nil?
|
809
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
749
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_recipient_estimation"
|
750
|
+
end
|
751
|
+
allowable_values = ["estimated_recipient_count"]
|
752
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_recipient_estimation'] && !opts[:'fields_campaign_recipient_estimation'].all? { |item| allowable_values.include?(item) }
|
753
|
+
fail ArgumentError, "invalid value for \"fields_campaign_recipient_estimation\", must include one of #{allowable_values}"
|
810
754
|
end
|
811
755
|
# resource path
|
812
|
-
local_var_path = '/api/campaign-
|
756
|
+
local_var_path = '/api/campaign-recipient-estimations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
813
757
|
|
814
758
|
# query parameters
|
815
759
|
query_params = opts[:query_params] || {}
|
760
|
+
query_params[:'fields[campaign-recipient-estimation]'] = @api_client.build_collection_param(opts[:'fields_campaign_recipient_estimation'], :csv) if !opts[:'fields_campaign_recipient_estimation'].nil?
|
816
761
|
|
817
762
|
# header parameters
|
818
763
|
header_params = opts[:header_params] || {}
|
819
764
|
# klaviyo api revision
|
820
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
765
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
821
766
|
# HTTP header 'Accept' (if needed)
|
822
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
767
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
823
768
|
|
824
769
|
# form parameters
|
825
770
|
form_params = opts[:form_params] || {}
|
@@ -834,7 +779,7 @@ module KlaviyoAPI
|
|
834
779
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
835
780
|
|
836
781
|
new_options = opts.merge(
|
837
|
-
:operation => :"CampaignsApi.
|
782
|
+
:operation => :"CampaignsApi.get_campaign_recipient_estimation",
|
838
783
|
:header_params => header_params,
|
839
784
|
:query_params => query_params,
|
840
785
|
:form_params => form_params,
|
@@ -845,46 +790,53 @@ module KlaviyoAPI
|
|
845
790
|
|
846
791
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
847
792
|
if @api_client.config.debugging
|
848
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
793
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_recipient_estimation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
849
794
|
end
|
850
795
|
return data, status_code, headers
|
851
796
|
end
|
852
797
|
|
853
|
-
# Get Campaign
|
854
|
-
#
|
855
|
-
# @param id [String]
|
798
|
+
# Get Campaign Recipient Estimation Job
|
799
|
+
# 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
|
+
# @param id [String] The ID of the campaign to get recipient estimation status
|
856
801
|
# @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/v2024-10-15/reference/api-overview#sparse-fieldsets
|
857
803
|
# @return [Hash<String, Object>]
|
858
|
-
def
|
859
|
-
data, _status_code, _headers =
|
804
|
+
def get_campaign_recipient_estimation_job(id, opts = {})
|
805
|
+
data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
|
860
806
|
data
|
861
807
|
end
|
862
808
|
|
863
|
-
# Get Campaign
|
864
|
-
#
|
865
|
-
# @param id [String]
|
809
|
+
# Get Campaign Recipient Estimation Job
|
810
|
+
# 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
|
+
# @param id [String] The ID of the campaign to get recipient estimation status
|
866
812
|
# @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/v2024-10-15/reference/api-overview#sparse-fieldsets
|
867
814
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
868
|
-
def
|
815
|
+
def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
|
869
816
|
if @api_client.config.debugging
|
870
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
817
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_recipient_estimation_job ...'
|
871
818
|
end
|
872
819
|
# verify the required parameter 'id' is set
|
873
820
|
if @api_client.config.client_side_validation && id.nil?
|
874
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
821
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_recipient_estimation_job"
|
822
|
+
end
|
823
|
+
allowable_values = ["status"]
|
824
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_recipient_estimation_job'] && !opts[:'fields_campaign_recipient_estimation_job'].all? { |item| allowable_values.include?(item) }
|
825
|
+
fail ArgumentError, "invalid value for \"fields_campaign_recipient_estimation_job\", must include one of #{allowable_values}"
|
875
826
|
end
|
876
827
|
# resource path
|
877
|
-
local_var_path = '/api/campaign-
|
828
|
+
local_var_path = '/api/campaign-recipient-estimation-jobs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
878
829
|
|
879
830
|
# query parameters
|
880
831
|
query_params = opts[:query_params] || {}
|
832
|
+
query_params[:'fields[campaign-recipient-estimation-job]'] = @api_client.build_collection_param(opts[:'fields_campaign_recipient_estimation_job'], :csv) if !opts[:'fields_campaign_recipient_estimation_job'].nil?
|
881
833
|
|
882
834
|
# header parameters
|
883
835
|
header_params = opts[:header_params] || {}
|
884
836
|
# klaviyo api revision
|
885
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
837
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
886
838
|
# HTTP header 'Accept' (if needed)
|
887
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
839
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
888
840
|
|
889
841
|
# form parameters
|
890
842
|
form_params = opts[:form_params] || {}
|
@@ -899,7 +851,7 @@ module KlaviyoAPI
|
|
899
851
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
900
852
|
|
901
853
|
new_options = opts.merge(
|
902
|
-
:operation => :"CampaignsApi.
|
854
|
+
:operation => :"CampaignsApi.get_campaign_recipient_estimation_job",
|
903
855
|
:header_params => header_params,
|
904
856
|
:query_params => query_params,
|
905
857
|
:form_params => form_params,
|
@@ -910,53 +862,53 @@ module KlaviyoAPI
|
|
910
862
|
|
911
863
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
912
864
|
if @api_client.config.debugging
|
913
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
865
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_recipient_estimation_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
914
866
|
end
|
915
867
|
return data, status_code, headers
|
916
868
|
end
|
917
869
|
|
918
|
-
# Get Campaign
|
919
|
-
#
|
920
|
-
# @param id [String]
|
870
|
+
# Get Campaign Send Job
|
871
|
+
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
872
|
+
# @param id [String] The ID of the campaign to send
|
921
873
|
# @param [Hash] opts the optional parameters
|
922
|
-
# @option opts [Array<String>] :
|
874
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
923
875
|
# @return [Hash<String, Object>]
|
924
|
-
def
|
925
|
-
data, _status_code, _headers =
|
876
|
+
def get_campaign_send_job(id, opts = {})
|
877
|
+
data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
|
926
878
|
data
|
927
879
|
end
|
928
880
|
|
929
|
-
# Get Campaign
|
930
|
-
#
|
931
|
-
# @param id [String]
|
881
|
+
# Get Campaign Send Job
|
882
|
+
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
883
|
+
# @param id [String] The ID of the campaign to send
|
932
884
|
# @param [Hash] opts the optional parameters
|
933
|
-
# @option opts [Array<String>] :
|
885
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
934
886
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
935
|
-
def
|
887
|
+
def get_campaign_send_job_with_http_info(id, opts = {})
|
936
888
|
if @api_client.config.debugging
|
937
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
889
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_send_job ...'
|
938
890
|
end
|
939
891
|
# verify the required parameter 'id' is set
|
940
892
|
if @api_client.config.client_side_validation && id.nil?
|
941
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
893
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_send_job"
|
942
894
|
end
|
943
|
-
allowable_values = ["
|
944
|
-
if @api_client.config.client_side_validation && opts[:'
|
945
|
-
fail ArgumentError, "invalid value for \"
|
895
|
+
allowable_values = ["status"]
|
896
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_send_job'] && !opts[:'fields_campaign_send_job'].all? { |item| allowable_values.include?(item) }
|
897
|
+
fail ArgumentError, "invalid value for \"fields_campaign_send_job\", must include one of #{allowable_values}"
|
946
898
|
end
|
947
899
|
# resource path
|
948
|
-
local_var_path = '/api/campaign-
|
900
|
+
local_var_path = '/api/campaign-send-jobs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
949
901
|
|
950
902
|
# query parameters
|
951
903
|
query_params = opts[:query_params] || {}
|
952
|
-
query_params[:'fields[
|
904
|
+
query_params[:'fields[campaign-send-job]'] = @api_client.build_collection_param(opts[:'fields_campaign_send_job'], :csv) if !opts[:'fields_campaign_send_job'].nil?
|
953
905
|
|
954
906
|
# header parameters
|
955
907
|
header_params = opts[:header_params] || {}
|
956
908
|
# klaviyo api revision
|
957
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
909
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
958
910
|
# HTTP header 'Accept' (if needed)
|
959
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
911
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
960
912
|
|
961
913
|
# form parameters
|
962
914
|
form_params = opts[:form_params] || {}
|
@@ -971,7 +923,7 @@ module KlaviyoAPI
|
|
971
923
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
972
924
|
|
973
925
|
new_options = opts.merge(
|
974
|
-
:operation => :"CampaignsApi.
|
926
|
+
:operation => :"CampaignsApi.get_campaign_send_job",
|
975
927
|
:header_params => header_params,
|
976
928
|
:query_params => query_params,
|
977
929
|
:form_params => form_params,
|
@@ -982,53 +934,53 @@ module KlaviyoAPI
|
|
982
934
|
|
983
935
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
984
936
|
if @api_client.config.debugging
|
985
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
937
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_send_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
986
938
|
end
|
987
939
|
return data, status_code, headers
|
988
940
|
end
|
989
941
|
|
990
|
-
# Get Campaign
|
991
|
-
#
|
992
|
-
# @param id [String]
|
942
|
+
# Get Campaign Tags
|
943
|
+
# 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`
|
944
|
+
# @param id [String]
|
993
945
|
# @param [Hash] opts the optional parameters
|
994
|
-
# @option opts [Array<String>] :
|
946
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
995
947
|
# @return [Hash<String, Object>]
|
996
|
-
def
|
997
|
-
data, _status_code, _headers =
|
948
|
+
def get_campaign_tags(id, opts = {})
|
949
|
+
data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts)
|
998
950
|
data
|
999
951
|
end
|
1000
952
|
|
1001
|
-
# Get Campaign
|
1002
|
-
#
|
1003
|
-
# @param id [String]
|
953
|
+
# Get Campaign Tags
|
954
|
+
# 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`
|
955
|
+
# @param id [String]
|
1004
956
|
# @param [Hash] opts the optional parameters
|
1005
|
-
# @option opts [Array<String>] :
|
957
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1006
958
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1007
|
-
def
|
959
|
+
def get_campaign_tags_with_http_info(id, opts = {})
|
1008
960
|
if @api_client.config.debugging
|
1009
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
961
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_tags ...'
|
1010
962
|
end
|
1011
963
|
# verify the required parameter 'id' is set
|
1012
964
|
if @api_client.config.client_side_validation && id.nil?
|
1013
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
965
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_tags"
|
1014
966
|
end
|
1015
|
-
allowable_values = ["
|
1016
|
-
if @api_client.config.client_side_validation && opts[:'
|
1017
|
-
fail ArgumentError, "invalid value for \"
|
967
|
+
allowable_values = ["name"]
|
968
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
969
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1018
970
|
end
|
1019
971
|
# resource path
|
1020
|
-
local_var_path = '/api/
|
972
|
+
local_var_path = '/api/campaigns/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1021
973
|
|
1022
974
|
# query parameters
|
1023
975
|
query_params = opts[:query_params] || {}
|
1024
|
-
query_params[:'fields[
|
976
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1025
977
|
|
1026
978
|
# header parameters
|
1027
979
|
header_params = opts[:header_params] || {}
|
1028
980
|
# klaviyo api revision
|
1029
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
981
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1030
982
|
# HTTP header 'Accept' (if needed)
|
1031
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
983
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1032
984
|
|
1033
985
|
# form parameters
|
1034
986
|
form_params = opts[:form_params] || {}
|
@@ -1043,7 +995,7 @@ module KlaviyoAPI
|
|
1043
995
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1044
996
|
|
1045
997
|
new_options = opts.merge(
|
1046
|
-
:operation => :"CampaignsApi.
|
998
|
+
:operation => :"CampaignsApi.get_campaign_tags",
|
1047
999
|
:header_params => header_params,
|
1048
1000
|
:query_params => query_params,
|
1049
1001
|
:form_params => form_params,
|
@@ -1054,53 +1006,85 @@ module KlaviyoAPI
|
|
1054
1006
|
|
1055
1007
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1056
1008
|
if @api_client.config.debugging
|
1057
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1009
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaign_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1058
1010
|
end
|
1059
1011
|
return data, status_code, headers
|
1060
1012
|
end
|
1061
1013
|
|
1062
|
-
# Get
|
1063
|
-
#
|
1064
|
-
# @param
|
1014
|
+
# Get Campaigns
|
1015
|
+
# 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.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1016
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
1065
1017
|
# @param [Hash] opts the optional parameters
|
1066
|
-
# @option opts [Array<String>] :
|
1018
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
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
|
1067
1024
|
# @return [Hash<String, Object>]
|
1068
|
-
def
|
1069
|
-
data, _status_code, _headers =
|
1025
|
+
def get_campaigns(filter, opts = {})
|
1026
|
+
data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
|
1070
1027
|
data
|
1071
1028
|
end
|
1072
1029
|
|
1073
|
-
# Get
|
1074
|
-
#
|
1075
|
-
# @param
|
1030
|
+
# Get Campaigns
|
1031
|
+
# 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.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1032
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
1076
1033
|
# @param [Hash] opts the optional parameters
|
1077
|
-
# @option opts [Array<String>] :
|
1034
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
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
|
1078
1040
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1079
|
-
def
|
1041
|
+
def get_campaigns_with_http_info(filter, opts = {})
|
1080
1042
|
if @api_client.config.debugging
|
1081
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1043
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...'
|
1082
1044
|
end
|
1083
|
-
# verify the required parameter '
|
1084
|
-
if @api_client.config.client_side_validation &&
|
1085
|
-
fail ArgumentError, "Missing the required parameter '
|
1045
|
+
# verify the required parameter 'filter' is set
|
1046
|
+
if @api_client.config.client_side_validation && filter.nil?
|
1047
|
+
fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns"
|
1086
1048
|
end
|
1087
|
-
allowable_values = ["
|
1088
|
-
if @api_client.config.client_side_validation && opts[:'
|
1089
|
-
fail ArgumentError, "invalid value for \"
|
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}"
|
1052
|
+
end
|
1053
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
1054
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
1055
|
+
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
1056
|
+
end
|
1057
|
+
allowable_values = ["name"]
|
1058
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1059
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1060
|
+
end
|
1061
|
+
allowable_values = ["campaign-messages", "tags"]
|
1062
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1063
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1064
|
+
end
|
1065
|
+
allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at"]
|
1066
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1067
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1090
1068
|
end
|
1091
1069
|
# resource path
|
1092
|
-
local_var_path = '/api/
|
1070
|
+
local_var_path = '/api/campaigns'
|
1093
1071
|
|
1094
1072
|
# query parameters
|
1095
1073
|
query_params = opts[:query_params] || {}
|
1096
|
-
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?
|
1097
1081
|
|
1098
1082
|
# header parameters
|
1099
1083
|
header_params = opts[:header_params] || {}
|
1100
1084
|
# klaviyo api revision
|
1101
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1085
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1102
1086
|
# HTTP header 'Accept' (if needed)
|
1103
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1087
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1104
1088
|
|
1105
1089
|
# form parameters
|
1106
1090
|
form_params = opts[:form_params] || {}
|
@@ -1115,7 +1099,7 @@ module KlaviyoAPI
|
|
1115
1099
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1116
1100
|
|
1117
1101
|
new_options = opts.merge(
|
1118
|
-
:operation => :"CampaignsApi.
|
1102
|
+
:operation => :"CampaignsApi.get_campaigns",
|
1119
1103
|
:header_params => header_params,
|
1120
1104
|
:query_params => query_params,
|
1121
1105
|
:form_params => form_params,
|
@@ -1126,36 +1110,39 @@ module KlaviyoAPI
|
|
1126
1110
|
|
1127
1111
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1128
1112
|
if @api_client.config.debugging
|
1129
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1113
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1130
1114
|
end
|
1131
1115
|
return data, status_code, headers
|
1132
1116
|
end
|
1133
1117
|
|
1134
|
-
# Get
|
1118
|
+
# Get Message IDs for Campaign
|
1135
1119
|
# 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`
|
1136
1120
|
# @param id [String]
|
1137
1121
|
# @param [Hash] opts the optional parameters
|
1138
1122
|
# @return [Hash<String, Object>]
|
1139
|
-
def
|
1140
|
-
data, _status_code, _headers =
|
1123
|
+
def get_message_ids_for_campaign(id, opts = {})
|
1124
|
+
data, _status_code, _headers = get_message_ids_for_campaign_with_http_info(id, opts)
|
1141
1125
|
data
|
1142
1126
|
end
|
1143
1127
|
|
1144
|
-
#
|
1128
|
+
# alias of `get_message_ids_for_campaign`
|
1129
|
+
alias get_campaign_relationships_campaign_messages get_message_ids_for_campaign
|
1130
|
+
|
1131
|
+
# Get Message IDs for Campaign
|
1145
1132
|
# 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`
|
1146
1133
|
# @param id [String]
|
1147
1134
|
# @param [Hash] opts the optional parameters
|
1148
1135
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1149
|
-
def
|
1136
|
+
def get_message_ids_for_campaign_with_http_info(id, opts = {})
|
1150
1137
|
if @api_client.config.debugging
|
1151
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1138
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_message_ids_for_campaign ...'
|
1152
1139
|
end
|
1153
1140
|
# verify the required parameter 'id' is set
|
1154
1141
|
if @api_client.config.client_side_validation && id.nil?
|
1155
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
1142
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_message_ids_for_campaign"
|
1156
1143
|
end
|
1157
1144
|
# resource path
|
1158
|
-
local_var_path = '/api/campaigns/{id}/relationships/campaign-messages
|
1145
|
+
local_var_path = '/api/campaigns/{id}/relationships/campaign-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1159
1146
|
|
1160
1147
|
# query parameters
|
1161
1148
|
query_params = opts[:query_params] || {}
|
@@ -1163,9 +1150,9 @@ module KlaviyoAPI
|
|
1163
1150
|
# header parameters
|
1164
1151
|
header_params = opts[:header_params] || {}
|
1165
1152
|
# klaviyo api revision
|
1166
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1153
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1167
1154
|
# HTTP header 'Accept' (if needed)
|
1168
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1155
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1169
1156
|
|
1170
1157
|
# form parameters
|
1171
1158
|
form_params = opts[:form_params] || {}
|
@@ -1180,7 +1167,7 @@ module KlaviyoAPI
|
|
1180
1167
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1181
1168
|
|
1182
1169
|
new_options = opts.merge(
|
1183
|
-
:operation => :"CampaignsApi.
|
1170
|
+
:operation => :"CampaignsApi.get_message_ids_for_campaign",
|
1184
1171
|
:header_params => header_params,
|
1185
1172
|
:query_params => query_params,
|
1186
1173
|
:form_params => form_params,
|
@@ -1191,46 +1178,80 @@ module KlaviyoAPI
|
|
1191
1178
|
|
1192
1179
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1193
1180
|
if @api_client.config.debugging
|
1194
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1181
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_message_ids_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1195
1182
|
end
|
1196
1183
|
return data, status_code, headers
|
1197
1184
|
end
|
1198
1185
|
|
1199
|
-
#
|
1200
|
-
|
1186
|
+
# alias of `get_message_ids_for_campaign_with_http_info`
|
1187
|
+
alias get_campaign_relationships_campaign_messages_with_http_info get_message_ids_for_campaign_with_http_info
|
1188
|
+
|
1189
|
+
# Get Messages for Campaign
|
1190
|
+
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1201
1191
|
# @param id [String]
|
1202
1192
|
# @param [Hash] opts the optional parameters
|
1193
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1194
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1195
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1196
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1203
1197
|
# @return [Hash<String, Object>]
|
1204
|
-
def
|
1205
|
-
data, _status_code, _headers =
|
1198
|
+
def get_messages_for_campaign(id, opts = {})
|
1199
|
+
data, _status_code, _headers = get_messages_for_campaign_with_http_info(id, opts)
|
1206
1200
|
data
|
1207
1201
|
end
|
1208
1202
|
|
1209
|
-
#
|
1210
|
-
|
1203
|
+
# alias of `get_messages_for_campaign`
|
1204
|
+
alias get_campaign_campaign_messages get_messages_for_campaign
|
1205
|
+
|
1206
|
+
# Get Messages for Campaign
|
1207
|
+
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1211
1208
|
# @param id [String]
|
1212
1209
|
# @param [Hash] opts the optional parameters
|
1210
|
+
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1211
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1212
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1213
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1213
1214
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1214
|
-
def
|
1215
|
+
def get_messages_for_campaign_with_http_info(id, opts = {})
|
1215
1216
|
if @api_client.config.debugging
|
1216
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1217
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_messages_for_campaign ...'
|
1217
1218
|
end
|
1218
1219
|
# verify the required parameter 'id' is set
|
1219
1220
|
if @api_client.config.client_side_validation && id.nil?
|
1220
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
1221
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_messages_for_campaign"
|
1222
|
+
end
|
1223
|
+
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"]
|
1224
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
1225
|
+
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
1226
|
+
end
|
1227
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
1228
|
+
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
1229
|
+
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
1230
|
+
end
|
1231
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
1232
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
1233
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
1234
|
+
end
|
1235
|
+
allowable_values = ["campaign", "template"]
|
1236
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1237
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1221
1238
|
end
|
1222
1239
|
# resource path
|
1223
|
-
local_var_path = '/api/campaigns/{id}/
|
1240
|
+
local_var_path = '/api/campaigns/{id}/campaign-messages'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1224
1241
|
|
1225
1242
|
# query parameters
|
1226
1243
|
query_params = opts[:query_params] || {}
|
1244
|
+
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
1245
|
+
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
1246
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
1247
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1227
1248
|
|
1228
1249
|
# header parameters
|
1229
1250
|
header_params = opts[:header_params] || {}
|
1230
1251
|
# klaviyo api revision
|
1231
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1252
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1232
1253
|
# HTTP header 'Accept' (if needed)
|
1233
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1254
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1234
1255
|
|
1235
1256
|
# form parameters
|
1236
1257
|
form_params = opts[:form_params] || {}
|
@@ -1245,7 +1266,7 @@ module KlaviyoAPI
|
|
1245
1266
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1246
1267
|
|
1247
1268
|
new_options = opts.merge(
|
1248
|
-
:operation => :"CampaignsApi.
|
1269
|
+
:operation => :"CampaignsApi.get_messages_for_campaign",
|
1249
1270
|
:header_params => header_params,
|
1250
1271
|
:query_params => query_params,
|
1251
1272
|
:form_params => form_params,
|
@@ -1256,53 +1277,52 @@ module KlaviyoAPI
|
|
1256
1277
|
|
1257
1278
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1258
1279
|
if @api_client.config.debugging
|
1259
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1280
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_messages_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1260
1281
|
end
|
1261
1282
|
return data, status_code, headers
|
1262
1283
|
end
|
1263
1284
|
|
1264
|
-
#
|
1265
|
-
|
1266
|
-
|
1285
|
+
# alias of `get_messages_for_campaign_with_http_info`
|
1286
|
+
alias get_campaign_campaign_messages_with_http_info get_messages_for_campaign_with_http_info
|
1287
|
+
|
1288
|
+
# Get Tag IDs for Campaign
|
1289
|
+
# 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
|
+
# @param id [String]
|
1267
1291
|
# @param [Hash] opts the optional parameters
|
1268
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1269
1292
|
# @return [Hash<String, Object>]
|
1270
|
-
def
|
1271
|
-
data, _status_code, _headers =
|
1293
|
+
def get_tag_ids_for_campaign(id, opts = {})
|
1294
|
+
data, _status_code, _headers = get_tag_ids_for_campaign_with_http_info(id, opts)
|
1272
1295
|
data
|
1273
1296
|
end
|
1274
1297
|
|
1275
|
-
#
|
1276
|
-
|
1277
|
-
|
1298
|
+
# alias of `get_tag_ids_for_campaign`
|
1299
|
+
alias get_campaign_relationships_tags get_tag_ids_for_campaign
|
1300
|
+
|
1301
|
+
# Get Tag IDs for Campaign
|
1302
|
+
# 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`
|
1303
|
+
# @param id [String]
|
1278
1304
|
# @param [Hash] opts the optional parameters
|
1279
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1280
1305
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1281
|
-
def
|
1306
|
+
def get_tag_ids_for_campaign_with_http_info(id, opts = {})
|
1282
1307
|
if @api_client.config.debugging
|
1283
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1308
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_tag_ids_for_campaign ...'
|
1284
1309
|
end
|
1285
1310
|
# verify the required parameter 'id' is set
|
1286
1311
|
if @api_client.config.client_side_validation && id.nil?
|
1287
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
1288
|
-
end
|
1289
|
-
allowable_values = ["status"]
|
1290
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign_send_job'] && !opts[:'fields_campaign_send_job'].all? { |item| allowable_values.include?(item) }
|
1291
|
-
fail ArgumentError, "invalid value for \"fields_campaign_send_job\", must include one of #{allowable_values}"
|
1312
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_tag_ids_for_campaign"
|
1292
1313
|
end
|
1293
1314
|
# resource path
|
1294
|
-
local_var_path = '/api/
|
1315
|
+
local_var_path = '/api/campaigns/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1295
1316
|
|
1296
1317
|
# query parameters
|
1297
1318
|
query_params = opts[:query_params] || {}
|
1298
|
-
query_params[:'fields[campaign-send-job]'] = @api_client.build_collection_param(opts[:'fields_campaign_send_job'], :csv) if !opts[:'fields_campaign_send_job'].nil?
|
1299
1319
|
|
1300
1320
|
# header parameters
|
1301
1321
|
header_params = opts[:header_params] || {}
|
1302
1322
|
# klaviyo api revision
|
1303
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1323
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1304
1324
|
# HTTP header 'Accept' (if needed)
|
1305
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1325
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1306
1326
|
|
1307
1327
|
# form parameters
|
1308
1328
|
form_params = opts[:form_params] || {}
|
@@ -1317,7 +1337,7 @@ module KlaviyoAPI
|
|
1317
1337
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1318
1338
|
|
1319
1339
|
new_options = opts.merge(
|
1320
|
-
:operation => :"CampaignsApi.
|
1340
|
+
:operation => :"CampaignsApi.get_tag_ids_for_campaign",
|
1321
1341
|
:header_params => header_params,
|
1322
1342
|
:query_params => query_params,
|
1323
1343
|
:form_params => form_params,
|
@@ -1328,53 +1348,59 @@ module KlaviyoAPI
|
|
1328
1348
|
|
1329
1349
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1330
1350
|
if @api_client.config.debugging
|
1331
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1351
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_tag_ids_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1332
1352
|
end
|
1333
1353
|
return data, status_code, headers
|
1334
1354
|
end
|
1335
1355
|
|
1336
|
-
#
|
1337
|
-
|
1356
|
+
# alias of `get_tag_ids_for_campaign_with_http_info`
|
1357
|
+
alias get_campaign_relationships_tags_with_http_info get_tag_ids_for_campaign_with_http_info
|
1358
|
+
|
1359
|
+
# Get Template for Campaign Message
|
1360
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1338
1361
|
# @param id [String]
|
1339
1362
|
# @param [Hash] opts the optional parameters
|
1340
|
-
# @option opts [Array<String>] :
|
1363
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1341
1364
|
# @return [Hash<String, Object>]
|
1342
|
-
def
|
1343
|
-
data, _status_code, _headers =
|
1365
|
+
def get_template_for_campaign_message(id, opts = {})
|
1366
|
+
data, _status_code, _headers = get_template_for_campaign_message_with_http_info(id, opts)
|
1344
1367
|
data
|
1345
1368
|
end
|
1346
1369
|
|
1347
|
-
#
|
1348
|
-
|
1370
|
+
# alias of `get_template_for_campaign_message`
|
1371
|
+
alias get_campaign_message_template get_template_for_campaign_message
|
1372
|
+
|
1373
|
+
# Get Template for Campaign Message
|
1374
|
+
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1349
1375
|
# @param id [String]
|
1350
1376
|
# @param [Hash] opts the optional parameters
|
1351
|
-
# @option opts [Array<String>] :
|
1377
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1352
1378
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1353
|
-
def
|
1379
|
+
def get_template_for_campaign_message_with_http_info(id, opts = {})
|
1354
1380
|
if @api_client.config.debugging
|
1355
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1381
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_template_for_campaign_message ...'
|
1356
1382
|
end
|
1357
1383
|
# verify the required parameter 'id' is set
|
1358
1384
|
if @api_client.config.client_side_validation && id.nil?
|
1359
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
1385
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_template_for_campaign_message"
|
1360
1386
|
end
|
1361
|
-
allowable_values = ["name"]
|
1362
|
-
if @api_client.config.client_side_validation && opts[:'
|
1363
|
-
fail ArgumentError, "invalid value for \"
|
1387
|
+
allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
|
1388
|
+
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
1389
|
+
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
1364
1390
|
end
|
1365
1391
|
# resource path
|
1366
|
-
local_var_path = '/api/
|
1392
|
+
local_var_path = '/api/campaign-messages/{id}/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1367
1393
|
|
1368
1394
|
# query parameters
|
1369
1395
|
query_params = opts[:query_params] || {}
|
1370
|
-
query_params[:'fields[
|
1396
|
+
query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
|
1371
1397
|
|
1372
1398
|
# header parameters
|
1373
1399
|
header_params = opts[:header_params] || {}
|
1374
1400
|
# klaviyo api revision
|
1375
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1401
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1376
1402
|
# HTTP header 'Accept' (if needed)
|
1377
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1403
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1378
1404
|
|
1379
1405
|
# form parameters
|
1380
1406
|
form_params = opts[:form_params] || {}
|
@@ -1389,7 +1415,7 @@ module KlaviyoAPI
|
|
1389
1415
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1390
1416
|
|
1391
1417
|
new_options = opts.merge(
|
1392
|
-
:operation => :"CampaignsApi.
|
1418
|
+
:operation => :"CampaignsApi.get_template_for_campaign_message",
|
1393
1419
|
:header_params => header_params,
|
1394
1420
|
:query_params => query_params,
|
1395
1421
|
:form_params => form_params,
|
@@ -1400,85 +1426,52 @@ module KlaviyoAPI
|
|
1400
1426
|
|
1401
1427
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1402
1428
|
if @api_client.config.debugging
|
1403
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1429
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_template_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1404
1430
|
end
|
1405
1431
|
return data, status_code, headers
|
1406
1432
|
end
|
1407
1433
|
|
1408
|
-
#
|
1409
|
-
|
1410
|
-
|
1434
|
+
# alias of `get_template_for_campaign_message_with_http_info`
|
1435
|
+
alias get_campaign_message_template_with_http_info get_template_for_campaign_message_with_http_info
|
1436
|
+
|
1437
|
+
# Get Template ID for Campaign Message
|
1438
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1439
|
+
# @param id [String]
|
1411
1440
|
# @param [Hash] opts the optional parameters
|
1412
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1413
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1414
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1415
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
1416
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1417
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1418
1441
|
# @return [Hash<String, Object>]
|
1419
|
-
def
|
1420
|
-
data, _status_code, _headers =
|
1442
|
+
def get_template_id_for_campaign_message(id, opts = {})
|
1443
|
+
data, _status_code, _headers = get_template_id_for_campaign_message_with_http_info(id, opts)
|
1421
1444
|
data
|
1422
1445
|
end
|
1423
1446
|
|
1424
|
-
#
|
1425
|
-
|
1426
|
-
|
1447
|
+
# alias of `get_template_id_for_campaign_message`
|
1448
|
+
alias get_campaign_message_relationships_template get_template_id_for_campaign_message
|
1449
|
+
|
1450
|
+
# Get Template ID for Campaign Message
|
1451
|
+
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1452
|
+
# @param id [String]
|
1427
1453
|
# @param [Hash] opts the optional parameters
|
1428
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1429
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1430
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1431
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
1432
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1433
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1434
1454
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1435
|
-
def
|
1455
|
+
def get_template_id_for_campaign_message_with_http_info(id, opts = {})
|
1436
1456
|
if @api_client.config.debugging
|
1437
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1457
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.get_template_id_for_campaign_message ...'
|
1438
1458
|
end
|
1439
|
-
# verify the required parameter '
|
1440
|
-
if @api_client.config.client_side_validation &&
|
1441
|
-
fail ArgumentError, "Missing the required parameter '
|
1442
|
-
end
|
1443
|
-
allowable_values = ["label", "channel", "content", "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"]
|
1444
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
1445
|
-
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
1446
|
-
end
|
1447
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "tracking_options", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
|
1448
|
-
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
1449
|
-
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
1450
|
-
end
|
1451
|
-
allowable_values = ["name"]
|
1452
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1453
|
-
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1454
|
-
end
|
1455
|
-
allowable_values = ["campaign-messages", "tags"]
|
1456
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1457
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1458
|
-
end
|
1459
|
-
allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at"]
|
1460
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1461
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1459
|
+
# verify the required parameter 'id' is set
|
1460
|
+
if @api_client.config.client_side_validation && id.nil?
|
1461
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_template_id_for_campaign_message"
|
1462
1462
|
end
|
1463
1463
|
# resource path
|
1464
|
-
local_var_path = '/api/
|
1464
|
+
local_var_path = '/api/campaign-messages/{id}/relationships/template'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1465
1465
|
|
1466
1466
|
# query parameters
|
1467
1467
|
query_params = opts[:query_params] || {}
|
1468
|
-
query_params[:'filter'] = filter
|
1469
|
-
query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
|
1470
|
-
query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
|
1471
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1472
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1473
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1474
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1475
1468
|
|
1476
1469
|
# header parameters
|
1477
1470
|
header_params = opts[:header_params] || {}
|
1478
1471
|
# klaviyo api revision
|
1479
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1472
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1480
1473
|
# HTTP header 'Accept' (if needed)
|
1481
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1474
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1482
1475
|
|
1483
1476
|
# form parameters
|
1484
1477
|
form_params = opts[:form_params] || {}
|
@@ -1493,7 +1486,7 @@ module KlaviyoAPI
|
|
1493
1486
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1494
1487
|
|
1495
1488
|
new_options = opts.merge(
|
1496
|
-
:operation => :"CampaignsApi.
|
1489
|
+
:operation => :"CampaignsApi.get_template_id_for_campaign_message",
|
1497
1490
|
:header_params => header_params,
|
1498
1491
|
:query_params => query_params,
|
1499
1492
|
:form_params => form_params,
|
@@ -1504,42 +1497,118 @@ module KlaviyoAPI
|
|
1504
1497
|
|
1505
1498
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1506
1499
|
if @api_client.config.debugging
|
1507
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1500
|
+
@api_client.config.logger.debug "API called: CampaignsApi#get_template_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1508
1501
|
end
|
1509
1502
|
return data, status_code, headers
|
1510
1503
|
end
|
1511
1504
|
|
1512
|
-
#
|
1513
|
-
|
1514
|
-
|
1515
|
-
#
|
1505
|
+
# alias of `get_template_id_for_campaign_message_with_http_info`
|
1506
|
+
alias get_campaign_message_relationships_template_with_http_info get_template_id_for_campaign_message_with_http_info
|
1507
|
+
|
1508
|
+
# Refresh Campaign Recipient Estimation
|
1509
|
+
# Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1510
|
+
# @param campaign_recipient_estimation_job_create_query [CampaignRecipientEstimationJobCreateQuery] Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
|
1516
1511
|
# @param [Hash] opts the optional parameters
|
1517
1512
|
# @return [Hash<String, Object>]
|
1518
|
-
def
|
1519
|
-
data, _status_code, _headers =
|
1513
|
+
def refresh_campaign_recipient_estimation(campaign_recipient_estimation_job_create_query, opts = {})
|
1514
|
+
data, _status_code, _headers = refresh_campaign_recipient_estimation_with_http_info(campaign_recipient_estimation_job_create_query, opts)
|
1520
1515
|
data
|
1521
1516
|
end
|
1522
1517
|
|
1523
|
-
#
|
1524
|
-
|
1525
|
-
|
1526
|
-
#
|
1518
|
+
# alias of `refresh_campaign_recipient_estimation`
|
1519
|
+
alias create_campaign_recipient_estimation_job refresh_campaign_recipient_estimation
|
1520
|
+
|
1521
|
+
# Refresh Campaign Recipient Estimation
|
1522
|
+
# Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1523
|
+
# @param campaign_recipient_estimation_job_create_query [CampaignRecipientEstimationJobCreateQuery] Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
|
1527
1524
|
# @param [Hash] opts the optional parameters
|
1528
1525
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1529
|
-
def
|
1526
|
+
def refresh_campaign_recipient_estimation_with_http_info(campaign_recipient_estimation_job_create_query, opts = {})
|
1530
1527
|
if @api_client.config.debugging
|
1531
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1528
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.refresh_campaign_recipient_estimation ...'
|
1532
1529
|
end
|
1533
|
-
# verify the required parameter '
|
1534
|
-
if @api_client.config.client_side_validation &&
|
1535
|
-
fail ArgumentError, "Missing the required parameter '
|
1530
|
+
# verify the required parameter 'campaign_recipient_estimation_job_create_query' is set
|
1531
|
+
if @api_client.config.client_side_validation && campaign_recipient_estimation_job_create_query.nil?
|
1532
|
+
fail ArgumentError, "Missing the required parameter 'campaign_recipient_estimation_job_create_query' when calling CampaignsApi.refresh_campaign_recipient_estimation"
|
1536
1533
|
end
|
1537
|
-
#
|
1538
|
-
|
1539
|
-
|
1534
|
+
# resource path
|
1535
|
+
local_var_path = '/api/campaign-recipient-estimation-jobs'
|
1536
|
+
|
1537
|
+
# query parameters
|
1538
|
+
query_params = opts[:query_params] || {}
|
1539
|
+
|
1540
|
+
# header parameters
|
1541
|
+
header_params = opts[:header_params] || {}
|
1542
|
+
# klaviyo api revision
|
1543
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1544
|
+
# HTTP header 'Accept' (if needed)
|
1545
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1546
|
+
# HTTP header 'Content-Type'
|
1547
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1548
|
+
if !content_type.nil?
|
1549
|
+
header_params['Content-Type'] = content_type
|
1550
|
+
end
|
1551
|
+
|
1552
|
+
# form parameters
|
1553
|
+
form_params = opts[:form_params] || {}
|
1554
|
+
|
1555
|
+
# http body (model)
|
1556
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_recipient_estimation_job_create_query)
|
1557
|
+
|
1558
|
+
# return_type
|
1559
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1560
|
+
|
1561
|
+
# auth_names
|
1562
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1563
|
+
|
1564
|
+
new_options = opts.merge(
|
1565
|
+
:operation => :"CampaignsApi.refresh_campaign_recipient_estimation",
|
1566
|
+
:header_params => header_params,
|
1567
|
+
:query_params => query_params,
|
1568
|
+
:form_params => form_params,
|
1569
|
+
:body => post_body,
|
1570
|
+
:auth_names => auth_names,
|
1571
|
+
:return_type => return_type
|
1572
|
+
)
|
1573
|
+
|
1574
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1575
|
+
if @api_client.config.debugging
|
1576
|
+
@api_client.config.logger.debug "API called: CampaignsApi#refresh_campaign_recipient_estimation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1577
|
+
end
|
1578
|
+
return data, status_code, headers
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
# alias of `refresh_campaign_recipient_estimation_with_http_info`
|
1582
|
+
alias create_campaign_recipient_estimation_job_with_http_info refresh_campaign_recipient_estimation_with_http_info
|
1583
|
+
|
1584
|
+
# Send Campaign
|
1585
|
+
# Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1586
|
+
# @param campaign_send_job_create_query [CampaignSendJobCreateQuery] Trigger the campaign to send asynchronously
|
1587
|
+
# @param [Hash] opts the optional parameters
|
1588
|
+
# @return [Hash<String, Object>]
|
1589
|
+
def send_campaign(campaign_send_job_create_query, opts = {})
|
1590
|
+
data, _status_code, _headers = send_campaign_with_http_info(campaign_send_job_create_query, opts)
|
1591
|
+
data
|
1592
|
+
end
|
1593
|
+
|
1594
|
+
# alias of `send_campaign`
|
1595
|
+
alias create_campaign_send_job send_campaign
|
1596
|
+
|
1597
|
+
# Send Campaign
|
1598
|
+
# Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1599
|
+
# @param campaign_send_job_create_query [CampaignSendJobCreateQuery] Trigger the campaign to send asynchronously
|
1600
|
+
# @param [Hash] opts the optional parameters
|
1601
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1602
|
+
def send_campaign_with_http_info(campaign_send_job_create_query, opts = {})
|
1603
|
+
if @api_client.config.debugging
|
1604
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.send_campaign ...'
|
1605
|
+
end
|
1606
|
+
# verify the required parameter 'campaign_send_job_create_query' is set
|
1607
|
+
if @api_client.config.client_side_validation && campaign_send_job_create_query.nil?
|
1608
|
+
fail ArgumentError, "Missing the required parameter 'campaign_send_job_create_query' when calling CampaignsApi.send_campaign"
|
1540
1609
|
end
|
1541
1610
|
# resource path
|
1542
|
-
local_var_path = '/api/
|
1611
|
+
local_var_path = '/api/campaign-send-jobs'
|
1543
1612
|
|
1544
1613
|
# query parameters
|
1545
1614
|
query_params = opts[:query_params] || {}
|
@@ -1547,11 +1616,11 @@ module KlaviyoAPI
|
|
1547
1616
|
# header parameters
|
1548
1617
|
header_params = opts[:header_params] || {}
|
1549
1618
|
# klaviyo api revision
|
1550
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1619
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1551
1620
|
# HTTP header 'Accept' (if needed)
|
1552
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1621
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1553
1622
|
# HTTP header 'Content-Type'
|
1554
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1623
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1555
1624
|
if !content_type.nil?
|
1556
1625
|
header_params['Content-Type'] = content_type
|
1557
1626
|
end
|
@@ -1560,7 +1629,7 @@ module KlaviyoAPI
|
|
1560
1629
|
form_params = opts[:form_params] || {}
|
1561
1630
|
|
1562
1631
|
# http body (model)
|
1563
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
1632
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_send_job_create_query)
|
1564
1633
|
|
1565
1634
|
# return_type
|
1566
1635
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -1569,7 +1638,7 @@ module KlaviyoAPI
|
|
1569
1638
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1570
1639
|
|
1571
1640
|
new_options = opts.merge(
|
1572
|
-
:operation => :"CampaignsApi.
|
1641
|
+
:operation => :"CampaignsApi.send_campaign",
|
1573
1642
|
:header_params => header_params,
|
1574
1643
|
:query_params => query_params,
|
1575
1644
|
:form_params => form_params,
|
@@ -1578,44 +1647,47 @@ module KlaviyoAPI
|
|
1578
1647
|
:return_type => return_type
|
1579
1648
|
)
|
1580
1649
|
|
1581
|
-
data, status_code, headers = @api_client.call_api(:
|
1650
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1582
1651
|
if @api_client.config.debugging
|
1583
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1652
|
+
@api_client.config.logger.debug "API called: CampaignsApi#send_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1584
1653
|
end
|
1585
1654
|
return data, status_code, headers
|
1586
1655
|
end
|
1587
1656
|
|
1588
|
-
#
|
1589
|
-
|
1590
|
-
|
1591
|
-
#
|
1657
|
+
# alias of `send_campaign_with_http_info`
|
1658
|
+
alias create_campaign_send_job_with_http_info send_campaign_with_http_info
|
1659
|
+
|
1660
|
+
# Update Campaign
|
1661
|
+
# Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1662
|
+
# @param id [String] The campaign ID to be retrieved
|
1663
|
+
# @param campaign_partial_update_query [CampaignPartialUpdateQuery] Update a campaign and return it
|
1592
1664
|
# @param [Hash] opts the optional parameters
|
1593
1665
|
# @return [Hash<String, Object>]
|
1594
|
-
def
|
1595
|
-
data, _status_code, _headers =
|
1666
|
+
def update_campaign(id, campaign_partial_update_query, opts = {})
|
1667
|
+
data, _status_code, _headers = update_campaign_with_http_info(id, campaign_partial_update_query, opts)
|
1596
1668
|
data
|
1597
1669
|
end
|
1598
1670
|
|
1599
|
-
# Update Campaign
|
1600
|
-
# Update a campaign
|
1601
|
-
# @param id [String] The
|
1602
|
-
# @param
|
1671
|
+
# Update Campaign
|
1672
|
+
# Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1673
|
+
# @param id [String] The campaign ID to be retrieved
|
1674
|
+
# @param campaign_partial_update_query [CampaignPartialUpdateQuery] Update a campaign and return it
|
1603
1675
|
# @param [Hash] opts the optional parameters
|
1604
1676
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1605
|
-
def
|
1677
|
+
def update_campaign_with_http_info(id, campaign_partial_update_query, opts = {})
|
1606
1678
|
if @api_client.config.debugging
|
1607
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1679
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.update_campaign ...'
|
1608
1680
|
end
|
1609
1681
|
# verify the required parameter 'id' is set
|
1610
1682
|
if @api_client.config.client_side_validation && id.nil?
|
1611
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
1683
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_campaign"
|
1612
1684
|
end
|
1613
|
-
# verify the required parameter '
|
1614
|
-
if @api_client.config.client_side_validation &&
|
1615
|
-
fail ArgumentError, "Missing the required parameter '
|
1685
|
+
# verify the required parameter 'campaign_partial_update_query' is set
|
1686
|
+
if @api_client.config.client_side_validation && campaign_partial_update_query.nil?
|
1687
|
+
fail ArgumentError, "Missing the required parameter 'campaign_partial_update_query' when calling CampaignsApi.update_campaign"
|
1616
1688
|
end
|
1617
1689
|
# resource path
|
1618
|
-
local_var_path = '/api/
|
1690
|
+
local_var_path = '/api/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1619
1691
|
|
1620
1692
|
# query parameters
|
1621
1693
|
query_params = opts[:query_params] || {}
|
@@ -1623,11 +1695,11 @@ module KlaviyoAPI
|
|
1623
1695
|
# header parameters
|
1624
1696
|
header_params = opts[:header_params] || {}
|
1625
1697
|
# klaviyo api revision
|
1626
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1698
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1627
1699
|
# HTTP header 'Accept' (if needed)
|
1628
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1700
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1629
1701
|
# HTTP header 'Content-Type'
|
1630
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1702
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1631
1703
|
if !content_type.nil?
|
1632
1704
|
header_params['Content-Type'] = content_type
|
1633
1705
|
end
|
@@ -1636,7 +1708,7 @@ module KlaviyoAPI
|
|
1636
1708
|
form_params = opts[:form_params] || {}
|
1637
1709
|
|
1638
1710
|
# http body (model)
|
1639
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
1711
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_partial_update_query)
|
1640
1712
|
|
1641
1713
|
# return_type
|
1642
1714
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -1645,7 +1717,7 @@ module KlaviyoAPI
|
|
1645
1717
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1646
1718
|
|
1647
1719
|
new_options = opts.merge(
|
1648
|
-
:operation => :"CampaignsApi.
|
1720
|
+
:operation => :"CampaignsApi.update_campaign",
|
1649
1721
|
:header_params => header_params,
|
1650
1722
|
:query_params => query_params,
|
1651
1723
|
:form_params => form_params,
|
@@ -1656,42 +1728,42 @@ module KlaviyoAPI
|
|
1656
1728
|
|
1657
1729
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
1658
1730
|
if @api_client.config.debugging
|
1659
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1731
|
+
@api_client.config.logger.debug "API called: CampaignsApi#update_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1660
1732
|
end
|
1661
1733
|
return data, status_code, headers
|
1662
1734
|
end
|
1663
1735
|
|
1664
|
-
# Update Campaign
|
1665
|
-
#
|
1666
|
-
# @param id [String] The ID
|
1667
|
-
# @param
|
1736
|
+
# Update Campaign Message
|
1737
|
+
# Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1738
|
+
# @param id [String] The message ID to be retrieved
|
1739
|
+
# @param campaign_message_partial_update_query [CampaignMessagePartialUpdateQuery] Update a message and return it
|
1668
1740
|
# @param [Hash] opts the optional parameters
|
1669
|
-
# @return [
|
1670
|
-
def
|
1671
|
-
|
1672
|
-
|
1741
|
+
# @return [Hash<String, Object>]
|
1742
|
+
def update_campaign_message(id, campaign_message_partial_update_query, opts = {})
|
1743
|
+
data, _status_code, _headers = update_campaign_message_with_http_info(id, campaign_message_partial_update_query, opts)
|
1744
|
+
data
|
1673
1745
|
end
|
1674
1746
|
|
1675
|
-
# Update Campaign
|
1676
|
-
#
|
1677
|
-
# @param id [String] The ID
|
1678
|
-
# @param
|
1747
|
+
# Update Campaign Message
|
1748
|
+
# Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
|
1749
|
+
# @param id [String] The message ID to be retrieved
|
1750
|
+
# @param campaign_message_partial_update_query [CampaignMessagePartialUpdateQuery] Update a message and return it
|
1679
1751
|
# @param [Hash] opts the optional parameters
|
1680
|
-
# @return [Array<(
|
1681
|
-
def
|
1752
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1753
|
+
def update_campaign_message_with_http_info(id, campaign_message_partial_update_query, opts = {})
|
1682
1754
|
if @api_client.config.debugging
|
1683
|
-
@api_client.config.logger.debug 'Calling API: CampaignsApi.
|
1755
|
+
@api_client.config.logger.debug 'Calling API: CampaignsApi.update_campaign_message ...'
|
1684
1756
|
end
|
1685
1757
|
# verify the required parameter 'id' is set
|
1686
1758
|
if @api_client.config.client_side_validation && id.nil?
|
1687
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.
|
1759
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_campaign_message"
|
1688
1760
|
end
|
1689
|
-
# verify the required parameter '
|
1690
|
-
if @api_client.config.client_side_validation &&
|
1691
|
-
fail ArgumentError, "Missing the required parameter '
|
1761
|
+
# verify the required parameter 'campaign_message_partial_update_query' is set
|
1762
|
+
if @api_client.config.client_side_validation && campaign_message_partial_update_query.nil?
|
1763
|
+
fail ArgumentError, "Missing the required parameter 'campaign_message_partial_update_query' when calling CampaignsApi.update_campaign_message"
|
1692
1764
|
end
|
1693
1765
|
# resource path
|
1694
|
-
local_var_path = '/api/campaign-
|
1766
|
+
local_var_path = '/api/campaign-messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1695
1767
|
|
1696
1768
|
# query parameters
|
1697
1769
|
query_params = opts[:query_params] || {}
|
@@ -1699,11 +1771,11 @@ module KlaviyoAPI
|
|
1699
1771
|
# header parameters
|
1700
1772
|
header_params = opts[:header_params] || {}
|
1701
1773
|
# klaviyo api revision
|
1702
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1774
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1703
1775
|
# HTTP header 'Accept' (if needed)
|
1704
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1776
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1705
1777
|
# HTTP header 'Content-Type'
|
1706
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1778
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1707
1779
|
if !content_type.nil?
|
1708
1780
|
header_params['Content-Type'] = content_type
|
1709
1781
|
end
|
@@ -1712,16 +1784,16 @@ module KlaviyoAPI
|
|
1712
1784
|
form_params = opts[:form_params] || {}
|
1713
1785
|
|
1714
1786
|
# http body (model)
|
1715
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
1787
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_message_partial_update_query)
|
1716
1788
|
|
1717
1789
|
# return_type
|
1718
|
-
return_type = opts[:debug_return_type]
|
1790
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1719
1791
|
|
1720
1792
|
# auth_names
|
1721
1793
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1722
1794
|
|
1723
1795
|
new_options = opts.merge(
|
1724
|
-
:operation => :"CampaignsApi.
|
1796
|
+
:operation => :"CampaignsApi.update_campaign_message",
|
1725
1797
|
:header_params => header_params,
|
1726
1798
|
:query_params => query_params,
|
1727
1799
|
:form_params => form_params,
|
@@ -1732,7 +1804,7 @@ module KlaviyoAPI
|
|
1732
1804
|
|
1733
1805
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
1734
1806
|
if @api_client.config.debugging
|
1735
|
-
@api_client.config.logger.debug "API called: CampaignsApi#
|
1807
|
+
@api_client.config.logger.debug "API called: CampaignsApi#update_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1736
1808
|
end
|
1737
1809
|
return data, status_code, headers
|
1738
1810
|
end
|