klaviyo-api-sdk 9.0.0 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +29 -0
- data/README.md +1265 -519
- 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 +1025 -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 +248 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +2 -7
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -3
- metadata +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,6 +19,334 @@ module KlaviyoAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Bulk Subscribe Profiles
|
23
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
24
|
+
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def bulk_subscribe_profiles(subscription_create_job_create_query, opts = {})
|
28
|
+
bulk_subscribe_profiles_with_http_info(subscription_create_job_create_query, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# alias of `bulk_subscribe_profiles`
|
33
|
+
alias subscribe_profiles bulk_subscribe_profiles
|
34
|
+
|
35
|
+
# alias of `bulk_subscribe_profiles`
|
36
|
+
alias create_profile_subscription_bulk_create_job bulk_subscribe_profiles
|
37
|
+
|
38
|
+
# Bulk Subscribe Profiles
|
39
|
+
# Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
40
|
+
# @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
43
|
+
def bulk_subscribe_profiles_with_http_info(subscription_create_job_create_query, opts = {})
|
44
|
+
if @api_client.config.debugging
|
45
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_subscribe_profiles ...'
|
46
|
+
end
|
47
|
+
# verify the required parameter 'subscription_create_job_create_query' is set
|
48
|
+
if @api_client.config.client_side_validation && subscription_create_job_create_query.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'subscription_create_job_create_query' when calling ProfilesApi.bulk_subscribe_profiles"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/profile-subscription-bulk-create-jobs'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# klaviyo api revision
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
61
|
+
# HTTP header 'Accept' (if needed)
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
|
+
# HTTP header 'Content-Type'
|
64
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
65
|
+
if !content_type.nil?
|
66
|
+
header_params['Content-Type'] = content_type
|
67
|
+
end
|
68
|
+
|
69
|
+
# form parameters
|
70
|
+
form_params = opts[:form_params] || {}
|
71
|
+
|
72
|
+
# http body (model)
|
73
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_create_job_create_query)
|
74
|
+
|
75
|
+
# return_type
|
76
|
+
return_type = opts[:debug_return_type]
|
77
|
+
|
78
|
+
# auth_names
|
79
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
80
|
+
|
81
|
+
new_options = opts.merge(
|
82
|
+
:operation => :"ProfilesApi.bulk_subscribe_profiles",
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => return_type
|
89
|
+
)
|
90
|
+
|
91
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug "API called: ProfilesApi#bulk_subscribe_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
94
|
+
end
|
95
|
+
return data, status_code, headers
|
96
|
+
end
|
97
|
+
|
98
|
+
# alias of `bulk_subscribe_profiles_with_http_info`
|
99
|
+
alias subscribe_profiles_with_http_info bulk_subscribe_profiles_with_http_info
|
100
|
+
|
101
|
+
# alias of `bulk_subscribe_profiles_with_http_info`
|
102
|
+
alias create_profile_subscription_bulk_create_job_with_http_info bulk_subscribe_profiles_with_http_info
|
103
|
+
|
104
|
+
# Bulk Suppress Profiles
|
105
|
+
# Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
106
|
+
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @return [Hash<String, Object>]
|
109
|
+
def bulk_suppress_profiles(suppression_create_job_create_query, opts = {})
|
110
|
+
data, _status_code, _headers = bulk_suppress_profiles_with_http_info(suppression_create_job_create_query, opts)
|
111
|
+
data
|
112
|
+
end
|
113
|
+
|
114
|
+
# alias of `bulk_suppress_profiles`
|
115
|
+
alias suppress_profiles bulk_suppress_profiles
|
116
|
+
|
117
|
+
# alias of `bulk_suppress_profiles`
|
118
|
+
alias create_profile_suppression_bulk_create_job bulk_suppress_profiles
|
119
|
+
|
120
|
+
# Bulk Suppress Profiles
|
121
|
+
# Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
122
|
+
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
123
|
+
# @param [Hash] opts the optional parameters
|
124
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
125
|
+
def bulk_suppress_profiles_with_http_info(suppression_create_job_create_query, opts = {})
|
126
|
+
if @api_client.config.debugging
|
127
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_suppress_profiles ...'
|
128
|
+
end
|
129
|
+
# verify the required parameter 'suppression_create_job_create_query' is set
|
130
|
+
if @api_client.config.client_side_validation && suppression_create_job_create_query.nil?
|
131
|
+
fail ArgumentError, "Missing the required parameter 'suppression_create_job_create_query' when calling ProfilesApi.bulk_suppress_profiles"
|
132
|
+
end
|
133
|
+
# resource path
|
134
|
+
local_var_path = '/api/profile-suppression-bulk-create-jobs'
|
135
|
+
|
136
|
+
# query parameters
|
137
|
+
query_params = opts[:query_params] || {}
|
138
|
+
|
139
|
+
# header parameters
|
140
|
+
header_params = opts[:header_params] || {}
|
141
|
+
# klaviyo api revision
|
142
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
143
|
+
# HTTP header 'Accept' (if needed)
|
144
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
145
|
+
# HTTP header 'Content-Type'
|
146
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
147
|
+
if !content_type.nil?
|
148
|
+
header_params['Content-Type'] = content_type
|
149
|
+
end
|
150
|
+
|
151
|
+
# form parameters
|
152
|
+
form_params = opts[:form_params] || {}
|
153
|
+
|
154
|
+
# http body (model)
|
155
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_create_job_create_query)
|
156
|
+
|
157
|
+
# return_type
|
158
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
159
|
+
|
160
|
+
# auth_names
|
161
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
162
|
+
|
163
|
+
new_options = opts.merge(
|
164
|
+
:operation => :"ProfilesApi.bulk_suppress_profiles",
|
165
|
+
:header_params => header_params,
|
166
|
+
:query_params => query_params,
|
167
|
+
:form_params => form_params,
|
168
|
+
:body => post_body,
|
169
|
+
:auth_names => auth_names,
|
170
|
+
:return_type => return_type
|
171
|
+
)
|
172
|
+
|
173
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug "API called: ProfilesApi#bulk_suppress_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
176
|
+
end
|
177
|
+
return data, status_code, headers
|
178
|
+
end
|
179
|
+
|
180
|
+
# alias of `bulk_suppress_profiles_with_http_info`
|
181
|
+
alias suppress_profiles_with_http_info bulk_suppress_profiles_with_http_info
|
182
|
+
|
183
|
+
# alias of `bulk_suppress_profiles_with_http_info`
|
184
|
+
alias create_profile_suppression_bulk_create_job_with_http_info bulk_suppress_profiles_with_http_info
|
185
|
+
|
186
|
+
# Bulk Unsubscribe Profiles
|
187
|
+
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
188
|
+
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
189
|
+
# @param [Hash] opts the optional parameters
|
190
|
+
# @return [nil]
|
191
|
+
def bulk_unsubscribe_profiles(subscription_delete_job_create_query, opts = {})
|
192
|
+
bulk_unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts)
|
193
|
+
nil
|
194
|
+
end
|
195
|
+
|
196
|
+
# alias of `bulk_unsubscribe_profiles`
|
197
|
+
alias unsubscribe_profiles bulk_unsubscribe_profiles
|
198
|
+
|
199
|
+
# alias of `bulk_unsubscribe_profiles`
|
200
|
+
alias create_profile_subscription_bulk_delete_job bulk_unsubscribe_profiles
|
201
|
+
|
202
|
+
# Bulk Unsubscribe Profiles
|
203
|
+
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
204
|
+
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
205
|
+
# @param [Hash] opts the optional parameters
|
206
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
207
|
+
def bulk_unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts = {})
|
208
|
+
if @api_client.config.debugging
|
209
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_unsubscribe_profiles ...'
|
210
|
+
end
|
211
|
+
# verify the required parameter 'subscription_delete_job_create_query' is set
|
212
|
+
if @api_client.config.client_side_validation && subscription_delete_job_create_query.nil?
|
213
|
+
fail ArgumentError, "Missing the required parameter 'subscription_delete_job_create_query' when calling ProfilesApi.bulk_unsubscribe_profiles"
|
214
|
+
end
|
215
|
+
# resource path
|
216
|
+
local_var_path = '/api/profile-subscription-bulk-delete-jobs'
|
217
|
+
|
218
|
+
# query parameters
|
219
|
+
query_params = opts[:query_params] || {}
|
220
|
+
|
221
|
+
# header parameters
|
222
|
+
header_params = opts[:header_params] || {}
|
223
|
+
# klaviyo api revision
|
224
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
225
|
+
# HTTP header 'Accept' (if needed)
|
226
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
227
|
+
# HTTP header 'Content-Type'
|
228
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
229
|
+
if !content_type.nil?
|
230
|
+
header_params['Content-Type'] = content_type
|
231
|
+
end
|
232
|
+
|
233
|
+
# form parameters
|
234
|
+
form_params = opts[:form_params] || {}
|
235
|
+
|
236
|
+
# http body (model)
|
237
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_delete_job_create_query)
|
238
|
+
|
239
|
+
# return_type
|
240
|
+
return_type = opts[:debug_return_type]
|
241
|
+
|
242
|
+
# auth_names
|
243
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
244
|
+
|
245
|
+
new_options = opts.merge(
|
246
|
+
:operation => :"ProfilesApi.bulk_unsubscribe_profiles",
|
247
|
+
:header_params => header_params,
|
248
|
+
:query_params => query_params,
|
249
|
+
:form_params => form_params,
|
250
|
+
:body => post_body,
|
251
|
+
:auth_names => auth_names,
|
252
|
+
:return_type => return_type
|
253
|
+
)
|
254
|
+
|
255
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
256
|
+
if @api_client.config.debugging
|
257
|
+
@api_client.config.logger.debug "API called: ProfilesApi#bulk_unsubscribe_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
258
|
+
end
|
259
|
+
return data, status_code, headers
|
260
|
+
end
|
261
|
+
|
262
|
+
# alias of `bulk_unsubscribe_profiles_with_http_info`
|
263
|
+
alias unsubscribe_profiles_with_http_info bulk_unsubscribe_profiles_with_http_info
|
264
|
+
|
265
|
+
# alias of `bulk_unsubscribe_profiles_with_http_info`
|
266
|
+
alias create_profile_subscription_bulk_delete_job_with_http_info bulk_unsubscribe_profiles_with_http_info
|
267
|
+
|
268
|
+
# Bulk Unsuppress Profiles
|
269
|
+
# Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
|
270
|
+
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
271
|
+
# @param [Hash] opts the optional parameters
|
272
|
+
# @return [Hash<String, Object>]
|
273
|
+
def bulk_unsuppress_profiles(suppression_delete_job_create_query, opts = {})
|
274
|
+
data, _status_code, _headers = bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts)
|
275
|
+
data
|
276
|
+
end
|
277
|
+
|
278
|
+
# alias of `bulk_unsuppress_profiles`
|
279
|
+
alias unsuppress_profiles bulk_unsuppress_profiles
|
280
|
+
|
281
|
+
# alias of `bulk_unsuppress_profiles`
|
282
|
+
alias create_profile_suppression_bulk_delete_job bulk_unsuppress_profiles
|
283
|
+
|
284
|
+
# Bulk Unsuppress Profiles
|
285
|
+
# Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
|
286
|
+
# @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
|
287
|
+
# @param [Hash] opts the optional parameters
|
288
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
289
|
+
def bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts = {})
|
290
|
+
if @api_client.config.debugging
|
291
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_unsuppress_profiles ...'
|
292
|
+
end
|
293
|
+
# verify the required parameter 'suppression_delete_job_create_query' is set
|
294
|
+
if @api_client.config.client_side_validation && suppression_delete_job_create_query.nil?
|
295
|
+
fail ArgumentError, "Missing the required parameter 'suppression_delete_job_create_query' when calling ProfilesApi.bulk_unsuppress_profiles"
|
296
|
+
end
|
297
|
+
# resource path
|
298
|
+
local_var_path = '/api/profile-suppression-bulk-delete-jobs'
|
299
|
+
|
300
|
+
# query parameters
|
301
|
+
query_params = opts[:query_params] || {}
|
302
|
+
|
303
|
+
# header parameters
|
304
|
+
header_params = opts[:header_params] || {}
|
305
|
+
# klaviyo api revision
|
306
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
307
|
+
# HTTP header 'Accept' (if needed)
|
308
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
309
|
+
# HTTP header 'Content-Type'
|
310
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
311
|
+
if !content_type.nil?
|
312
|
+
header_params['Content-Type'] = content_type
|
313
|
+
end
|
314
|
+
|
315
|
+
# form parameters
|
316
|
+
form_params = opts[:form_params] || {}
|
317
|
+
|
318
|
+
# http body (model)
|
319
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_delete_job_create_query)
|
320
|
+
|
321
|
+
# return_type
|
322
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
323
|
+
|
324
|
+
# auth_names
|
325
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
326
|
+
|
327
|
+
new_options = opts.merge(
|
328
|
+
:operation => :"ProfilesApi.bulk_unsuppress_profiles",
|
329
|
+
:header_params => header_params,
|
330
|
+
:query_params => query_params,
|
331
|
+
:form_params => form_params,
|
332
|
+
:body => post_body,
|
333
|
+
:auth_names => auth_names,
|
334
|
+
:return_type => return_type
|
335
|
+
)
|
336
|
+
|
337
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
338
|
+
if @api_client.config.debugging
|
339
|
+
@api_client.config.logger.debug "API called: ProfilesApi#bulk_unsuppress_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
340
|
+
end
|
341
|
+
return data, status_code, headers
|
342
|
+
end
|
343
|
+
|
344
|
+
# alias of `bulk_unsuppress_profiles_with_http_info`
|
345
|
+
alias unsuppress_profiles_with_http_info bulk_unsuppress_profiles_with_http_info
|
346
|
+
|
347
|
+
# alias of `bulk_unsuppress_profiles_with_http_info`
|
348
|
+
alias create_profile_suppression_bulk_delete_job_with_http_info bulk_unsuppress_profiles_with_http_info
|
349
|
+
|
22
350
|
# Create or Update Profile
|
23
351
|
# Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
24
352
|
# @param profile_upsert_query [ProfileUpsertQuery]
|
@@ -46,7 +374,7 @@ module KlaviyoAPI
|
|
46
374
|
fail ArgumentError, "Missing the required parameter 'profile_upsert_query' when calling ProfilesApi.create_or_update_profile"
|
47
375
|
end
|
48
376
|
# resource path
|
49
|
-
local_var_path = '/api/profile-import
|
377
|
+
local_var_path = '/api/profile-import'
|
50
378
|
|
51
379
|
# query parameters
|
52
380
|
query_params = opts[:query_params] || {}
|
@@ -54,11 +382,11 @@ module KlaviyoAPI
|
|
54
382
|
# header parameters
|
55
383
|
header_params = opts[:header_params] || {}
|
56
384
|
# klaviyo api revision
|
57
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
385
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
58
386
|
# HTTP header 'Accept' (if needed)
|
59
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
387
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
60
388
|
# HTTP header 'Content-Type'
|
61
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
389
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
62
390
|
if !content_type.nil?
|
63
391
|
header_params['Content-Type'] = content_type
|
64
392
|
end
|
@@ -119,7 +447,7 @@ module KlaviyoAPI
|
|
119
447
|
fail ArgumentError, "Missing the required parameter 'profile_create_query' when calling ProfilesApi.create_profile"
|
120
448
|
end
|
121
449
|
# resource path
|
122
|
-
local_var_path = '/api/profiles
|
450
|
+
local_var_path = '/api/profiles'
|
123
451
|
|
124
452
|
# query parameters
|
125
453
|
query_params = opts[:query_params] || {}
|
@@ -127,11 +455,11 @@ module KlaviyoAPI
|
|
127
455
|
# header parameters
|
128
456
|
header_params = opts[:header_params] || {}
|
129
457
|
# klaviyo api revision
|
130
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
458
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
131
459
|
# HTTP header 'Accept' (if needed)
|
132
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
460
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
133
461
|
# HTTP header 'Content-Type'
|
134
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
462
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
135
463
|
if !content_type.nil?
|
136
464
|
header_params['Content-Type'] = content_type
|
137
465
|
end
|
@@ -189,7 +517,7 @@ module KlaviyoAPI
|
|
189
517
|
fail ArgumentError, "Missing the required parameter 'push_token_create_query' when calling ProfilesApi.create_push_token"
|
190
518
|
end
|
191
519
|
# resource path
|
192
|
-
local_var_path = '/api/push-tokens
|
520
|
+
local_var_path = '/api/push-tokens'
|
193
521
|
|
194
522
|
# query parameters
|
195
523
|
query_params = opts[:query_params] || {}
|
@@ -197,11 +525,11 @@ module KlaviyoAPI
|
|
197
525
|
# header parameters
|
198
526
|
header_params = opts[:header_params] || {}
|
199
527
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
528
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
201
529
|
# HTTP header 'Accept' (if needed)
|
202
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
530
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
203
531
|
# HTTP header 'Content-Type'
|
204
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
532
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
205
533
|
if !content_type.nil?
|
206
534
|
header_params['Content-Type'] = content_type
|
207
535
|
end
|
@@ -235,37 +563,40 @@ module KlaviyoAPI
|
|
235
563
|
return data, status_code, headers
|
236
564
|
end
|
237
565
|
|
238
|
-
# Get Bulk
|
566
|
+
# Get Bulk Import Profiles Job
|
239
567
|
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
240
568
|
# @param job_id [String] ID of the job to retrieve.
|
241
569
|
# @param [Hash] opts the optional parameters
|
242
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-
|
243
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-
|
244
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
570
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
571
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
572
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
245
573
|
# @return [Hash<String, Object>]
|
246
|
-
def
|
247
|
-
data, _status_code, _headers =
|
574
|
+
def get_bulk_import_profiles_job(job_id, opts = {})
|
575
|
+
data, _status_code, _headers = get_bulk_import_profiles_job_with_http_info(job_id, opts)
|
248
576
|
data
|
249
577
|
end
|
250
578
|
|
251
|
-
# alias of `
|
252
|
-
alias
|
579
|
+
# alias of `get_bulk_import_profiles_job`
|
580
|
+
alias get_bulk_profile_import_job get_bulk_import_profiles_job
|
581
|
+
|
582
|
+
# alias of `get_bulk_import_profiles_job`
|
583
|
+
alias get_profile_bulk_import_job get_bulk_import_profiles_job
|
253
584
|
|
254
|
-
# Get Bulk
|
585
|
+
# Get Bulk Import Profiles Job
|
255
586
|
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
256
587
|
# @param job_id [String] ID of the job to retrieve.
|
257
588
|
# @param [Hash] opts the optional parameters
|
258
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-
|
259
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-
|
260
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-
|
589
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
590
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
591
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
261
592
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
262
|
-
def
|
593
|
+
def get_bulk_import_profiles_job_with_http_info(job_id, opts = {})
|
263
594
|
if @api_client.config.debugging
|
264
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
595
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_import_profiles_job ...'
|
265
596
|
end
|
266
597
|
# verify the required parameter 'job_id' is set
|
267
598
|
if @api_client.config.client_side_validation && job_id.nil?
|
268
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.
|
599
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_import_profiles_job"
|
269
600
|
end
|
270
601
|
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
271
602
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
@@ -275,25 +606,127 @@ module KlaviyoAPI
|
|
275
606
|
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
276
607
|
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
277
608
|
end
|
278
|
-
allowable_values = ["lists"]
|
279
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
280
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
609
|
+
allowable_values = ["lists"]
|
610
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
611
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
612
|
+
end
|
613
|
+
# resource path
|
614
|
+
local_var_path = '/api/profile-bulk-import-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
615
|
+
|
616
|
+
# query parameters
|
617
|
+
query_params = opts[:query_params] || {}
|
618
|
+
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
619
|
+
query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
|
620
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
621
|
+
|
622
|
+
# header parameters
|
623
|
+
header_params = opts[:header_params] || {}
|
624
|
+
# klaviyo api revision
|
625
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
626
|
+
# HTTP header 'Accept' (if needed)
|
627
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
628
|
+
|
629
|
+
# form parameters
|
630
|
+
form_params = opts[:form_params] || {}
|
631
|
+
|
632
|
+
# http body (model)
|
633
|
+
post_body = opts[:debug_body]
|
634
|
+
|
635
|
+
# return_type
|
636
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
637
|
+
|
638
|
+
# auth_names
|
639
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
640
|
+
|
641
|
+
new_options = opts.merge(
|
642
|
+
:operation => :"ProfilesApi.get_bulk_import_profiles_job",
|
643
|
+
:header_params => header_params,
|
644
|
+
:query_params => query_params,
|
645
|
+
:form_params => form_params,
|
646
|
+
:body => post_body,
|
647
|
+
:auth_names => auth_names,
|
648
|
+
:return_type => return_type
|
649
|
+
)
|
650
|
+
|
651
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
652
|
+
if @api_client.config.debugging
|
653
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
654
|
+
end
|
655
|
+
return data, status_code, headers
|
656
|
+
end
|
657
|
+
|
658
|
+
# alias of `get_bulk_import_profiles_job_with_http_info`
|
659
|
+
alias get_bulk_profile_import_job_with_http_info get_bulk_import_profiles_job_with_http_info
|
660
|
+
|
661
|
+
# alias of `get_bulk_import_profiles_job_with_http_info`
|
662
|
+
alias get_profile_bulk_import_job_with_http_info get_bulk_import_profiles_job_with_http_info
|
663
|
+
|
664
|
+
# Get Bulk Import Profiles Jobs
|
665
|
+
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
666
|
+
# @param [Hash] opts the optional parameters
|
667
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
668
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
669
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
670
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
671
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
672
|
+
# @return [Hash<String, Object>]
|
673
|
+
def get_bulk_import_profiles_jobs(opts = {})
|
674
|
+
data, _status_code, _headers = get_bulk_import_profiles_jobs_with_http_info(opts)
|
675
|
+
data
|
676
|
+
end
|
677
|
+
|
678
|
+
# alias of `get_bulk_import_profiles_jobs`
|
679
|
+
alias get_bulk_profile_import_jobs get_bulk_import_profiles_jobs
|
680
|
+
|
681
|
+
# alias of `get_bulk_import_profiles_jobs`
|
682
|
+
alias get_profile_bulk_import_jobs get_bulk_import_profiles_jobs
|
683
|
+
|
684
|
+
# Get Bulk Import Profiles Jobs
|
685
|
+
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
686
|
+
# @param [Hash] opts the optional parameters
|
687
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
688
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
689
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
690
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
691
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
692
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
693
|
+
def get_bulk_import_profiles_jobs_with_http_info(opts = {})
|
694
|
+
if @api_client.config.debugging
|
695
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_import_profiles_jobs ...'
|
696
|
+
end
|
697
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "expires_at", "started_at"]
|
698
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
699
|
+
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
700
|
+
end
|
701
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
702
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_import_profiles_jobs, must be smaller than or equal to 100.'
|
703
|
+
end
|
704
|
+
|
705
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
706
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_import_profiles_jobs, must be greater than or equal to 1.'
|
707
|
+
end
|
708
|
+
|
709
|
+
allowable_values = ["created_at", "-created_at"]
|
710
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
711
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
281
712
|
end
|
282
713
|
# resource path
|
283
|
-
local_var_path = '/api/profile-bulk-import-jobs
|
714
|
+
local_var_path = '/api/profile-bulk-import-jobs'
|
284
715
|
|
285
716
|
# query parameters
|
286
717
|
query_params = opts[:query_params] || {}
|
287
|
-
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
288
718
|
query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
|
289
|
-
query_params[:'
|
719
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
720
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
721
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
722
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
290
723
|
|
291
724
|
# header parameters
|
292
725
|
header_params = opts[:header_params] || {}
|
293
726
|
# klaviyo api revision
|
294
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
727
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
295
728
|
# HTTP header 'Accept' (if needed)
|
296
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
729
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
297
730
|
|
298
731
|
# form parameters
|
299
732
|
form_params = opts[:form_params] || {}
|
@@ -308,7 +741,7 @@ module KlaviyoAPI
|
|
308
741
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
309
742
|
|
310
743
|
new_options = opts.merge(
|
311
|
-
:operation => :"ProfilesApi.
|
744
|
+
:operation => :"ProfilesApi.get_bulk_import_profiles_jobs",
|
312
745
|
:header_params => header_params,
|
313
746
|
:query_params => query_params,
|
314
747
|
:form_params => form_params,
|
@@ -319,73 +752,62 @@ module KlaviyoAPI
|
|
319
752
|
|
320
753
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
321
754
|
if @api_client.config.debugging
|
322
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
755
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_import_profiles_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
323
756
|
end
|
324
757
|
return data, status_code, headers
|
325
758
|
end
|
326
759
|
|
327
|
-
# alias of `
|
328
|
-
alias
|
760
|
+
# alias of `get_bulk_import_profiles_jobs_with_http_info`
|
761
|
+
alias get_bulk_profile_import_jobs_with_http_info get_bulk_import_profiles_jobs_with_http_info
|
329
762
|
|
330
|
-
#
|
331
|
-
|
332
|
-
|
763
|
+
# alias of `get_bulk_import_profiles_jobs_with_http_info`
|
764
|
+
alias get_profile_bulk_import_jobs_with_http_info get_bulk_import_profiles_jobs_with_http_info
|
765
|
+
|
766
|
+
# Get Bulk Suppress Profiles Job
|
767
|
+
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
768
|
+
# @param job_id [String] ID of the job to retrieve.
|
333
769
|
# @param [Hash] opts the optional parameters
|
334
|
-
# @option opts [Array<String>] :
|
335
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
336
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
770
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
337
771
|
# @return [Hash<String, Object>]
|
338
|
-
def
|
339
|
-
data, _status_code, _headers =
|
772
|
+
def get_bulk_suppress_profiles_job(job_id, opts = {})
|
773
|
+
data, _status_code, _headers = get_bulk_suppress_profiles_job_with_http_info(job_id, opts)
|
340
774
|
data
|
341
775
|
end
|
342
776
|
|
343
|
-
# alias of `
|
344
|
-
alias
|
777
|
+
# alias of `get_bulk_suppress_profiles_job`
|
778
|
+
alias get_profile_suppression_bulk_create_job get_bulk_suppress_profiles_job
|
345
779
|
|
346
|
-
# Get Bulk
|
347
|
-
# Get
|
348
|
-
# @param
|
780
|
+
# Get Bulk Suppress Profiles Job
|
781
|
+
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
782
|
+
# @param job_id [String] ID of the job to retrieve.
|
349
783
|
# @param [Hash] opts the optional parameters
|
350
|
-
# @option opts [Array<String>] :
|
351
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
352
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
784
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
353
785
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
354
|
-
def
|
786
|
+
def get_bulk_suppress_profiles_job_with_http_info(job_id, opts = {})
|
355
787
|
if @api_client.config.debugging
|
356
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
357
|
-
end
|
358
|
-
# verify the required parameter 'id' is set
|
359
|
-
if @api_client.config.client_side_validation && id.nil?
|
360
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_import_errors"
|
788
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_suppress_profiles_job ...'
|
361
789
|
end
|
362
|
-
|
363
|
-
if @api_client.config.client_side_validation &&
|
364
|
-
fail ArgumentError, "
|
365
|
-
end
|
366
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
367
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_import_errors, must be smaller than or equal to 100.'
|
790
|
+
# verify the required parameter 'job_id' is set
|
791
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
792
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_suppress_profiles_job"
|
368
793
|
end
|
369
|
-
|
370
|
-
if @api_client.config.client_side_validation &&
|
371
|
-
fail ArgumentError,
|
794
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
|
795
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
796
|
+
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
|
372
797
|
end
|
373
|
-
|
374
798
|
# resource path
|
375
|
-
local_var_path = '/api/profile-bulk-
|
799
|
+
local_var_path = '/api/profile-suppression-bulk-create-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
376
800
|
|
377
801
|
# query parameters
|
378
802
|
query_params = opts[:query_params] || {}
|
379
|
-
query_params[:'fields[
|
380
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
381
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
803
|
+
query_params[:'fields[profile-suppression-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_create_job'], :csv) if !opts[:'fields_profile_suppression_bulk_create_job'].nil?
|
382
804
|
|
383
805
|
# header parameters
|
384
806
|
header_params = opts[:header_params] || {}
|
385
807
|
# klaviyo api revision
|
386
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
808
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
387
809
|
# HTTP header 'Accept' (if needed)
|
388
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
810
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
389
811
|
|
390
812
|
# form parameters
|
391
813
|
form_params = opts[:form_params] || {}
|
@@ -400,7 +822,7 @@ module KlaviyoAPI
|
|
400
822
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
401
823
|
|
402
824
|
new_options = opts.merge(
|
403
|
-
:operation => :"ProfilesApi.
|
825
|
+
:operation => :"ProfilesApi.get_bulk_suppress_profiles_job",
|
404
826
|
:header_params => header_params,
|
405
827
|
:query_params => query_params,
|
406
828
|
:form_params => form_params,
|
@@ -411,59 +833,66 @@ module KlaviyoAPI
|
|
411
833
|
|
412
834
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
413
835
|
if @api_client.config.debugging
|
414
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
836
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_suppress_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
415
837
|
end
|
416
838
|
return data, status_code, headers
|
417
839
|
end
|
418
840
|
|
419
|
-
# alias of `
|
420
|
-
alias
|
841
|
+
# alias of `get_bulk_suppress_profiles_job_with_http_info`
|
842
|
+
alias get_profile_suppression_bulk_create_job_with_http_info get_bulk_suppress_profiles_job_with_http_info
|
421
843
|
|
422
|
-
# Get Bulk
|
423
|
-
# Get
|
424
|
-
# @param id [String]
|
844
|
+
# Get Bulk Suppress Profiles Jobs
|
845
|
+
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
425
846
|
# @param [Hash] opts the optional parameters
|
426
|
-
# @option opts [Array<String>] :
|
847
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
848
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
849
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
850
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
427
851
|
# @return [Hash<String, Object>]
|
428
|
-
def
|
429
|
-
data, _status_code, _headers =
|
852
|
+
def get_bulk_suppress_profiles_jobs(opts = {})
|
853
|
+
data, _status_code, _headers = get_bulk_suppress_profiles_jobs_with_http_info(opts)
|
430
854
|
data
|
431
855
|
end
|
432
856
|
|
433
|
-
# alias of `
|
434
|
-
alias
|
857
|
+
# alias of `get_bulk_suppress_profiles_jobs`
|
858
|
+
alias get_profile_suppression_bulk_create_jobs get_bulk_suppress_profiles_jobs
|
435
859
|
|
436
|
-
# Get Bulk
|
437
|
-
# Get
|
438
|
-
# @param id [String]
|
860
|
+
# Get Bulk Suppress Profiles Jobs
|
861
|
+
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
439
862
|
# @param [Hash] opts the optional parameters
|
440
|
-
# @option opts [Array<String>] :
|
863
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
864
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
865
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
866
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
441
867
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
442
|
-
def
|
868
|
+
def get_bulk_suppress_profiles_jobs_with_http_info(opts = {})
|
443
869
|
if @api_client.config.debugging
|
444
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
870
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_suppress_profiles_jobs ...'
|
445
871
|
end
|
446
|
-
|
447
|
-
if @api_client.config.client_side_validation &&
|
448
|
-
fail ArgumentError, "
|
872
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
|
873
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
874
|
+
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
|
449
875
|
end
|
450
|
-
allowable_values = ["
|
451
|
-
if @api_client.config.client_side_validation && opts[:'
|
452
|
-
fail ArgumentError, "invalid value for \"
|
876
|
+
allowable_values = ["created", "-created"]
|
877
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
878
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
453
879
|
end
|
454
880
|
# resource path
|
455
|
-
local_var_path = '/api/profile-bulk-
|
881
|
+
local_var_path = '/api/profile-suppression-bulk-create-jobs'
|
456
882
|
|
457
883
|
# query parameters
|
458
884
|
query_params = opts[:query_params] || {}
|
459
|
-
query_params[:'fields[
|
885
|
+
query_params[:'fields[profile-suppression-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_create_job'], :csv) if !opts[:'fields_profile_suppression_bulk_create_job'].nil?
|
886
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
887
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
888
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
460
889
|
|
461
890
|
# header parameters
|
462
891
|
header_params = opts[:header_params] || {}
|
463
892
|
# klaviyo api revision
|
464
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
893
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
465
894
|
# HTTP header 'Accept' (if needed)
|
466
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
895
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
467
896
|
|
468
897
|
# form parameters
|
469
898
|
form_params = opts[:form_params] || {}
|
@@ -478,7 +907,7 @@ module KlaviyoAPI
|
|
478
907
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
479
908
|
|
480
909
|
new_options = opts.merge(
|
481
|
-
:operation => :"ProfilesApi.
|
910
|
+
:operation => :"ProfilesApi.get_bulk_suppress_profiles_jobs",
|
482
911
|
:header_params => header_params,
|
483
912
|
:query_params => query_params,
|
484
913
|
:form_params => form_params,
|
@@ -489,80 +918,59 @@ module KlaviyoAPI
|
|
489
918
|
|
490
919
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
491
920
|
if @api_client.config.debugging
|
492
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
921
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_suppress_profiles_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
493
922
|
end
|
494
923
|
return data, status_code, headers
|
495
924
|
end
|
496
925
|
|
497
|
-
# alias of `
|
498
|
-
alias
|
926
|
+
# alias of `get_bulk_suppress_profiles_jobs_with_http_info`
|
927
|
+
alias get_profile_suppression_bulk_create_jobs_with_http_info get_bulk_suppress_profiles_jobs_with_http_info
|
499
928
|
|
500
|
-
# Get Bulk
|
501
|
-
# Get
|
502
|
-
# @param
|
929
|
+
# Get Bulk Unsuppress Profiles Job
|
930
|
+
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
931
|
+
# @param job_id [String] ID of the job to retrieve.
|
503
932
|
# @param [Hash] opts the optional parameters
|
504
|
-
# @option opts [Array<String>] :
|
505
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
506
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
507
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
933
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
508
934
|
# @return [Hash<String, Object>]
|
509
|
-
def
|
510
|
-
data, _status_code, _headers =
|
935
|
+
def get_bulk_unsuppress_profiles_job(job_id, opts = {})
|
936
|
+
data, _status_code, _headers = get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts)
|
511
937
|
data
|
512
938
|
end
|
513
939
|
|
514
|
-
# alias of `
|
515
|
-
alias
|
940
|
+
# alias of `get_bulk_unsuppress_profiles_job`
|
941
|
+
alias get_profile_suppression_bulk_delete_job get_bulk_unsuppress_profiles_job
|
516
942
|
|
517
|
-
# Get Bulk
|
518
|
-
# Get
|
519
|
-
# @param
|
943
|
+
# Get Bulk Unsuppress Profiles Job
|
944
|
+
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
945
|
+
# @param job_id [String] ID of the job to retrieve.
|
520
946
|
# @param [Hash] opts the optional parameters
|
521
|
-
# @option opts [Array<String>] :
|
522
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
523
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
524
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
947
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
525
948
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
526
|
-
def
|
949
|
+
def get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts = {})
|
527
950
|
if @api_client.config.debugging
|
528
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
529
|
-
end
|
530
|
-
# verify the required parameter 'id' is set
|
531
|
-
if @api_client.config.client_side_validation && id.nil?
|
532
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_profiles"
|
533
|
-
end
|
534
|
-
allowable_values = ["subscriptions", "predictive_analytics"]
|
535
|
-
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
536
|
-
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
537
|
-
end
|
538
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
539
|
-
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
540
|
-
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
951
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_unsuppress_profiles_job ...'
|
541
952
|
end
|
542
|
-
|
543
|
-
|
953
|
+
# verify the required parameter 'job_id' is set
|
954
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
955
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_unsuppress_profiles_job"
|
544
956
|
end
|
545
|
-
|
546
|
-
if @api_client.config.client_side_validation &&
|
547
|
-
fail ArgumentError,
|
957
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
|
958
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
959
|
+
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
|
548
960
|
end
|
549
|
-
|
550
961
|
# resource path
|
551
|
-
local_var_path = '/api/profile-bulk-
|
962
|
+
local_var_path = '/api/profile-suppression-bulk-delete-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
552
963
|
|
553
964
|
# query parameters
|
554
965
|
query_params = opts[:query_params] || {}
|
555
|
-
query_params[:'
|
556
|
-
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
557
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
558
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
966
|
+
query_params[:'fields[profile-suppression-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_delete_job'], :csv) if !opts[:'fields_profile_suppression_bulk_delete_job'].nil?
|
559
967
|
|
560
968
|
# header parameters
|
561
969
|
header_params = opts[:header_params] || {}
|
562
970
|
# klaviyo api revision
|
563
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
971
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
564
972
|
# HTTP header 'Accept' (if needed)
|
565
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
973
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
566
974
|
|
567
975
|
# form parameters
|
568
976
|
form_params = opts[:form_params] || {}
|
@@ -577,7 +985,7 @@ module KlaviyoAPI
|
|
577
985
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
578
986
|
|
579
987
|
new_options = opts.merge(
|
580
|
-
:operation => :"ProfilesApi.
|
988
|
+
:operation => :"ProfilesApi.get_bulk_unsuppress_profiles_job",
|
581
989
|
:header_params => header_params,
|
582
990
|
:query_params => query_params,
|
583
991
|
:form_params => form_params,
|
@@ -588,52 +996,66 @@ module KlaviyoAPI
|
|
588
996
|
|
589
997
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
590
998
|
if @api_client.config.debugging
|
591
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
999
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_unsuppress_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
592
1000
|
end
|
593
1001
|
return data, status_code, headers
|
594
1002
|
end
|
595
1003
|
|
596
|
-
# alias of `
|
597
|
-
alias
|
1004
|
+
# alias of `get_bulk_unsuppress_profiles_job_with_http_info`
|
1005
|
+
alias get_profile_suppression_bulk_delete_job_with_http_info get_bulk_unsuppress_profiles_job_with_http_info
|
598
1006
|
|
599
|
-
# Get Bulk
|
600
|
-
# Get
|
601
|
-
# @param id [String]
|
1007
|
+
# Get Bulk Unsuppress Profiles Jobs
|
1008
|
+
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
602
1009
|
# @param [Hash] opts the optional parameters
|
1010
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1011
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1012
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1013
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
603
1014
|
# @return [Hash<String, Object>]
|
604
|
-
def
|
605
|
-
data, _status_code, _headers =
|
1015
|
+
def get_bulk_unsuppress_profiles_jobs(opts = {})
|
1016
|
+
data, _status_code, _headers = get_bulk_unsuppress_profiles_jobs_with_http_info(opts)
|
606
1017
|
data
|
607
1018
|
end
|
608
1019
|
|
609
|
-
# alias of `
|
610
|
-
alias
|
1020
|
+
# alias of `get_bulk_unsuppress_profiles_jobs`
|
1021
|
+
alias get_profile_suppression_bulk_delete_jobs get_bulk_unsuppress_profiles_jobs
|
611
1022
|
|
612
|
-
# Get Bulk
|
613
|
-
# Get
|
614
|
-
# @param id [String]
|
1023
|
+
# Get Bulk Unsuppress Profiles Jobs
|
1024
|
+
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
615
1025
|
# @param [Hash] opts the optional parameters
|
1026
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1027
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1028
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1029
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
616
1030
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
617
|
-
def
|
1031
|
+
def get_bulk_unsuppress_profiles_jobs_with_http_info(opts = {})
|
618
1032
|
if @api_client.config.debugging
|
619
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1033
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_unsuppress_profiles_jobs ...'
|
620
1034
|
end
|
621
|
-
|
622
|
-
if @api_client.config.client_side_validation &&
|
623
|
-
fail ArgumentError, "
|
1035
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
|
1036
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
1037
|
+
fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
|
1038
|
+
end
|
1039
|
+
allowable_values = ["created", "-created"]
|
1040
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1041
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
624
1042
|
end
|
625
1043
|
# resource path
|
626
|
-
local_var_path = '/api/profile-bulk-
|
1044
|
+
local_var_path = '/api/profile-suppression-bulk-delete-jobs'
|
627
1045
|
|
628
1046
|
# query parameters
|
629
1047
|
query_params = opts[:query_params] || {}
|
1048
|
+
query_params[:'fields[profile-suppression-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_delete_job'], :csv) if !opts[:'fields_profile_suppression_bulk_delete_job'].nil?
|
1049
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1050
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1051
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
630
1052
|
|
631
1053
|
# header parameters
|
632
1054
|
header_params = opts[:header_params] || {}
|
633
1055
|
# klaviyo api revision
|
634
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1056
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
635
1057
|
# HTTP header 'Accept' (if needed)
|
636
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1058
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
637
1059
|
|
638
1060
|
# form parameters
|
639
1061
|
form_params = opts[:form_params] || {}
|
@@ -648,7 +1070,7 @@ module KlaviyoAPI
|
|
648
1070
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
649
1071
|
|
650
1072
|
new_options = opts.merge(
|
651
|
-
:operation => :"ProfilesApi.
|
1073
|
+
:operation => :"ProfilesApi.get_bulk_unsuppress_profiles_jobs",
|
652
1074
|
:header_params => header_params,
|
653
1075
|
:query_params => query_params,
|
654
1076
|
:form_params => form_params,
|
@@ -659,66 +1081,76 @@ module KlaviyoAPI
|
|
659
1081
|
|
660
1082
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
661
1083
|
if @api_client.config.debugging
|
662
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1084
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_bulk_unsuppress_profiles_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
663
1085
|
end
|
664
1086
|
return data, status_code, headers
|
665
1087
|
end
|
666
1088
|
|
667
|
-
# alias of `
|
668
|
-
alias
|
1089
|
+
# alias of `get_bulk_unsuppress_profiles_jobs_with_http_info`
|
1090
|
+
alias get_profile_suppression_bulk_delete_jobs_with_http_info get_bulk_unsuppress_profiles_jobs_with_http_info
|
669
1091
|
|
670
|
-
# Get Bulk
|
671
|
-
# Get
|
1092
|
+
# Get Errors for Bulk Import Profiles Job
|
1093
|
+
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
672
1094
|
# @param id [String]
|
673
1095
|
# @param [Hash] opts the optional parameters
|
674
|
-
# @option opts [String] :
|
1096
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1097
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
675
1098
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
676
1099
|
# @return [Hash<String, Object>]
|
677
|
-
def
|
678
|
-
data, _status_code, _headers =
|
1100
|
+
def get_errors_for_bulk_import_profiles_job(id, opts = {})
|
1101
|
+
data, _status_code, _headers = get_errors_for_bulk_import_profiles_job_with_http_info(id, opts)
|
679
1102
|
data
|
680
1103
|
end
|
681
1104
|
|
682
|
-
# alias of `
|
683
|
-
alias
|
1105
|
+
# alias of `get_errors_for_bulk_import_profiles_job`
|
1106
|
+
alias get_bulk_profile_import_job_import_errors get_errors_for_bulk_import_profiles_job
|
684
1107
|
|
685
|
-
#
|
686
|
-
|
1108
|
+
# alias of `get_errors_for_bulk_import_profiles_job`
|
1109
|
+
alias get_profile_bulk_import_job_import_errors get_errors_for_bulk_import_profiles_job
|
1110
|
+
|
1111
|
+
# Get Errors for Bulk Import Profiles Job
|
1112
|
+
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
687
1113
|
# @param id [String]
|
688
1114
|
# @param [Hash] opts the optional parameters
|
689
|
-
# @option opts [String] :
|
1115
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1116
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
690
1117
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
691
1118
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
692
|
-
def
|
1119
|
+
def get_errors_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
693
1120
|
if @api_client.config.debugging
|
694
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1121
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_errors_for_bulk_import_profiles_job ...'
|
695
1122
|
end
|
696
1123
|
# verify the required parameter 'id' is set
|
697
1124
|
if @api_client.config.client_side_validation && id.nil?
|
698
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
1125
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_errors_for_bulk_import_profiles_job"
|
1126
|
+
end
|
1127
|
+
allowable_values = ["code", "title", "detail", "source", "source.pointer", "original_payload"]
|
1128
|
+
if @api_client.config.client_side_validation && opts[:'fields_import_error'] && !opts[:'fields_import_error'].all? { |item| allowable_values.include?(item) }
|
1129
|
+
fail ArgumentError, "invalid value for \"fields_import_error\", must include one of #{allowable_values}"
|
699
1130
|
end
|
700
1131
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
701
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.
|
1132
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_errors_for_bulk_import_profiles_job, must be smaller than or equal to 100.'
|
702
1133
|
end
|
703
1134
|
|
704
1135
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
705
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.
|
1136
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_errors_for_bulk_import_profiles_job, must be greater than or equal to 1.'
|
706
1137
|
end
|
707
1138
|
|
708
1139
|
# resource path
|
709
|
-
local_var_path = '/api/profile-bulk-import-jobs/{id}/
|
1140
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/import-errors'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
710
1141
|
|
711
1142
|
# query parameters
|
712
1143
|
query_params = opts[:query_params] || {}
|
1144
|
+
query_params[:'fields[import-error]'] = @api_client.build_collection_param(opts[:'fields_import_error'], :csv) if !opts[:'fields_import_error'].nil?
|
713
1145
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
714
1146
|
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
715
1147
|
|
716
1148
|
# header parameters
|
717
1149
|
header_params = opts[:header_params] || {}
|
718
1150
|
# klaviyo api revision
|
719
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1151
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
720
1152
|
# HTTP header 'Accept' (if needed)
|
721
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
722
1154
|
|
723
1155
|
# form parameters
|
724
1156
|
form_params = opts[:form_params] || {}
|
@@ -733,7 +1165,7 @@ module KlaviyoAPI
|
|
733
1165
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
734
1166
|
|
735
1167
|
new_options = opts.merge(
|
736
|
-
:operation => :"ProfilesApi.
|
1168
|
+
:operation => :"ProfilesApi.get_errors_for_bulk_import_profiles_job",
|
737
1169
|
:header_params => header_params,
|
738
1170
|
:query_params => query_params,
|
739
1171
|
:form_params => form_params,
|
@@ -744,77 +1176,65 @@ module KlaviyoAPI
|
|
744
1176
|
|
745
1177
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
746
1178
|
if @api_client.config.debugging
|
747
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1179
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_errors_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
748
1180
|
end
|
749
1181
|
return data, status_code, headers
|
750
1182
|
end
|
751
1183
|
|
752
|
-
# alias of `
|
753
|
-
alias
|
1184
|
+
# alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
|
1185
|
+
alias get_bulk_profile_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
|
754
1186
|
|
755
|
-
#
|
756
|
-
|
1187
|
+
# alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
|
1188
|
+
alias get_profile_bulk_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
|
1189
|
+
|
1190
|
+
# Get List for Bulk Import Profiles Job
|
1191
|
+
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
1192
|
+
# @param id [String]
|
757
1193
|
# @param [Hash] opts the optional parameters
|
758
|
-
# @option opts [Array<String>] :
|
759
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
760
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
761
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
762
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1194
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
763
1195
|
# @return [Hash<String, Object>]
|
764
|
-
def
|
765
|
-
data, _status_code, _headers =
|
1196
|
+
def get_list_for_bulk_import_profiles_job(id, opts = {})
|
1197
|
+
data, _status_code, _headers = get_list_for_bulk_import_profiles_job_with_http_info(id, opts)
|
766
1198
|
data
|
767
1199
|
end
|
768
1200
|
|
769
|
-
# alias of `
|
770
|
-
alias
|
1201
|
+
# alias of `get_list_for_bulk_import_profiles_job`
|
1202
|
+
alias get_bulk_profile_import_job_lists get_list_for_bulk_import_profiles_job
|
771
1203
|
|
772
|
-
#
|
773
|
-
|
1204
|
+
# alias of `get_list_for_bulk_import_profiles_job`
|
1205
|
+
alias get_profile_bulk_import_job_lists get_list_for_bulk_import_profiles_job
|
1206
|
+
|
1207
|
+
# Get List for Bulk Import Profiles Job
|
1208
|
+
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
1209
|
+
# @param id [String]
|
774
1210
|
# @param [Hash] opts the optional parameters
|
775
|
-
# @option opts [Array<String>] :
|
776
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
777
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
778
|
-
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
779
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1211
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
780
1212
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
781
|
-
def
|
1213
|
+
def get_list_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
782
1214
|
if @api_client.config.debugging
|
783
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
784
|
-
end
|
785
|
-
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "expires_at", "started_at"]
|
786
|
-
if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
|
787
|
-
fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
|
788
|
-
end
|
789
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
790
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_jobs, must be smaller than or equal to 100.'
|
1215
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_list_for_bulk_import_profiles_job ...'
|
791
1216
|
end
|
792
|
-
|
793
|
-
if @api_client.config.client_side_validation &&
|
794
|
-
fail ArgumentError,
|
1217
|
+
# verify the required parameter 'id' is set
|
1218
|
+
if @api_client.config.client_side_validation && id.nil?
|
1219
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_for_bulk_import_profiles_job"
|
795
1220
|
end
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1221
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
1222
|
+
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
1223
|
+
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
800
1224
|
end
|
801
1225
|
# resource path
|
802
|
-
local_var_path = '/api/profile-bulk-import-jobs/'
|
1226
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
803
1227
|
|
804
1228
|
# query parameters
|
805
1229
|
query_params = opts[:query_params] || {}
|
806
|
-
query_params[:'fields[
|
807
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
808
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
809
|
-
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
810
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1230
|
+
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
811
1231
|
|
812
1232
|
# header parameters
|
813
1233
|
header_params = opts[:header_params] || {}
|
814
1234
|
# klaviyo api revision
|
815
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1235
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
816
1236
|
# HTTP header 'Accept' (if needed)
|
817
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1237
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
818
1238
|
|
819
1239
|
# form parameters
|
820
1240
|
form_params = opts[:form_params] || {}
|
@@ -829,7 +1249,7 @@ module KlaviyoAPI
|
|
829
1249
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
830
1250
|
|
831
1251
|
new_options = opts.merge(
|
832
|
-
:operation => :"ProfilesApi.
|
1252
|
+
:operation => :"ProfilesApi.get_list_for_bulk_import_profiles_job",
|
833
1253
|
:header_params => header_params,
|
834
1254
|
:query_params => query_params,
|
835
1255
|
:form_params => form_params,
|
@@ -840,84 +1260,58 @@ module KlaviyoAPI
|
|
840
1260
|
|
841
1261
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
842
1262
|
if @api_client.config.debugging
|
843
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1263
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_list_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
844
1264
|
end
|
845
1265
|
return data, status_code, headers
|
846
1266
|
end
|
847
1267
|
|
848
|
-
# alias of `
|
849
|
-
alias
|
1268
|
+
# alias of `get_list_for_bulk_import_profiles_job_with_http_info`
|
1269
|
+
alias get_bulk_profile_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
|
850
1270
|
|
851
|
-
#
|
852
|
-
|
1271
|
+
# alias of `get_list_for_bulk_import_profiles_job_with_http_info`
|
1272
|
+
alias get_profile_bulk_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
|
1273
|
+
|
1274
|
+
# Get List IDs for Bulk Import Profiles Job
|
1275
|
+
# Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
853
1276
|
# @param id [String]
|
854
1277
|
# @param [Hash] opts the optional parameters
|
855
|
-
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
856
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
857
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
858
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
859
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
860
1278
|
# @return [Hash<String, Object>]
|
861
|
-
def
|
862
|
-
data, _status_code, _headers =
|
1279
|
+
def get_list_ids_for_bulk_import_profiles_job(id, opts = {})
|
1280
|
+
data, _status_code, _headers = get_list_ids_for_bulk_import_profiles_job_with_http_info(id, opts)
|
863
1281
|
data
|
864
1282
|
end
|
865
1283
|
|
866
|
-
#
|
867
|
-
|
1284
|
+
# alias of `get_list_ids_for_bulk_import_profiles_job`
|
1285
|
+
alias get_bulk_profile_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
|
1286
|
+
|
1287
|
+
# alias of `get_list_ids_for_bulk_import_profiles_job`
|
1288
|
+
alias get_profile_bulk_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
|
1289
|
+
|
1290
|
+
# Get List IDs for Bulk Import Profiles Job
|
1291
|
+
# Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
868
1292
|
# @param id [String]
|
869
1293
|
# @param [Hash] opts the optional parameters
|
870
|
-
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
871
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
872
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
873
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
874
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
875
1294
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
876
|
-
def
|
1295
|
+
def get_list_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
877
1296
|
if @api_client.config.debugging
|
878
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1297
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_list_ids_for_bulk_import_profiles_job ...'
|
879
1298
|
end
|
880
1299
|
# verify the required parameter 'id' is set
|
881
1300
|
if @api_client.config.client_side_validation && id.nil?
|
882
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
883
|
-
end
|
884
|
-
allowable_values = ["subscriptions", "predictive_analytics"]
|
885
|
-
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
886
|
-
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
887
|
-
end
|
888
|
-
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
889
|
-
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
890
|
-
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
891
|
-
end
|
892
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
893
|
-
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
894
|
-
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
895
|
-
end
|
896
|
-
allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
|
897
|
-
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
898
|
-
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
899
|
-
end
|
900
|
-
allowable_values = ["lists", "segments"]
|
901
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
902
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1301
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_ids_for_bulk_import_profiles_job"
|
903
1302
|
end
|
904
1303
|
# resource path
|
905
|
-
local_var_path = '/api/
|
1304
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
906
1305
|
|
907
1306
|
# query parameters
|
908
1307
|
query_params = opts[:query_params] || {}
|
909
|
-
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
910
|
-
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
911
|
-
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
912
|
-
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
|
913
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
914
1308
|
|
915
1309
|
# header parameters
|
916
1310
|
header_params = opts[:header_params] || {}
|
917
1311
|
# klaviyo api revision
|
918
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1312
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
919
1313
|
# HTTP header 'Accept' (if needed)
|
920
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1314
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
921
1315
|
|
922
1316
|
# form parameters
|
923
1317
|
form_params = opts[:form_params] || {}
|
@@ -932,7 +1326,7 @@ module KlaviyoAPI
|
|
932
1326
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
933
1327
|
|
934
1328
|
new_options = opts.merge(
|
935
|
-
:operation => :"ProfilesApi.
|
1329
|
+
:operation => :"ProfilesApi.get_list_ids_for_bulk_import_profiles_job",
|
936
1330
|
:header_params => header_params,
|
937
1331
|
:query_params => query_params,
|
938
1332
|
:form_params => form_params,
|
@@ -943,53 +1337,55 @@ module KlaviyoAPI
|
|
943
1337
|
|
944
1338
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
945
1339
|
if @api_client.config.debugging
|
946
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1340
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_list_ids_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
947
1341
|
end
|
948
1342
|
return data, status_code, headers
|
949
1343
|
end
|
950
1344
|
|
951
|
-
#
|
1345
|
+
# alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
|
1346
|
+
alias get_bulk_profile_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
|
1347
|
+
|
1348
|
+
# alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
|
1349
|
+
alias get_profile_bulk_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
|
1350
|
+
|
1351
|
+
# Get List IDs for Profile
|
952
1352
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
953
1353
|
# @param id [String]
|
954
1354
|
# @param [Hash] opts the optional parameters
|
955
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
956
1355
|
# @return [Hash<String, Object>]
|
957
|
-
def
|
958
|
-
data, _status_code, _headers =
|
1356
|
+
def get_list_ids_for_profile(id, opts = {})
|
1357
|
+
data, _status_code, _headers = get_list_ids_for_profile_with_http_info(id, opts)
|
959
1358
|
data
|
960
1359
|
end
|
961
1360
|
|
962
|
-
#
|
1361
|
+
# alias of `get_list_ids_for_profile`
|
1362
|
+
alias get_profile_relationships_lists get_list_ids_for_profile
|
1363
|
+
|
1364
|
+
# Get List IDs for Profile
|
963
1365
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
964
1366
|
# @param id [String]
|
965
1367
|
# @param [Hash] opts the optional parameters
|
966
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
967
1368
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
968
|
-
def
|
1369
|
+
def get_list_ids_for_profile_with_http_info(id, opts = {})
|
969
1370
|
if @api_client.config.debugging
|
970
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1371
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_list_ids_for_profile ...'
|
971
1372
|
end
|
972
1373
|
# verify the required parameter 'id' is set
|
973
1374
|
if @api_client.config.client_side_validation && id.nil?
|
974
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
975
|
-
end
|
976
|
-
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
977
|
-
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
978
|
-
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
1375
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_ids_for_profile"
|
979
1376
|
end
|
980
1377
|
# resource path
|
981
|
-
local_var_path = '/api/profiles/{id}/lists
|
1378
|
+
local_var_path = '/api/profiles/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
982
1379
|
|
983
1380
|
# query parameters
|
984
1381
|
query_params = opts[:query_params] || {}
|
985
|
-
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
986
1382
|
|
987
1383
|
# header parameters
|
988
1384
|
header_params = opts[:header_params] || {}
|
989
1385
|
# klaviyo api revision
|
990
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1386
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
991
1387
|
# HTTP header 'Accept' (if needed)
|
992
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1388
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
993
1389
|
|
994
1390
|
# form parameters
|
995
1391
|
form_params = opts[:form_params] || {}
|
@@ -1004,7 +1400,7 @@ module KlaviyoAPI
|
|
1004
1400
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1005
1401
|
|
1006
1402
|
new_options = opts.merge(
|
1007
|
-
:operation => :"ProfilesApi.
|
1403
|
+
:operation => :"ProfilesApi.get_list_ids_for_profile",
|
1008
1404
|
:header_params => header_params,
|
1009
1405
|
:query_params => query_params,
|
1010
1406
|
:form_params => form_params,
|
@@ -1015,46 +1411,59 @@ module KlaviyoAPI
|
|
1015
1411
|
|
1016
1412
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1017
1413
|
if @api_client.config.debugging
|
1018
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1414
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_list_ids_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1019
1415
|
end
|
1020
1416
|
return data, status_code, headers
|
1021
1417
|
end
|
1022
1418
|
|
1023
|
-
#
|
1419
|
+
# alias of `get_list_ids_for_profile_with_http_info`
|
1420
|
+
alias get_profile_relationships_lists_with_http_info get_list_ids_for_profile_with_http_info
|
1421
|
+
|
1422
|
+
# Get Lists for Profile
|
1024
1423
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
1025
1424
|
# @param id [String]
|
1026
1425
|
# @param [Hash] opts the optional parameters
|
1426
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1027
1427
|
# @return [Hash<String, Object>]
|
1028
|
-
def
|
1029
|
-
data, _status_code, _headers =
|
1428
|
+
def get_lists_for_profile(id, opts = {})
|
1429
|
+
data, _status_code, _headers = get_lists_for_profile_with_http_info(id, opts)
|
1030
1430
|
data
|
1031
1431
|
end
|
1032
1432
|
|
1033
|
-
#
|
1433
|
+
# alias of `get_lists_for_profile`
|
1434
|
+
alias get_profile_lists get_lists_for_profile
|
1435
|
+
|
1436
|
+
# Get Lists for Profile
|
1034
1437
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
1035
1438
|
# @param id [String]
|
1036
1439
|
# @param [Hash] opts the optional parameters
|
1440
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1037
1441
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1038
|
-
def
|
1442
|
+
def get_lists_for_profile_with_http_info(id, opts = {})
|
1039
1443
|
if @api_client.config.debugging
|
1040
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1444
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_lists_for_profile ...'
|
1041
1445
|
end
|
1042
1446
|
# verify the required parameter 'id' is set
|
1043
1447
|
if @api_client.config.client_side_validation && id.nil?
|
1044
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
1448
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_lists_for_profile"
|
1449
|
+
end
|
1450
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
1451
|
+
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
1452
|
+
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
1045
1453
|
end
|
1046
1454
|
# resource path
|
1047
|
-
local_var_path = '/api/profiles/{id}/
|
1455
|
+
local_var_path = '/api/profiles/{id}/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1048
1456
|
|
1049
1457
|
# query parameters
|
1050
1458
|
query_params = opts[:query_params] || {}
|
1459
|
+
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
1051
1460
|
|
1052
1461
|
# header parameters
|
1053
1462
|
header_params = opts[:header_params] || {}
|
1054
1463
|
# klaviyo api revision
|
1055
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1464
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1056
1465
|
# HTTP header 'Accept' (if needed)
|
1057
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1466
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1058
1467
|
|
1059
1468
|
# form parameters
|
1060
1469
|
form_params = opts[:form_params] || {}
|
@@ -1069,7 +1478,7 @@ module KlaviyoAPI
|
|
1069
1478
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1070
1479
|
|
1071
1480
|
new_options = opts.merge(
|
1072
|
-
:operation => :"ProfilesApi.
|
1481
|
+
:operation => :"ProfilesApi.get_lists_for_profile",
|
1073
1482
|
:header_params => header_params,
|
1074
1483
|
:query_params => query_params,
|
1075
1484
|
:form_params => form_params,
|
@@ -1080,46 +1489,84 @@ module KlaviyoAPI
|
|
1080
1489
|
|
1081
1490
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1082
1491
|
if @api_client.config.debugging
|
1083
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1492
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_lists_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1084
1493
|
end
|
1085
1494
|
return data, status_code, headers
|
1086
1495
|
end
|
1087
1496
|
|
1088
|
-
#
|
1089
|
-
|
1497
|
+
# alias of `get_lists_for_profile_with_http_info`
|
1498
|
+
alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
|
1499
|
+
|
1500
|
+
# Get Profile
|
1501
|
+
# Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
|
1090
1502
|
# @param id [String]
|
1091
1503
|
# @param [Hash] opts the optional parameters
|
1504
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1505
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1506
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1507
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1508
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1092
1509
|
# @return [Hash<String, Object>]
|
1093
|
-
def
|
1094
|
-
data, _status_code, _headers =
|
1510
|
+
def get_profile(id, opts = {})
|
1511
|
+
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
1095
1512
|
data
|
1096
1513
|
end
|
1097
1514
|
|
1098
|
-
# Get Profile
|
1099
|
-
# Get
|
1515
|
+
# Get Profile
|
1516
|
+
# Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
|
1100
1517
|
# @param id [String]
|
1101
1518
|
# @param [Hash] opts the optional parameters
|
1519
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1520
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1521
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1522
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1523
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1102
1524
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1103
|
-
def
|
1525
|
+
def get_profile_with_http_info(id, opts = {})
|
1104
1526
|
if @api_client.config.debugging
|
1105
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1527
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile ...'
|
1106
1528
|
end
|
1107
1529
|
# verify the required parameter 'id' is set
|
1108
1530
|
if @api_client.config.client_side_validation && id.nil?
|
1109
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
1531
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile"
|
1532
|
+
end
|
1533
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
1534
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
1535
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
1536
|
+
end
|
1537
|
+
allowable_values = ["name", "created", "updated", "opt_in_process"]
|
1538
|
+
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
1539
|
+
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
1540
|
+
end
|
1541
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1542
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1543
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1544
|
+
end
|
1545
|
+
allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
|
1546
|
+
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
1547
|
+
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
1548
|
+
end
|
1549
|
+
allowable_values = ["lists", "segments"]
|
1550
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1551
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1110
1552
|
end
|
1111
1553
|
# resource path
|
1112
|
-
local_var_path = '/api/profiles/{id}
|
1554
|
+
local_var_path = '/api/profiles/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1113
1555
|
|
1114
1556
|
# query parameters
|
1115
1557
|
query_params = opts[:query_params] || {}
|
1558
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
1559
|
+
query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
|
1560
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
1561
|
+
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
|
1562
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1116
1563
|
|
1117
1564
|
# header parameters
|
1118
1565
|
header_params = opts[:header_params] || {}
|
1119
1566
|
# klaviyo api revision
|
1120
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1567
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1121
1568
|
# HTTP header 'Accept' (if needed)
|
1122
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1569
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1123
1570
|
|
1124
1571
|
# form parameters
|
1125
1572
|
form_params = opts[:form_params] || {}
|
@@ -1134,7 +1581,7 @@ module KlaviyoAPI
|
|
1134
1581
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1135
1582
|
|
1136
1583
|
new_options = opts.merge(
|
1137
|
-
:operation => :"ProfilesApi.
|
1584
|
+
:operation => :"ProfilesApi.get_profile",
|
1138
1585
|
:header_params => header_params,
|
1139
1586
|
:query_params => query_params,
|
1140
1587
|
:form_params => form_params,
|
@@ -1145,53 +1592,66 @@ module KlaviyoAPI
|
|
1145
1592
|
|
1146
1593
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1147
1594
|
if @api_client.config.debugging
|
1148
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1595
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1149
1596
|
end
|
1150
1597
|
return data, status_code, headers
|
1151
1598
|
end
|
1152
1599
|
|
1153
|
-
# Get Profile
|
1154
|
-
# Get
|
1600
|
+
# Get Profile IDs for Bulk Import Profiles Job
|
1601
|
+
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1155
1602
|
# @param id [String]
|
1156
1603
|
# @param [Hash] opts the optional parameters
|
1157
|
-
# @option opts [
|
1604
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1605
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1158
1606
|
# @return [Hash<String, Object>]
|
1159
|
-
def
|
1160
|
-
data, _status_code, _headers =
|
1607
|
+
def get_profile_ids_for_bulk_import_profiles_job(id, opts = {})
|
1608
|
+
data, _status_code, _headers = get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts)
|
1161
1609
|
data
|
1162
1610
|
end
|
1163
1611
|
|
1164
|
-
#
|
1165
|
-
|
1612
|
+
# alias of `get_profile_ids_for_bulk_import_profiles_job`
|
1613
|
+
alias get_bulk_profile_import_job_relationships_profiles get_profile_ids_for_bulk_import_profiles_job
|
1614
|
+
|
1615
|
+
# alias of `get_profile_ids_for_bulk_import_profiles_job`
|
1616
|
+
alias get_profile_bulk_import_job_relationships_profiles get_profile_ids_for_bulk_import_profiles_job
|
1617
|
+
|
1618
|
+
# Get Profile IDs for Bulk Import Profiles Job
|
1619
|
+
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1166
1620
|
# @param id [String]
|
1167
1621
|
# @param [Hash] opts the optional parameters
|
1168
|
-
# @option opts [
|
1622
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1623
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1169
1624
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1170
|
-
def
|
1625
|
+
def get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
1171
1626
|
if @api_client.config.debugging
|
1172
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1627
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_ids_for_bulk_import_profiles_job ...'
|
1173
1628
|
end
|
1174
1629
|
# verify the required parameter 'id' is set
|
1175
1630
|
if @api_client.config.client_side_validation && id.nil?
|
1176
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.
|
1631
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_ids_for_bulk_import_profiles_job"
|
1177
1632
|
end
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1633
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
1634
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profile_ids_for_bulk_import_profiles_job, must be smaller than or equal to 100.'
|
1635
|
+
end
|
1636
|
+
|
1637
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1638
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profile_ids_for_bulk_import_profiles_job, must be greater than or equal to 1.'
|
1181
1639
|
end
|
1640
|
+
|
1182
1641
|
# resource path
|
1183
|
-
local_var_path = '/api/
|
1642
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1184
1643
|
|
1185
1644
|
# query parameters
|
1186
1645
|
query_params = opts[:query_params] || {}
|
1187
|
-
query_params[:'
|
1646
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1647
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1188
1648
|
|
1189
1649
|
# header parameters
|
1190
1650
|
header_params = opts[:header_params] || {}
|
1191
1651
|
# klaviyo api revision
|
1192
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1652
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1193
1653
|
# HTTP header 'Accept' (if needed)
|
1194
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1654
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1195
1655
|
|
1196
1656
|
# form parameters
|
1197
1657
|
form_params = opts[:form_params] || {}
|
@@ -1206,7 +1666,7 @@ module KlaviyoAPI
|
|
1206
1666
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1207
1667
|
|
1208
1668
|
new_options = opts.merge(
|
1209
|
-
:operation => :"ProfilesApi.
|
1669
|
+
:operation => :"ProfilesApi.get_profile_ids_for_bulk_import_profiles_job",
|
1210
1670
|
:header_params => header_params,
|
1211
1671
|
:query_params => query_params,
|
1212
1672
|
:form_params => form_params,
|
@@ -1217,20 +1677,26 @@ module KlaviyoAPI
|
|
1217
1677
|
|
1218
1678
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1219
1679
|
if @api_client.config.debugging
|
1220
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1680
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profile_ids_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1221
1681
|
end
|
1222
1682
|
return data, status_code, headers
|
1223
1683
|
end
|
1224
1684
|
|
1685
|
+
# alias of `get_profile_ids_for_bulk_import_profiles_job_with_http_info`
|
1686
|
+
alias get_bulk_profile_import_job_relationships_profiles_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
1687
|
+
|
1688
|
+
# alias of `get_profile_ids_for_bulk_import_profiles_job_with_http_info`
|
1689
|
+
alias get_profile_bulk_import_job_relationships_profiles_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
1690
|
+
|
1225
1691
|
# Get Profiles
|
1226
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-
|
1692
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1227
1693
|
# @param [Hash] opts the optional parameters
|
1228
1694
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1229
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-
|
1230
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-
|
1231
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
1695
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1696
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1697
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1232
1698
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1233
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-
|
1699
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1234
1700
|
# @return [Hash<String, Object>]
|
1235
1701
|
def get_profiles(opts = {})
|
1236
1702
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -1238,14 +1704,14 @@ module KlaviyoAPI
|
|
1238
1704
|
end
|
1239
1705
|
|
1240
1706
|
# Get Profiles
|
1241
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-
|
1707
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1242
1708
|
# @param [Hash] opts the optional parameters
|
1243
1709
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1244
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-
|
1245
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-
|
1246
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-
|
1710
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1711
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1712
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1247
1713
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1248
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-
|
1714
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1249
1715
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1250
1716
|
def get_profiles_with_http_info(opts = {})
|
1251
1717
|
if @api_client.config.debugging
|
@@ -1255,7 +1721,7 @@ module KlaviyoAPI
|
|
1255
1721
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
1256
1722
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
1257
1723
|
end
|
1258
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1724
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1259
1725
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1260
1726
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1261
1727
|
end
|
@@ -1272,7 +1738,7 @@ module KlaviyoAPI
|
|
1272
1738
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1273
1739
|
end
|
1274
1740
|
# resource path
|
1275
|
-
local_var_path = '/api/profiles
|
1741
|
+
local_var_path = '/api/profiles'
|
1276
1742
|
|
1277
1743
|
# query parameters
|
1278
1744
|
query_params = opts[:query_params] || {}
|
@@ -1286,9 +1752,9 @@ module KlaviyoAPI
|
|
1286
1752
|
# header parameters
|
1287
1753
|
header_params = opts[:header_params] || {}
|
1288
1754
|
# klaviyo api revision
|
1289
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1755
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1290
1756
|
# HTTP header 'Accept' (if needed)
|
1291
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1757
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1292
1758
|
|
1293
1759
|
# form parameters
|
1294
1760
|
form_params = opts[:form_params] || {}
|
@@ -1319,55 +1785,81 @@ module KlaviyoAPI
|
|
1319
1785
|
return data, status_code, headers
|
1320
1786
|
end
|
1321
1787
|
|
1322
|
-
#
|
1323
|
-
#
|
1324
|
-
# @param
|
1788
|
+
# Get Profiles for Bulk Import Profiles Job
|
1789
|
+
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1790
|
+
# @param id [String]
|
1325
1791
|
# @param [Hash] opts the optional parameters
|
1792
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1793
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1794
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1795
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1326
1796
|
# @return [Hash<String, Object>]
|
1327
|
-
def
|
1328
|
-
data, _status_code, _headers =
|
1797
|
+
def get_profiles_for_bulk_import_profiles_job(id, opts = {})
|
1798
|
+
data, _status_code, _headers = get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts)
|
1329
1799
|
data
|
1330
1800
|
end
|
1331
1801
|
|
1332
|
-
# alias of `
|
1333
|
-
alias
|
1802
|
+
# alias of `get_profiles_for_bulk_import_profiles_job`
|
1803
|
+
alias get_bulk_profile_import_job_profiles get_profiles_for_bulk_import_profiles_job
|
1334
1804
|
|
1335
|
-
#
|
1336
|
-
|
1337
|
-
|
1805
|
+
# alias of `get_profiles_for_bulk_import_profiles_job`
|
1806
|
+
alias get_profile_bulk_import_job_profiles get_profiles_for_bulk_import_profiles_job
|
1807
|
+
|
1808
|
+
# Get Profiles for Bulk Import Profiles Job
|
1809
|
+
# Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1810
|
+
# @param id [String]
|
1338
1811
|
# @param [Hash] opts the optional parameters
|
1812
|
+
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1813
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1814
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1815
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1339
1816
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1340
|
-
def
|
1817
|
+
def get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
1341
1818
|
if @api_client.config.debugging
|
1342
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1819
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_profiles_for_bulk_import_profiles_job ...'
|
1343
1820
|
end
|
1344
|
-
# verify the required parameter '
|
1345
|
-
if @api_client.config.client_side_validation &&
|
1346
|
-
fail ArgumentError, "Missing the required parameter '
|
1821
|
+
# verify the required parameter 'id' is set
|
1822
|
+
if @api_client.config.client_side_validation && id.nil?
|
1823
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profiles_for_bulk_import_profiles_job"
|
1824
|
+
end
|
1825
|
+
allowable_values = ["subscriptions", "predictive_analytics"]
|
1826
|
+
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
1827
|
+
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
1828
|
+
end
|
1829
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1830
|
+
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1831
|
+
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1347
1832
|
end
|
1833
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
1834
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles_for_bulk_import_profiles_job, must be smaller than or equal to 100.'
|
1835
|
+
end
|
1836
|
+
|
1837
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
1838
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles_for_bulk_import_profiles_job, must be greater than or equal to 1.'
|
1839
|
+
end
|
1840
|
+
|
1348
1841
|
# resource path
|
1349
|
-
local_var_path = '/api/profile-
|
1842
|
+
local_var_path = '/api/profile-bulk-import-jobs/{id}/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1350
1843
|
|
1351
1844
|
# query parameters
|
1352
1845
|
query_params = opts[:query_params] || {}
|
1846
|
+
query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
|
1847
|
+
query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
|
1848
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1849
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
1353
1850
|
|
1354
1851
|
# header parameters
|
1355
1852
|
header_params = opts[:header_params] || {}
|
1356
1853
|
# klaviyo api revision
|
1357
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1854
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1358
1855
|
# HTTP header 'Accept' (if needed)
|
1359
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1360
|
-
# HTTP header 'Content-Type'
|
1361
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1362
|
-
if !content_type.nil?
|
1363
|
-
header_params['Content-Type'] = content_type
|
1364
|
-
end
|
1856
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1365
1857
|
|
1366
1858
|
# form parameters
|
1367
1859
|
form_params = opts[:form_params] || {}
|
1368
1860
|
|
1369
1861
|
# http body (model)
|
1370
|
-
post_body = opts[:debug_body]
|
1862
|
+
post_body = opts[:debug_body]
|
1371
1863
|
|
1372
1864
|
# return_type
|
1373
1865
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -1376,7 +1868,7 @@ module KlaviyoAPI
|
|
1376
1868
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1377
1869
|
|
1378
1870
|
new_options = opts.merge(
|
1379
|
-
:operation => :"ProfilesApi.
|
1871
|
+
:operation => :"ProfilesApi.get_profiles_for_bulk_import_profiles_job",
|
1380
1872
|
:header_params => header_params,
|
1381
1873
|
:query_params => query_params,
|
1382
1874
|
:form_params => form_params,
|
@@ -1385,44 +1877,47 @@ module KlaviyoAPI
|
|
1385
1877
|
:return_type => return_type
|
1386
1878
|
)
|
1387
1879
|
|
1388
|
-
data, status_code, headers = @api_client.call_api(:
|
1880
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1389
1881
|
if @api_client.config.debugging
|
1390
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1882
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_profiles_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1391
1883
|
end
|
1392
1884
|
return data, status_code, headers
|
1393
1885
|
end
|
1394
1886
|
|
1395
|
-
# alias of `
|
1396
|
-
alias
|
1887
|
+
# alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
|
1888
|
+
alias get_bulk_profile_import_job_profiles_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
|
1397
1889
|
|
1398
|
-
#
|
1399
|
-
|
1400
|
-
|
1890
|
+
# alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
|
1891
|
+
alias get_profile_bulk_import_job_profiles_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
|
1892
|
+
|
1893
|
+
# Get Segment IDs for Profile
|
1894
|
+
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
1895
|
+
# @param id [String]
|
1401
1896
|
# @param [Hash] opts the optional parameters
|
1402
1897
|
# @return [Hash<String, Object>]
|
1403
|
-
def
|
1404
|
-
data, _status_code, _headers =
|
1898
|
+
def get_segment_ids_for_profile(id, opts = {})
|
1899
|
+
data, _status_code, _headers = get_segment_ids_for_profile_with_http_info(id, opts)
|
1405
1900
|
data
|
1406
1901
|
end
|
1407
1902
|
|
1408
|
-
# alias of `
|
1409
|
-
alias
|
1903
|
+
# alias of `get_segment_ids_for_profile`
|
1904
|
+
alias get_profile_relationships_segments get_segment_ids_for_profile
|
1410
1905
|
|
1411
|
-
#
|
1412
|
-
#
|
1413
|
-
# @param
|
1906
|
+
# Get Segment IDs for Profile
|
1907
|
+
# Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
1908
|
+
# @param id [String]
|
1414
1909
|
# @param [Hash] opts the optional parameters
|
1415
1910
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1416
|
-
def
|
1911
|
+
def get_segment_ids_for_profile_with_http_info(id, opts = {})
|
1417
1912
|
if @api_client.config.debugging
|
1418
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
1913
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_segment_ids_for_profile ...'
|
1419
1914
|
end
|
1420
|
-
# verify the required parameter '
|
1421
|
-
if @api_client.config.client_side_validation &&
|
1422
|
-
fail ArgumentError, "Missing the required parameter '
|
1915
|
+
# verify the required parameter 'id' is set
|
1916
|
+
if @api_client.config.client_side_validation && id.nil?
|
1917
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_segment_ids_for_profile"
|
1423
1918
|
end
|
1424
1919
|
# resource path
|
1425
|
-
local_var_path = '/api/
|
1920
|
+
local_var_path = '/api/profiles/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1426
1921
|
|
1427
1922
|
# query parameters
|
1428
1923
|
query_params = opts[:query_params] || {}
|
@@ -1430,20 +1925,15 @@ module KlaviyoAPI
|
|
1430
1925
|
# header parameters
|
1431
1926
|
header_params = opts[:header_params] || {}
|
1432
1927
|
# klaviyo api revision
|
1433
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1928
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1434
1929
|
# HTTP header 'Accept' (if needed)
|
1435
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1436
|
-
# HTTP header 'Content-Type'
|
1437
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1438
|
-
if !content_type.nil?
|
1439
|
-
header_params['Content-Type'] = content_type
|
1440
|
-
end
|
1930
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1441
1931
|
|
1442
1932
|
# form parameters
|
1443
1933
|
form_params = opts[:form_params] || {}
|
1444
1934
|
|
1445
1935
|
# http body (model)
|
1446
|
-
post_body = opts[:debug_body]
|
1936
|
+
post_body = opts[:debug_body]
|
1447
1937
|
|
1448
1938
|
# return_type
|
1449
1939
|
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
@@ -1452,7 +1942,7 @@ module KlaviyoAPI
|
|
1452
1942
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1453
1943
|
|
1454
1944
|
new_options = opts.merge(
|
1455
|
-
:operation => :"ProfilesApi.
|
1945
|
+
:operation => :"ProfilesApi.get_segment_ids_for_profile",
|
1456
1946
|
:header_params => header_params,
|
1457
1947
|
:query_params => query_params,
|
1458
1948
|
:form_params => form_params,
|
@@ -1461,150 +1951,76 @@ module KlaviyoAPI
|
|
1461
1951
|
:return_type => return_type
|
1462
1952
|
)
|
1463
1953
|
|
1464
|
-
data, status_code, headers = @api_client.call_api(:
|
1954
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1465
1955
|
if @api_client.config.debugging
|
1466
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
1956
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_segment_ids_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1467
1957
|
end
|
1468
1958
|
return data, status_code, headers
|
1469
1959
|
end
|
1470
1960
|
|
1471
|
-
# alias of `
|
1472
|
-
alias
|
1961
|
+
# alias of `get_segment_ids_for_profile_with_http_info`
|
1962
|
+
alias get_profile_relationships_segments_with_http_info get_segment_ids_for_profile_with_http_info
|
1473
1963
|
|
1474
|
-
#
|
1475
|
-
#
|
1476
|
-
# @param
|
1964
|
+
# Get Segments for Profile
|
1965
|
+
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
1966
|
+
# @param id [String]
|
1477
1967
|
# @param [Hash] opts the optional parameters
|
1478
|
-
# @
|
1479
|
-
|
1480
|
-
|
1481
|
-
|
1968
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1969
|
+
# @return [Hash<String, Object>]
|
1970
|
+
def get_segments_for_profile(id, opts = {})
|
1971
|
+
data, _status_code, _headers = get_segments_for_profile_with_http_info(id, opts)
|
1972
|
+
data
|
1482
1973
|
end
|
1483
1974
|
|
1484
|
-
# alias of `
|
1485
|
-
alias
|
1975
|
+
# alias of `get_segments_for_profile`
|
1976
|
+
alias get_profile_segments get_segments_for_profile
|
1486
1977
|
|
1487
|
-
#
|
1488
|
-
#
|
1489
|
-
# @param
|
1978
|
+
# Get Segments for Profile
|
1979
|
+
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
1980
|
+
# @param id [String]
|
1490
1981
|
# @param [Hash] opts the optional parameters
|
1491
|
-
# @
|
1492
|
-
|
1493
|
-
|
1494
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.subscribe_profiles ...'
|
1495
|
-
end
|
1496
|
-
# verify the required parameter 'subscription_create_job_create_query' is set
|
1497
|
-
if @api_client.config.client_side_validation && subscription_create_job_create_query.nil?
|
1498
|
-
fail ArgumentError, "Missing the required parameter 'subscription_create_job_create_query' when calling ProfilesApi.subscribe_profiles"
|
1499
|
-
end
|
1500
|
-
# resource path
|
1501
|
-
local_var_path = '/api/profile-subscription-bulk-create-jobs/'
|
1502
|
-
|
1503
|
-
# query parameters
|
1504
|
-
query_params = opts[:query_params] || {}
|
1505
|
-
|
1506
|
-
# header parameters
|
1507
|
-
header_params = opts[:header_params] || {}
|
1508
|
-
# klaviyo api revision
|
1509
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
|
1510
|
-
# HTTP header 'Accept' (if needed)
|
1511
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1512
|
-
# HTTP header 'Content-Type'
|
1513
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1514
|
-
if !content_type.nil?
|
1515
|
-
header_params['Content-Type'] = content_type
|
1516
|
-
end
|
1517
|
-
|
1518
|
-
# form parameters
|
1519
|
-
form_params = opts[:form_params] || {}
|
1520
|
-
|
1521
|
-
# http body (model)
|
1522
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_create_job_create_query)
|
1523
|
-
|
1524
|
-
# return_type
|
1525
|
-
return_type = opts[:debug_return_type]
|
1526
|
-
|
1527
|
-
# auth_names
|
1528
|
-
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1529
|
-
|
1530
|
-
new_options = opts.merge(
|
1531
|
-
:operation => :"ProfilesApi.subscribe_profiles",
|
1532
|
-
:header_params => header_params,
|
1533
|
-
:query_params => query_params,
|
1534
|
-
:form_params => form_params,
|
1535
|
-
:body => post_body,
|
1536
|
-
:auth_names => auth_names,
|
1537
|
-
:return_type => return_type
|
1538
|
-
)
|
1539
|
-
|
1540
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1982
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1983
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1984
|
+
def get_segments_for_profile_with_http_info(id, opts = {})
|
1541
1985
|
if @api_client.config.debugging
|
1542
|
-
@api_client.config.logger.debug
|
1986
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.get_segments_for_profile ...'
|
1543
1987
|
end
|
1544
|
-
|
1545
|
-
|
1546
|
-
|
1547
|
-
# alias of `subscribe_profiles_with_http_info`
|
1548
|
-
alias create_profile_subscription_bulk_create_job_with_http_info subscribe_profiles_with_http_info
|
1549
|
-
|
1550
|
-
# Suppress Profiles
|
1551
|
-
# Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
1552
|
-
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
1553
|
-
# @param [Hash] opts the optional parameters
|
1554
|
-
# @return [nil]
|
1555
|
-
def suppress_profiles(suppression_create_job_create_query, opts = {})
|
1556
|
-
suppress_profiles_with_http_info(suppression_create_job_create_query, opts)
|
1557
|
-
nil
|
1558
|
-
end
|
1559
|
-
|
1560
|
-
# alias of `suppress_profiles`
|
1561
|
-
alias create_profile_suppression_bulk_create_job suppress_profiles
|
1562
|
-
|
1563
|
-
# Suppress Profiles
|
1564
|
-
# Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
|
1565
|
-
# @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
|
1566
|
-
# @param [Hash] opts the optional parameters
|
1567
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1568
|
-
def suppress_profiles_with_http_info(suppression_create_job_create_query, opts = {})
|
1569
|
-
if @api_client.config.debugging
|
1570
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.suppress_profiles ...'
|
1988
|
+
# verify the required parameter 'id' is set
|
1989
|
+
if @api_client.config.client_side_validation && id.nil?
|
1990
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_segments_for_profile"
|
1571
1991
|
end
|
1572
|
-
|
1573
|
-
if @api_client.config.client_side_validation &&
|
1574
|
-
fail ArgumentError, "
|
1992
|
+
allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
|
1993
|
+
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
1994
|
+
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
1575
1995
|
end
|
1576
1996
|
# resource path
|
1577
|
-
local_var_path = '/api/
|
1997
|
+
local_var_path = '/api/profiles/{id}/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1578
1998
|
|
1579
1999
|
# query parameters
|
1580
2000
|
query_params = opts[:query_params] || {}
|
2001
|
+
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
|
1581
2002
|
|
1582
2003
|
# header parameters
|
1583
2004
|
header_params = opts[:header_params] || {}
|
1584
2005
|
# klaviyo api revision
|
1585
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
2006
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1586
2007
|
# HTTP header 'Accept' (if needed)
|
1587
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1588
|
-
# HTTP header 'Content-Type'
|
1589
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1590
|
-
if !content_type.nil?
|
1591
|
-
header_params['Content-Type'] = content_type
|
1592
|
-
end
|
2008
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1593
2009
|
|
1594
2010
|
# form parameters
|
1595
2011
|
form_params = opts[:form_params] || {}
|
1596
2012
|
|
1597
2013
|
# http body (model)
|
1598
|
-
post_body = opts[:debug_body]
|
2014
|
+
post_body = opts[:debug_body]
|
1599
2015
|
|
1600
2016
|
# return_type
|
1601
|
-
return_type = opts[:debug_return_type]
|
2017
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1602
2018
|
|
1603
2019
|
# auth_names
|
1604
2020
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1605
2021
|
|
1606
2022
|
new_options = opts.merge(
|
1607
|
-
:operation => :"ProfilesApi.
|
2023
|
+
:operation => :"ProfilesApi.get_segments_for_profile",
|
1608
2024
|
:header_params => header_params,
|
1609
2025
|
:query_params => query_params,
|
1610
2026
|
:form_params => form_params,
|
@@ -1613,44 +2029,44 @@ module KlaviyoAPI
|
|
1613
2029
|
:return_type => return_type
|
1614
2030
|
)
|
1615
2031
|
|
1616
|
-
data, status_code, headers = @api_client.call_api(:
|
2032
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1617
2033
|
if @api_client.config.debugging
|
1618
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
2034
|
+
@api_client.config.logger.debug "API called: ProfilesApi#get_segments_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1619
2035
|
end
|
1620
2036
|
return data, status_code, headers
|
1621
2037
|
end
|
1622
2038
|
|
1623
|
-
# alias of `
|
1624
|
-
alias
|
2039
|
+
# alias of `get_segments_for_profile_with_http_info`
|
2040
|
+
alias get_profile_segments_with_http_info get_segments_for_profile_with_http_info
|
1625
2041
|
|
1626
|
-
#
|
1627
|
-
#
|
1628
|
-
# @param
|
2042
|
+
# Merge Profiles
|
2043
|
+
# Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write`
|
2044
|
+
# @param profile_merge_query [ProfileMergeQuery]
|
1629
2045
|
# @param [Hash] opts the optional parameters
|
1630
|
-
# @return [
|
1631
|
-
def
|
1632
|
-
|
1633
|
-
|
2046
|
+
# @return [Hash<String, Object>]
|
2047
|
+
def merge_profiles(profile_merge_query, opts = {})
|
2048
|
+
data, _status_code, _headers = merge_profiles_with_http_info(profile_merge_query, opts)
|
2049
|
+
data
|
1634
2050
|
end
|
1635
2051
|
|
1636
|
-
# alias of `
|
1637
|
-
alias
|
2052
|
+
# alias of `merge_profiles`
|
2053
|
+
alias create_profile_merge merge_profiles
|
1638
2054
|
|
1639
|
-
#
|
1640
|
-
#
|
1641
|
-
# @param
|
2055
|
+
# Merge Profiles
|
2056
|
+
# Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write`
|
2057
|
+
# @param profile_merge_query [ProfileMergeQuery]
|
1642
2058
|
# @param [Hash] opts the optional parameters
|
1643
|
-
# @return [Array<(
|
1644
|
-
def
|
2059
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2060
|
+
def merge_profiles_with_http_info(profile_merge_query, opts = {})
|
1645
2061
|
if @api_client.config.debugging
|
1646
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
2062
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.merge_profiles ...'
|
1647
2063
|
end
|
1648
|
-
# verify the required parameter '
|
1649
|
-
if @api_client.config.client_side_validation &&
|
1650
|
-
fail ArgumentError, "Missing the required parameter '
|
2064
|
+
# verify the required parameter 'profile_merge_query' is set
|
2065
|
+
if @api_client.config.client_side_validation && profile_merge_query.nil?
|
2066
|
+
fail ArgumentError, "Missing the required parameter 'profile_merge_query' when calling ProfilesApi.merge_profiles"
|
1651
2067
|
end
|
1652
2068
|
# resource path
|
1653
|
-
local_var_path = '/api/profile-
|
2069
|
+
local_var_path = '/api/profile-merge'
|
1654
2070
|
|
1655
2071
|
# query parameters
|
1656
2072
|
query_params = opts[:query_params] || {}
|
@@ -1658,11 +2074,11 @@ module KlaviyoAPI
|
|
1658
2074
|
# header parameters
|
1659
2075
|
header_params = opts[:header_params] || {}
|
1660
2076
|
# klaviyo api revision
|
1661
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
2077
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1662
2078
|
# HTTP header 'Accept' (if needed)
|
1663
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2079
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1664
2080
|
# HTTP header 'Content-Type'
|
1665
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
2081
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1666
2082
|
if !content_type.nil?
|
1667
2083
|
header_params['Content-Type'] = content_type
|
1668
2084
|
end
|
@@ -1671,16 +2087,16 @@ module KlaviyoAPI
|
|
1671
2087
|
form_params = opts[:form_params] || {}
|
1672
2088
|
|
1673
2089
|
# http body (model)
|
1674
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2090
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_merge_query)
|
1675
2091
|
|
1676
2092
|
# return_type
|
1677
|
-
return_type = opts[:debug_return_type]
|
2093
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1678
2094
|
|
1679
2095
|
# auth_names
|
1680
2096
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1681
2097
|
|
1682
2098
|
new_options = opts.merge(
|
1683
|
-
:operation => :"ProfilesApi.
|
2099
|
+
:operation => :"ProfilesApi.merge_profiles",
|
1684
2100
|
:header_params => header_params,
|
1685
2101
|
:query_params => query_params,
|
1686
2102
|
:form_params => form_params,
|
@@ -1691,42 +2107,45 @@ module KlaviyoAPI
|
|
1691
2107
|
|
1692
2108
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1693
2109
|
if @api_client.config.debugging
|
1694
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
2110
|
+
@api_client.config.logger.debug "API called: ProfilesApi#merge_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1695
2111
|
end
|
1696
2112
|
return data, status_code, headers
|
1697
2113
|
end
|
1698
2114
|
|
1699
|
-
# alias of `
|
1700
|
-
alias
|
2115
|
+
# alias of `merge_profiles_with_http_info`
|
2116
|
+
alias create_profile_merge_with_http_info merge_profiles_with_http_info
|
1701
2117
|
|
1702
|
-
#
|
1703
|
-
#
|
1704
|
-
# @param
|
2118
|
+
# Spawn Bulk Profile Import Job
|
2119
|
+
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
2120
|
+
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
1705
2121
|
# @param [Hash] opts the optional parameters
|
1706
|
-
# @return [
|
1707
|
-
def
|
1708
|
-
|
1709
|
-
|
2122
|
+
# @return [Hash<String, Object>]
|
2123
|
+
def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {})
|
2124
|
+
data, _status_code, _headers = spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts)
|
2125
|
+
data
|
1710
2126
|
end
|
1711
2127
|
|
1712
|
-
# alias of `
|
1713
|
-
alias
|
2128
|
+
# alias of `spawn_bulk_profile_import_job`
|
2129
|
+
alias bulk_import_profiles spawn_bulk_profile_import_job
|
1714
2130
|
|
1715
|
-
#
|
1716
|
-
|
1717
|
-
|
2131
|
+
# alias of `spawn_bulk_profile_import_job`
|
2132
|
+
alias create_profile_bulk_import_job spawn_bulk_profile_import_job
|
2133
|
+
|
2134
|
+
# Spawn Bulk Profile Import Job
|
2135
|
+
# Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
|
2136
|
+
# @param profile_import_job_create_query [ProfileImportJobCreateQuery]
|
1718
2137
|
# @param [Hash] opts the optional parameters
|
1719
|
-
# @return [Array<(
|
1720
|
-
def
|
2138
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2139
|
+
def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts = {})
|
1721
2140
|
if @api_client.config.debugging
|
1722
|
-
@api_client.config.logger.debug 'Calling API: ProfilesApi.
|
2141
|
+
@api_client.config.logger.debug 'Calling API: ProfilesApi.spawn_bulk_profile_import_job ...'
|
1723
2142
|
end
|
1724
|
-
# verify the required parameter '
|
1725
|
-
if @api_client.config.client_side_validation &&
|
1726
|
-
fail ArgumentError, "Missing the required parameter '
|
2143
|
+
# verify the required parameter 'profile_import_job_create_query' is set
|
2144
|
+
if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
|
2145
|
+
fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.spawn_bulk_profile_import_job"
|
1727
2146
|
end
|
1728
2147
|
# resource path
|
1729
|
-
local_var_path = '/api/profile-
|
2148
|
+
local_var_path = '/api/profile-bulk-import-jobs'
|
1730
2149
|
|
1731
2150
|
# query parameters
|
1732
2151
|
query_params = opts[:query_params] || {}
|
@@ -1734,11 +2153,11 @@ module KlaviyoAPI
|
|
1734
2153
|
# header parameters
|
1735
2154
|
header_params = opts[:header_params] || {}
|
1736
2155
|
# klaviyo api revision
|
1737
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
2156
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1738
2157
|
# HTTP header 'Accept' (if needed)
|
1739
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2158
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1740
2159
|
# HTTP header 'Content-Type'
|
1741
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
2160
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1742
2161
|
if !content_type.nil?
|
1743
2162
|
header_params['Content-Type'] = content_type
|
1744
2163
|
end
|
@@ -1747,16 +2166,16 @@ module KlaviyoAPI
|
|
1747
2166
|
form_params = opts[:form_params] || {}
|
1748
2167
|
|
1749
2168
|
# http body (model)
|
1750
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2169
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_import_job_create_query)
|
1751
2170
|
|
1752
2171
|
# return_type
|
1753
|
-
return_type = opts[:debug_return_type]
|
2172
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
1754
2173
|
|
1755
2174
|
# auth_names
|
1756
2175
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1757
2176
|
|
1758
2177
|
new_options = opts.merge(
|
1759
|
-
:operation => :"ProfilesApi.
|
2178
|
+
:operation => :"ProfilesApi.spawn_bulk_profile_import_job",
|
1760
2179
|
:header_params => header_params,
|
1761
2180
|
:query_params => query_params,
|
1762
2181
|
:form_params => form_params,
|
@@ -1767,13 +2186,16 @@ module KlaviyoAPI
|
|
1767
2186
|
|
1768
2187
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1769
2188
|
if @api_client.config.debugging
|
1770
|
-
@api_client.config.logger.debug "API called: ProfilesApi#
|
2189
|
+
@api_client.config.logger.debug "API called: ProfilesApi#spawn_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1771
2190
|
end
|
1772
2191
|
return data, status_code, headers
|
1773
2192
|
end
|
1774
2193
|
|
1775
|
-
# alias of `
|
1776
|
-
alias
|
2194
|
+
# alias of `spawn_bulk_profile_import_job_with_http_info`
|
2195
|
+
alias bulk_import_profiles_with_http_info spawn_bulk_profile_import_job_with_http_info
|
2196
|
+
|
2197
|
+
# alias of `spawn_bulk_profile_import_job_with_http_info`
|
2198
|
+
alias create_profile_bulk_import_job_with_http_info spawn_bulk_profile_import_job_with_http_info
|
1777
2199
|
|
1778
2200
|
# Update Profile
|
1779
2201
|
# Update the profile with the given profile ID. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
|
@@ -1805,7 +2227,7 @@ module KlaviyoAPI
|
|
1805
2227
|
fail ArgumentError, "Missing the required parameter 'profile_partial_update_query' when calling ProfilesApi.update_profile"
|
1806
2228
|
end
|
1807
2229
|
# resource path
|
1808
|
-
local_var_path = '/api/profiles/{id}
|
2230
|
+
local_var_path = '/api/profiles/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1809
2231
|
|
1810
2232
|
# query parameters
|
1811
2233
|
query_params = opts[:query_params] || {}
|
@@ -1813,11 +2235,11 @@ module KlaviyoAPI
|
|
1813
2235
|
# header parameters
|
1814
2236
|
header_params = opts[:header_params] || {}
|
1815
2237
|
# klaviyo api revision
|
1816
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
2238
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1817
2239
|
# HTTP header 'Accept' (if needed)
|
1818
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2240
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1819
2241
|
# HTTP header 'Content-Type'
|
1820
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
2242
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1821
2243
|
if !content_type.nil?
|
1822
2244
|
header_params['Content-Type'] = content_type
|
1823
2245
|
end
|