klaviyo-api-sdk 12.0.0 → 13.0.1
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 +43 -0
- data/README.md +615 -335
- data/klaviyo-api-sdk.gemspec +1 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -7
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +94 -95
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +919 -848
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +71 -68
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -2
- data/lib/klaviyo-api-sdk/api/events_api.rb +38 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +101 -102
- data/lib/klaviyo-api-sdk/api/forms_api.rb +104 -40
- data/lib/klaviyo-api-sdk/api/images_api.rb +15 -16
- data/lib/klaviyo-api-sdk/api/lists_api.rb +59 -60
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +566 -41
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +675 -109
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -14
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -22
- data/lib/klaviyo-api-sdk/api/segments_api.rb +53 -54
- data/lib/klaviyo-api-sdk/api/tags_api.rb +60 -61
- data/lib/klaviyo-api-sdk/api/templates_api.rb +38 -39
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +9 -10
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +394 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -16
- data/lib/klaviyo-api-sdk/api_client.rb +1 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +0 -1
- data/lib/klaviyo-api-sdk/models/ab_test_action.rb +6 -3
- data/lib/klaviyo-api-sdk/models/ab_test_action_data.rb +303 -0
- data/lib/klaviyo-api-sdk/models/ab_test_action_data_current_experiment.rb +332 -0
- data/lib/klaviyo-api-sdk/models/{union_positive_numeric_filter_operator.rb → ab_test_action_data_main_action.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/audiences.rb +0 -1
- data/lib/klaviyo-api-sdk/models/audiences_update.rb +0 -1
- data/lib/klaviyo-api-sdk/models/automatic_winner_selection_settings.rb +247 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{base_event_create_query_resource_object.rb → base_event_create_query_bulk_entry_resource_object.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/{base_event_create_query_resource_object_attributes.rb → base_event_create_query_bulk_entry_resource_object_attributes.rb} +19 -20
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/block_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +0 -1
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/branch_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/branch_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +2 -3
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{send_whats_app_action_data.rb → campaign_message_increment.rb} +21 -35
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_property.rb +271 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_static_count.rb +271 -0
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{email_tracking_options.rb → campaigns_email_tracking_options.rb} +37 -50
- data/lib/klaviyo-api-sdk/models/campaigns_email_tracking_options_custom_tracking_params_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/campaigns_sms_tracking_options.rb +233 -0
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/code_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/code_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +2 -3
- data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +2 -7
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +112 -0
- data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +0 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +2 -3
- data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_metric_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_condition_filter.rb +110 -0
- data/lib/klaviyo-api-sdk/models/{scheduled_trigger.rb → custom_metric_create_query.rb} +13 -14
- data/lib/klaviyo-api-sdk/models/custom_metric_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_create_query_resource_object_attributes.rb +238 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_definition.rb +274 -0
- data/lib/klaviyo-api-sdk/models/{send_whatsapp_enum.rb → custom_metric_enum.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/custom_metric_group.rb +248 -0
- data/lib/klaviyo-api-sdk/models/custom_metric_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{send_whats_app_action.rb → custom_metric_partial_update_query_resource_object.rb} +27 -39
- data/lib/klaviyo-api-sdk/models/custom_metric_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +265 -0
- data/lib/klaviyo-api-sdk/models/{custom_object_enum.rb → custom_object_property_enum.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +0 -1
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +287 -0
- data/lib/klaviyo-api-sdk/models/email_content.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_message_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/fake_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/featured_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_definition.rb +2 -7
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +0 -2
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter.rb +226 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{union_condition_group_conditions_inner.rb → flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb} +2 -3
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +0 -3
- data/lib/klaviyo-api-sdk/models/flow_email.rb +2 -2
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +113 -0
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +12 -3
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +113 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_badge_options.rb +105 -0
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{union_filter.rb → flow_sms_additional_filters.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/{union_condition_group.rb → flow_sms_additional_filters_condition_groups_inner.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +113 -0
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -2
- data/lib/klaviyo-api-sdk/models/flow_webhook.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{profile_metric_condition.rb → flows_profile_metric_condition.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/{profile_metric_condition_timeframe_filter.rb → flows_profile_metric_condition_timeframe_filter.rb} +2 -2
- data/lib/klaviyo-api-sdk/models/form_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +0 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +0 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{union_positive_numeric_filter.rb → greater_than_positive_numeric_filter.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +14 -5
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +14 -5
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +0 -1
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/html_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/immediate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/increment.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{scheduled_enum.rb → increment_one_enum.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/internal_service_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/less_than_positive_numeric_filter.rb +251 -0
- data/lib/klaviyo-api-sdk/models/link.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_regex_operator_contains_filter.rb +282 -0
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/list_update_action_data.rb +29 -6
- data/lib/klaviyo-api-sdk/models/list_update_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/local_static_send.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -3
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +14 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_badge_badge_options.rb +106 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_message_silent_definition_create.rb +243 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_silent_definition_update.rb +242 -0
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +24 -19
- data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_update.rb +21 -11
- data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_options_badge.rb +0 -1
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +0 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +0 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +0 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +0 -1
- data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -1
- data/lib/klaviyo-api-sdk/models/open_app_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/other_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/pending_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/private_information_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +237 -0
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_not_sent_email_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_not_sent_push_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_not_sent_sms_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +1 -6
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition_filter.rb +104 -0
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +7 -18
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{sms_tracking_options.rb → property.rb} +22 -25
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/published_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +0 -1
- data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +0 -1
- data/lib/klaviyo-api-sdk/models/rejected_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/render_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_featured.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_pending.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_published.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +0 -1
- data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_trigger.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_condition.rb +326 -0
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_condition_timeframe_filter.rb +108 -0
- data/lib/klaviyo-api-sdk/models/send_email_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_email_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_sms_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +0 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/set_count_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/set_property_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/silent_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/since_flow_start_date_filter.rb +272 -0
- data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_content_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/split_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/split_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/split_links.rb +0 -1
- data/lib/klaviyo-api-sdk/models/standard_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/{utm_param_info.rb → static_count.rb} +13 -14
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +253 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_in_array_filter.rb +253 -0
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +0 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/target_date_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +2 -3
- data/lib/klaviyo-api-sdk/models/target_date_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +16 -6
- data/lib/klaviyo-api-sdk/models/template_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -6
- data/lib/klaviyo-api-sdk/models/text_block.rb +0 -1
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +0 -1
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +21 -22
- data/lib/klaviyo-api-sdk/models/text_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/throttled_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +0 -1
- data/lib/klaviyo-api-sdk/models/time_delay_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +2 -3
- data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +4 -9
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner_conditions_inner.rb +106 -0
- data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +0 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +0 -1
- data/lib/klaviyo-api-sdk/models/update_profile_action.rb +0 -1
- data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +2 -4
- data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/utm_param.rb +0 -1
- data/lib/klaviyo-api-sdk/models/web_feed_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/web_feed_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/web_feed_create_query_resource_object_attributes.rb +315 -0
- data/lib/klaviyo-api-sdk/models/web_feed_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/web_feed_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/web_feed_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{flow_whats_app.rb → web_feed_partial_update_query_resource_object_attributes.rb} +72 -67
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +0 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +0 -1
- data/lib/klaviyo-api-sdk/version.rb +0 -1
- data/lib/klaviyo-api-sdk.rb +80 -21
- metadata +82 -22
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +0 -395
@@ -3,7 +3,6 @@
|
|
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: 2025-01-15
|
7
6
|
Contact: developers@klaviyo.com
|
8
7
|
Generated by: https://openapi-generator.tech
|
9
8
|
OpenAPI Generator version: 6.2.1
|
@@ -66,7 +65,7 @@ module KlaviyoAPI
|
|
66
65
|
# header parameters
|
67
66
|
header_params = opts[:header_params] || {}
|
68
67
|
# klaviyo api revision
|
69
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
68
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
70
69
|
# HTTP header 'Accept' (if needed)
|
71
70
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
72
71
|
# HTTP header 'Content-Type'
|
@@ -157,7 +156,7 @@ module KlaviyoAPI
|
|
157
156
|
# header parameters
|
158
157
|
header_params = opts[:header_params] || {}
|
159
158
|
# klaviyo api revision
|
160
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
159
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
161
160
|
# HTTP header 'Accept' (if needed)
|
162
161
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
163
162
|
# HTTP header 'Content-Type'
|
@@ -239,7 +238,7 @@ module KlaviyoAPI
|
|
239
238
|
# header parameters
|
240
239
|
header_params = opts[:header_params] || {}
|
241
240
|
# klaviyo api revision
|
242
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
241
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
243
242
|
# HTTP header 'Accept' (if needed)
|
244
243
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
245
244
|
# HTTP header 'Content-Type'
|
@@ -321,7 +320,7 @@ module KlaviyoAPI
|
|
321
320
|
# header parameters
|
322
321
|
header_params = opts[:header_params] || {}
|
323
322
|
# klaviyo api revision
|
324
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
323
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
325
324
|
# HTTP header 'Accept' (if needed)
|
326
325
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
327
326
|
# HTTP header 'Content-Type'
|
@@ -403,7 +402,7 @@ module KlaviyoAPI
|
|
403
402
|
# header parameters
|
404
403
|
header_params = opts[:header_params] || {}
|
405
404
|
# klaviyo api revision
|
406
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
405
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
407
406
|
# HTTP header 'Accept' (if needed)
|
408
407
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
409
408
|
# HTTP header 'Content-Type'
|
@@ -485,7 +484,7 @@ module KlaviyoAPI
|
|
485
484
|
# header parameters
|
486
485
|
header_params = opts[:header_params] || {}
|
487
486
|
# klaviyo api revision
|
488
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
487
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
489
488
|
# HTTP header 'Accept' (if needed)
|
490
489
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
491
490
|
# HTTP header 'Content-Type'
|
@@ -567,7 +566,7 @@ module KlaviyoAPI
|
|
567
566
|
# header parameters
|
568
567
|
header_params = opts[:header_params] || {}
|
569
568
|
# klaviyo api revision
|
570
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
569
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
571
570
|
# HTTP header 'Accept' (if needed)
|
572
571
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
573
572
|
# HTTP header 'Content-Type'
|
@@ -649,7 +648,7 @@ module KlaviyoAPI
|
|
649
648
|
# header parameters
|
650
649
|
header_params = opts[:header_params] || {}
|
651
650
|
# klaviyo api revision
|
652
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
651
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
653
652
|
# HTTP header 'Accept' (if needed)
|
654
653
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
655
654
|
# HTTP header 'Content-Type'
|
@@ -731,7 +730,7 @@ module KlaviyoAPI
|
|
731
730
|
# header parameters
|
732
731
|
header_params = opts[:header_params] || {}
|
733
732
|
# klaviyo api revision
|
734
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
733
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
735
734
|
# HTTP header 'Accept' (if needed)
|
736
735
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
737
736
|
# HTTP header 'Content-Type'
|
@@ -813,7 +812,7 @@ module KlaviyoAPI
|
|
813
812
|
# header parameters
|
814
813
|
header_params = opts[:header_params] || {}
|
815
814
|
# klaviyo api revision
|
816
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
815
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
817
816
|
# HTTP header 'Accept' (if needed)
|
818
817
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
819
818
|
# HTTP header 'Content-Type'
|
@@ -895,7 +894,7 @@ module KlaviyoAPI
|
|
895
894
|
# header parameters
|
896
895
|
header_params = opts[:header_params] || {}
|
897
896
|
# klaviyo api revision
|
898
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
897
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
899
898
|
# HTTP header 'Accept' (if needed)
|
900
899
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
901
900
|
# HTTP header 'Content-Type'
|
@@ -971,7 +970,7 @@ module KlaviyoAPI
|
|
971
970
|
# header parameters
|
972
971
|
header_params = opts[:header_params] || {}
|
973
972
|
# klaviyo api revision
|
974
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
973
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
975
974
|
# HTTP header 'Accept' (if needed)
|
976
975
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
977
976
|
# HTTP header 'Content-Type'
|
@@ -1041,7 +1040,7 @@ module KlaviyoAPI
|
|
1041
1040
|
# header parameters
|
1042
1041
|
header_params = opts[:header_params] || {}
|
1043
1042
|
# klaviyo api revision
|
1044
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1043
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1045
1044
|
# HTTP header 'Accept' (if needed)
|
1046
1045
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1047
1046
|
# HTTP header 'Content-Type'
|
@@ -1111,7 +1110,7 @@ module KlaviyoAPI
|
|
1111
1110
|
# header parameters
|
1112
1111
|
header_params = opts[:header_params] || {}
|
1113
1112
|
# klaviyo api revision
|
1114
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1113
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1115
1114
|
# HTTP header 'Accept' (if needed)
|
1116
1115
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1117
1116
|
# HTTP header 'Content-Type'
|
@@ -1181,7 +1180,7 @@ module KlaviyoAPI
|
|
1181
1180
|
# header parameters
|
1182
1181
|
header_params = opts[:header_params] || {}
|
1183
1182
|
# klaviyo api revision
|
1184
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1183
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1185
1184
|
# HTTP header 'Accept' (if needed)
|
1186
1185
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1187
1186
|
# HTTP header 'Content-Type'
|
@@ -1251,7 +1250,7 @@ module KlaviyoAPI
|
|
1251
1250
|
# header parameters
|
1252
1251
|
header_params = opts[:header_params] || {}
|
1253
1252
|
# klaviyo api revision
|
1254
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1253
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1255
1254
|
# HTTP header 'Accept' (if needed)
|
1256
1255
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1257
1256
|
|
@@ -1316,7 +1315,7 @@ module KlaviyoAPI
|
|
1316
1315
|
# header parameters
|
1317
1316
|
header_params = opts[:header_params] || {}
|
1318
1317
|
# klaviyo api revision
|
1319
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1318
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1320
1319
|
# HTTP header 'Accept' (if needed)
|
1321
1320
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1322
1321
|
|
@@ -1381,7 +1380,7 @@ module KlaviyoAPI
|
|
1381
1380
|
# header parameters
|
1382
1381
|
header_params = opts[:header_params] || {}
|
1383
1382
|
# klaviyo api revision
|
1384
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1383
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1385
1384
|
# HTTP header 'Accept' (if needed)
|
1386
1385
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1387
1386
|
|
@@ -1418,9 +1417,9 @@ module KlaviyoAPI
|
|
1418
1417
|
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1419
1418
|
# @param job_id [String] ID of the job to retrieve.
|
1420
1419
|
# @param [Hash] opts the optional parameters
|
1421
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1422
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-
|
1423
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1420
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1421
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1422
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1424
1423
|
# @return [Hash<String, Object>]
|
1425
1424
|
def get_bulk_create_catalog_items_job(job_id, opts = {})
|
1426
1425
|
data, _status_code, _headers = get_bulk_create_catalog_items_job_with_http_info(job_id, opts)
|
@@ -1437,9 +1436,9 @@ module KlaviyoAPI
|
|
1437
1436
|
# Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1438
1437
|
# @param job_id [String] ID of the job to retrieve.
|
1439
1438
|
# @param [Hash] opts the optional parameters
|
1440
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1441
|
-
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-
|
1442
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1439
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1440
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1441
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1443
1442
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1444
1443
|
def get_bulk_create_catalog_items_job_with_http_info(job_id, opts = {})
|
1445
1444
|
if @api_client.config.debugging
|
@@ -1473,7 +1472,7 @@ module KlaviyoAPI
|
|
1473
1472
|
# header parameters
|
1474
1473
|
header_params = opts[:header_params] || {}
|
1475
1474
|
# klaviyo api revision
|
1476
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1475
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1477
1476
|
# HTTP header 'Accept' (if needed)
|
1478
1477
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1479
1478
|
|
@@ -1515,9 +1514,9 @@ module KlaviyoAPI
|
|
1515
1514
|
# Get Bulk Create Catalog Items Jobs
|
1516
1515
|
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1517
1516
|
# @param [Hash] opts the optional parameters
|
1518
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1519
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1520
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1517
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1518
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1519
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1521
1520
|
# @return [Hash<String, Object>]
|
1522
1521
|
def get_bulk_create_catalog_items_jobs(opts = {})
|
1523
1522
|
data, _status_code, _headers = get_bulk_create_catalog_items_jobs_with_http_info(opts)
|
@@ -1533,9 +1532,9 @@ module KlaviyoAPI
|
|
1533
1532
|
# Get Bulk Create Catalog Items Jobs
|
1534
1533
|
# Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1535
1534
|
# @param [Hash] opts the optional parameters
|
1536
|
-
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1537
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1538
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1535
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1536
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1537
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1539
1538
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1540
1539
|
def get_bulk_create_catalog_items_jobs_with_http_info(opts = {})
|
1541
1540
|
if @api_client.config.debugging
|
@@ -1557,7 +1556,7 @@ module KlaviyoAPI
|
|
1557
1556
|
# header parameters
|
1558
1557
|
header_params = opts[:header_params] || {}
|
1559
1558
|
# klaviyo api revision
|
1560
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1559
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1561
1560
|
# HTTP header 'Accept' (if needed)
|
1562
1561
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1563
1562
|
|
@@ -1596,52 +1595,66 @@ module KlaviyoAPI
|
|
1596
1595
|
# alias of `get_bulk_create_catalog_items_jobs_with_http_info`
|
1597
1596
|
alias get_catalog_item_bulk_create_jobs_with_http_info get_bulk_create_catalog_items_jobs_with_http_info
|
1598
1597
|
|
1599
|
-
# Get Bulk
|
1600
|
-
# Get a catalog
|
1598
|
+
# Get Bulk Create Categories Job
|
1599
|
+
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1601
1600
|
# @param job_id [String] ID of the job to retrieve.
|
1602
1601
|
# @param [Hash] opts the optional parameters
|
1603
|
-
# @option opts [Array<String>] :
|
1602
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1603
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1604
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1604
1605
|
# @return [Hash<String, Object>]
|
1605
|
-
def
|
1606
|
-
data, _status_code, _headers =
|
1606
|
+
def get_bulk_create_categories_job(job_id, opts = {})
|
1607
|
+
data, _status_code, _headers = get_bulk_create_categories_job_with_http_info(job_id, opts)
|
1607
1608
|
data
|
1608
1609
|
end
|
1609
1610
|
|
1610
|
-
# alias of `
|
1611
|
-
alias
|
1611
|
+
# alias of `get_bulk_create_categories_job`
|
1612
|
+
alias get_create_categories_job get_bulk_create_categories_job
|
1612
1613
|
|
1613
|
-
# alias of `
|
1614
|
-
alias
|
1614
|
+
# alias of `get_bulk_create_categories_job`
|
1615
|
+
alias get_catalog_category_bulk_create_job get_bulk_create_categories_job
|
1615
1616
|
|
1616
|
-
# Get Bulk
|
1617
|
-
# Get a catalog
|
1617
|
+
# Get Bulk Create Categories Job
|
1618
|
+
# Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1618
1619
|
# @param job_id [String] ID of the job to retrieve.
|
1619
1620
|
# @param [Hash] opts the optional parameters
|
1620
|
-
# @option opts [Array<String>] :
|
1621
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1622
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1623
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1621
1624
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1622
|
-
def
|
1625
|
+
def get_bulk_create_categories_job_with_http_info(job_id, opts = {})
|
1623
1626
|
if @api_client.config.debugging
|
1624
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
1627
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_categories_job ...'
|
1625
1628
|
end
|
1626
1629
|
# verify the required parameter 'job_id' is set
|
1627
1630
|
if @api_client.config.client_side_validation && job_id.nil?
|
1628
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.
|
1631
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_create_categories_job"
|
1629
1632
|
end
|
1630
1633
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
1631
|
-
if @api_client.config.client_side_validation && opts[:'
|
1632
|
-
fail ArgumentError, "invalid value for \"
|
1634
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
1635
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}"
|
1636
|
+
end
|
1637
|
+
allowable_values = ["external_id", "name", "updated"]
|
1638
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
1639
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
1640
|
+
end
|
1641
|
+
allowable_values = ["categories"]
|
1642
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1643
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1633
1644
|
end
|
1634
1645
|
# resource path
|
1635
|
-
local_var_path = '/api/catalog-
|
1646
|
+
local_var_path = '/api/catalog-category-bulk-create-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
1636
1647
|
|
1637
1648
|
# query parameters
|
1638
1649
|
query_params = opts[:query_params] || {}
|
1639
|
-
query_params[:'fields[catalog-
|
1650
|
+
query_params[:'fields[catalog-category-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_create_job'], :csv) if !opts[:'fields_catalog_category_bulk_create_job'].nil?
|
1651
|
+
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
1652
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1640
1653
|
|
1641
1654
|
# header parameters
|
1642
1655
|
header_params = opts[:header_params] || {}
|
1643
1656
|
# klaviyo api revision
|
1644
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1657
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1645
1658
|
# HTTP header 'Accept' (if needed)
|
1646
1659
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1647
1660
|
|
@@ -1658,7 +1671,7 @@ module KlaviyoAPI
|
|
1658
1671
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1659
1672
|
|
1660
1673
|
new_options = opts.merge(
|
1661
|
-
:operation => :"CatalogsApi.
|
1674
|
+
:operation => :"CatalogsApi.get_bulk_create_categories_job",
|
1662
1675
|
:header_params => header_params,
|
1663
1676
|
:query_params => query_params,
|
1664
1677
|
:form_params => form_params,
|
@@ -1669,63 +1682,63 @@ module KlaviyoAPI
|
|
1669
1682
|
|
1670
1683
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1671
1684
|
if @api_client.config.debugging
|
1672
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
1685
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_create_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1673
1686
|
end
|
1674
1687
|
return data, status_code, headers
|
1675
1688
|
end
|
1676
1689
|
|
1677
|
-
# alias of `
|
1678
|
-
alias
|
1690
|
+
# alias of `get_bulk_create_categories_job_with_http_info`
|
1691
|
+
alias get_create_categories_job_with_http_info get_bulk_create_categories_job_with_http_info
|
1679
1692
|
|
1680
|
-
# alias of `
|
1681
|
-
alias
|
1693
|
+
# alias of `get_bulk_create_categories_job_with_http_info`
|
1694
|
+
alias get_catalog_category_bulk_create_job_with_http_info get_bulk_create_categories_job_with_http_info
|
1682
1695
|
|
1683
|
-
# Get Bulk
|
1684
|
-
# Get all catalog
|
1696
|
+
# Get Bulk Create Categories Jobs
|
1697
|
+
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1685
1698
|
# @param [Hash] opts the optional parameters
|
1686
|
-
# @option opts [Array<String>] :
|
1687
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1688
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1699
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1700
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1701
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1689
1702
|
# @return [Hash<String, Object>]
|
1690
|
-
def
|
1691
|
-
data, _status_code, _headers =
|
1703
|
+
def get_bulk_create_categories_jobs(opts = {})
|
1704
|
+
data, _status_code, _headers = get_bulk_create_categories_jobs_with_http_info(opts)
|
1692
1705
|
data
|
1693
1706
|
end
|
1694
1707
|
|
1695
|
-
# alias of `
|
1696
|
-
alias
|
1708
|
+
# alias of `get_bulk_create_categories_jobs`
|
1709
|
+
alias get_create_categories_jobs get_bulk_create_categories_jobs
|
1697
1710
|
|
1698
|
-
# alias of `
|
1699
|
-
alias
|
1711
|
+
# alias of `get_bulk_create_categories_jobs`
|
1712
|
+
alias get_catalog_category_bulk_create_jobs get_bulk_create_categories_jobs
|
1700
1713
|
|
1701
|
-
# Get Bulk
|
1702
|
-
# Get all catalog
|
1714
|
+
# Get Bulk Create Categories Jobs
|
1715
|
+
# Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1703
1716
|
# @param [Hash] opts the optional parameters
|
1704
|
-
# @option opts [Array<String>] :
|
1705
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1706
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1717
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1718
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1719
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1707
1720
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1708
|
-
def
|
1721
|
+
def get_bulk_create_categories_jobs_with_http_info(opts = {})
|
1709
1722
|
if @api_client.config.debugging
|
1710
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
1723
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_categories_jobs ...'
|
1711
1724
|
end
|
1712
1725
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
1713
|
-
if @api_client.config.client_side_validation && opts[:'
|
1714
|
-
fail ArgumentError, "invalid value for \"
|
1726
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
1727
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}"
|
1715
1728
|
end
|
1716
1729
|
# resource path
|
1717
|
-
local_var_path = '/api/catalog-
|
1730
|
+
local_var_path = '/api/catalog-category-bulk-create-jobs'
|
1718
1731
|
|
1719
1732
|
# query parameters
|
1720
1733
|
query_params = opts[:query_params] || {}
|
1721
|
-
query_params[:'fields[catalog-
|
1734
|
+
query_params[:'fields[catalog-category-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_create_job'], :csv) if !opts[:'fields_catalog_category_bulk_create_job'].nil?
|
1722
1735
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1723
1736
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1724
1737
|
|
1725
1738
|
# header parameters
|
1726
1739
|
header_params = opts[:header_params] || {}
|
1727
1740
|
# klaviyo api revision
|
1728
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1741
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1729
1742
|
# HTTP header 'Accept' (if needed)
|
1730
1743
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1731
1744
|
|
@@ -1742,7 +1755,7 @@ module KlaviyoAPI
|
|
1742
1755
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1743
1756
|
|
1744
1757
|
new_options = opts.merge(
|
1745
|
-
:operation => :"CatalogsApi.
|
1758
|
+
:operation => :"CatalogsApi.get_bulk_create_categories_jobs",
|
1746
1759
|
:header_params => header_params,
|
1747
1760
|
:query_params => query_params,
|
1748
1761
|
:form_params => form_params,
|
@@ -1753,77 +1766,77 @@ module KlaviyoAPI
|
|
1753
1766
|
|
1754
1767
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1755
1768
|
if @api_client.config.debugging
|
1756
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
1769
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_create_categories_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1757
1770
|
end
|
1758
1771
|
return data, status_code, headers
|
1759
1772
|
end
|
1760
1773
|
|
1761
|
-
# alias of `
|
1762
|
-
alias
|
1774
|
+
# alias of `get_bulk_create_categories_jobs_with_http_info`
|
1775
|
+
alias get_create_categories_jobs_with_http_info get_bulk_create_categories_jobs_with_http_info
|
1763
1776
|
|
1764
|
-
# alias of `
|
1765
|
-
alias
|
1777
|
+
# alias of `get_bulk_create_categories_jobs_with_http_info`
|
1778
|
+
alias get_catalog_category_bulk_create_jobs_with_http_info get_bulk_create_categories_jobs_with_http_info
|
1766
1779
|
|
1767
|
-
# Get Bulk
|
1768
|
-
# Get a catalog
|
1780
|
+
# Get Bulk Create Variants Job
|
1781
|
+
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1769
1782
|
# @param job_id [String] ID of the job to retrieve.
|
1770
1783
|
# @param [Hash] opts the optional parameters
|
1771
|
-
# @option opts [Array<String>] :
|
1772
|
-
# @option opts [Array<String>] :
|
1773
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1784
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1785
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1786
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1774
1787
|
# @return [Hash<String, Object>]
|
1775
|
-
def
|
1776
|
-
data, _status_code, _headers =
|
1788
|
+
def get_bulk_create_variants_job(job_id, opts = {})
|
1789
|
+
data, _status_code, _headers = get_bulk_create_variants_job_with_http_info(job_id, opts)
|
1777
1790
|
data
|
1778
1791
|
end
|
1779
1792
|
|
1780
|
-
# alias of `
|
1781
|
-
alias
|
1793
|
+
# alias of `get_bulk_create_variants_job`
|
1794
|
+
alias get_create_variants_job get_bulk_create_variants_job
|
1782
1795
|
|
1783
|
-
# alias of `
|
1784
|
-
alias
|
1796
|
+
# alias of `get_bulk_create_variants_job`
|
1797
|
+
alias get_catalog_variant_bulk_create_job get_bulk_create_variants_job
|
1785
1798
|
|
1786
|
-
# Get Bulk
|
1787
|
-
# Get a catalog
|
1799
|
+
# Get Bulk Create Variants Job
|
1800
|
+
# Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1788
1801
|
# @param job_id [String] ID of the job to retrieve.
|
1789
1802
|
# @param [Hash] opts the optional parameters
|
1790
|
-
# @option opts [Array<String>] :
|
1791
|
-
# @option opts [Array<String>] :
|
1792
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1803
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1804
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1805
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
1793
1806
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1794
|
-
def
|
1807
|
+
def get_bulk_create_variants_job_with_http_info(job_id, opts = {})
|
1795
1808
|
if @api_client.config.debugging
|
1796
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
1809
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_variants_job ...'
|
1797
1810
|
end
|
1798
1811
|
# verify the required parameter 'job_id' is set
|
1799
1812
|
if @api_client.config.client_side_validation && job_id.nil?
|
1800
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.
|
1813
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_create_variants_job"
|
1801
1814
|
end
|
1802
1815
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
1803
|
-
if @api_client.config.client_side_validation && opts[:'
|
1804
|
-
fail ArgumentError, "invalid value for \"
|
1816
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
1817
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}"
|
1805
1818
|
end
|
1806
|
-
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
1807
|
-
if @api_client.config.client_side_validation && opts[:'
|
1808
|
-
fail ArgumentError, "invalid value for \"
|
1819
|
+
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
1820
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
1821
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
1809
1822
|
end
|
1810
|
-
allowable_values = ["
|
1823
|
+
allowable_values = ["variants"]
|
1811
1824
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1812
1825
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1813
1826
|
end
|
1814
1827
|
# resource path
|
1815
|
-
local_var_path = '/api/catalog-
|
1828
|
+
local_var_path = '/api/catalog-variant-bulk-create-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
1816
1829
|
|
1817
1830
|
# query parameters
|
1818
1831
|
query_params = opts[:query_params] || {}
|
1819
|
-
query_params[:'fields[catalog-
|
1820
|
-
query_params[:'fields[catalog-
|
1832
|
+
query_params[:'fields[catalog-variant-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_create_job'], :csv) if !opts[:'fields_catalog_variant_bulk_create_job'].nil?
|
1833
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
1821
1834
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1822
1835
|
|
1823
1836
|
# header parameters
|
1824
1837
|
header_params = opts[:header_params] || {}
|
1825
1838
|
# klaviyo api revision
|
1826
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1839
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1827
1840
|
# HTTP header 'Accept' (if needed)
|
1828
1841
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1829
1842
|
|
@@ -1840,7 +1853,7 @@ module KlaviyoAPI
|
|
1840
1853
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1841
1854
|
|
1842
1855
|
new_options = opts.merge(
|
1843
|
-
:operation => :"CatalogsApi.
|
1856
|
+
:operation => :"CatalogsApi.get_bulk_create_variants_job",
|
1844
1857
|
:header_params => header_params,
|
1845
1858
|
:query_params => query_params,
|
1846
1859
|
:form_params => form_params,
|
@@ -1851,63 +1864,63 @@ module KlaviyoAPI
|
|
1851
1864
|
|
1852
1865
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1853
1866
|
if @api_client.config.debugging
|
1854
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
1867
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_create_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1855
1868
|
end
|
1856
1869
|
return data, status_code, headers
|
1857
1870
|
end
|
1858
1871
|
|
1859
|
-
# alias of `
|
1860
|
-
alias
|
1872
|
+
# alias of `get_bulk_create_variants_job_with_http_info`
|
1873
|
+
alias get_create_variants_job_with_http_info get_bulk_create_variants_job_with_http_info
|
1861
1874
|
|
1862
|
-
# alias of `
|
1863
|
-
alias
|
1875
|
+
# alias of `get_bulk_create_variants_job_with_http_info`
|
1876
|
+
alias get_catalog_variant_bulk_create_job_with_http_info get_bulk_create_variants_job_with_http_info
|
1864
1877
|
|
1865
|
-
# Get Bulk
|
1866
|
-
# Get all catalog
|
1878
|
+
# Get Bulk Create Variants Jobs
|
1879
|
+
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1867
1880
|
# @param [Hash] opts the optional parameters
|
1868
|
-
# @option opts [Array<String>] :
|
1869
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1870
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1881
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1882
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1883
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1871
1884
|
# @return [Hash<String, Object>]
|
1872
|
-
def
|
1873
|
-
data, _status_code, _headers =
|
1885
|
+
def get_bulk_create_variants_jobs(opts = {})
|
1886
|
+
data, _status_code, _headers = get_bulk_create_variants_jobs_with_http_info(opts)
|
1874
1887
|
data
|
1875
1888
|
end
|
1876
1889
|
|
1877
|
-
# alias of `
|
1878
|
-
alias
|
1890
|
+
# alias of `get_bulk_create_variants_jobs`
|
1891
|
+
alias get_create_variants_jobs get_bulk_create_variants_jobs
|
1879
1892
|
|
1880
|
-
# alias of `
|
1881
|
-
alias
|
1893
|
+
# alias of `get_bulk_create_variants_jobs`
|
1894
|
+
alias get_catalog_variant_bulk_create_jobs get_bulk_create_variants_jobs
|
1882
1895
|
|
1883
|
-
# Get Bulk
|
1884
|
-
# Get all catalog
|
1896
|
+
# Get Bulk Create Variants Jobs
|
1897
|
+
# Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1885
1898
|
# @param [Hash] opts the optional parameters
|
1886
|
-
# @option opts [Array<String>] :
|
1887
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1888
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1899
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1900
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
1901
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
1889
1902
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1890
|
-
def
|
1903
|
+
def get_bulk_create_variants_jobs_with_http_info(opts = {})
|
1891
1904
|
if @api_client.config.debugging
|
1892
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
1905
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_create_variants_jobs ...'
|
1893
1906
|
end
|
1894
1907
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
1895
|
-
if @api_client.config.client_side_validation && opts[:'
|
1896
|
-
fail ArgumentError, "invalid value for \"
|
1908
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) }
|
1909
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}"
|
1897
1910
|
end
|
1898
1911
|
# resource path
|
1899
|
-
local_var_path = '/api/catalog-
|
1912
|
+
local_var_path = '/api/catalog-variant-bulk-create-jobs'
|
1900
1913
|
|
1901
1914
|
# query parameters
|
1902
1915
|
query_params = opts[:query_params] || {}
|
1903
|
-
query_params[:'fields[catalog-
|
1916
|
+
query_params[:'fields[catalog-variant-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_create_job'], :csv) if !opts[:'fields_catalog_variant_bulk_create_job'].nil?
|
1904
1917
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1905
1918
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1906
1919
|
|
1907
1920
|
# header parameters
|
1908
1921
|
header_params = opts[:header_params] || {}
|
1909
1922
|
# klaviyo api revision
|
1910
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1923
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1911
1924
|
# HTTP header 'Accept' (if needed)
|
1912
1925
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1913
1926
|
|
@@ -1924,7 +1937,7 @@ module KlaviyoAPI
|
|
1924
1937
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
1925
1938
|
|
1926
1939
|
new_options = opts.merge(
|
1927
|
-
:operation => :"CatalogsApi.
|
1940
|
+
:operation => :"CatalogsApi.get_bulk_create_variants_jobs",
|
1928
1941
|
:header_params => header_params,
|
1929
1942
|
:query_params => query_params,
|
1930
1943
|
:form_params => form_params,
|
@@ -1935,64 +1948,63 @@ module KlaviyoAPI
|
|
1935
1948
|
|
1936
1949
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1937
1950
|
if @api_client.config.debugging
|
1938
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
1951
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_create_variants_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1939
1952
|
end
|
1940
1953
|
return data, status_code, headers
|
1941
1954
|
end
|
1942
1955
|
|
1943
|
-
# alias of `
|
1944
|
-
alias
|
1956
|
+
# alias of `get_bulk_create_variants_jobs_with_http_info`
|
1957
|
+
alias get_create_variants_jobs_with_http_info get_bulk_create_variants_jobs_with_http_info
|
1945
1958
|
|
1946
|
-
# alias of `
|
1947
|
-
alias
|
1959
|
+
# alias of `get_bulk_create_variants_jobs_with_http_info`
|
1960
|
+
alias get_catalog_variant_bulk_create_jobs_with_http_info get_bulk_create_variants_jobs_with_http_info
|
1948
1961
|
|
1949
|
-
# Get Catalog
|
1950
|
-
# Get
|
1962
|
+
# Get Bulk Delete Catalog Items Job
|
1963
|
+
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1964
|
+
# @param job_id [String] ID of the job to retrieve.
|
1951
1965
|
# @param [Hash] opts the optional parameters
|
1952
|
-
# @option opts [Array<String>] :
|
1953
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
1954
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1955
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1966
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1956
1967
|
# @return [Hash<String, Object>]
|
1957
|
-
def
|
1958
|
-
data, _status_code, _headers =
|
1968
|
+
def get_bulk_delete_catalog_items_job(job_id, opts = {})
|
1969
|
+
data, _status_code, _headers = get_bulk_delete_catalog_items_job_with_http_info(job_id, opts)
|
1959
1970
|
data
|
1960
1971
|
end
|
1961
1972
|
|
1962
|
-
#
|
1963
|
-
|
1973
|
+
# alias of `get_bulk_delete_catalog_items_job`
|
1974
|
+
alias get_delete_items_job get_bulk_delete_catalog_items_job
|
1975
|
+
|
1976
|
+
# alias of `get_bulk_delete_catalog_items_job`
|
1977
|
+
alias get_catalog_item_bulk_delete_job get_bulk_delete_catalog_items_job
|
1978
|
+
|
1979
|
+
# Get Bulk Delete Catalog Items Job
|
1980
|
+
# Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
1981
|
+
# @param job_id [String] ID of the job to retrieve.
|
1964
1982
|
# @param [Hash] opts the optional parameters
|
1965
|
-
# @option opts [Array<String>] :
|
1966
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
1967
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
1968
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
1983
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
1969
1984
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1970
|
-
def
|
1985
|
+
def get_bulk_delete_catalog_items_job_with_http_info(job_id, opts = {})
|
1971
1986
|
if @api_client.config.debugging
|
1972
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
1987
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_catalog_items_job ...'
|
1973
1988
|
end
|
1974
|
-
|
1975
|
-
if @api_client.config.client_side_validation &&
|
1976
|
-
fail ArgumentError, "
|
1989
|
+
# verify the required parameter 'job_id' is set
|
1990
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
1991
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_delete_catalog_items_job"
|
1977
1992
|
end
|
1978
|
-
allowable_values = ["
|
1979
|
-
if @api_client.config.client_side_validation && opts[:'
|
1980
|
-
fail ArgumentError, "invalid value for \"
|
1993
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
1994
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
1995
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}"
|
1981
1996
|
end
|
1982
1997
|
# resource path
|
1983
|
-
local_var_path = '/api/catalog-
|
1998
|
+
local_var_path = '/api/catalog-item-bulk-delete-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
1984
1999
|
|
1985
2000
|
# query parameters
|
1986
2001
|
query_params = opts[:query_params] || {}
|
1987
|
-
query_params[:'fields[catalog-
|
1988
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1989
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1990
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2002
|
+
query_params[:'fields[catalog-item-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_delete_job'], :csv) if !opts[:'fields_catalog_item_bulk_delete_job'].nil?
|
1991
2003
|
|
1992
2004
|
# header parameters
|
1993
2005
|
header_params = opts[:header_params] || {}
|
1994
2006
|
# klaviyo api revision
|
1995
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2007
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
1996
2008
|
# HTTP header 'Accept' (if needed)
|
1997
2009
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1998
2010
|
|
@@ -2009,7 +2021,7 @@ module KlaviyoAPI
|
|
2009
2021
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2010
2022
|
|
2011
2023
|
new_options = opts.merge(
|
2012
|
-
:operation => :"CatalogsApi.
|
2024
|
+
:operation => :"CatalogsApi.get_bulk_delete_catalog_items_job",
|
2013
2025
|
:header_params => header_params,
|
2014
2026
|
:query_params => query_params,
|
2015
2027
|
:form_params => form_params,
|
@@ -2020,51 +2032,63 @@ module KlaviyoAPI
|
|
2020
2032
|
|
2021
2033
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2022
2034
|
if @api_client.config.debugging
|
2023
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2035
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_delete_catalog_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2024
2036
|
end
|
2025
2037
|
return data, status_code, headers
|
2026
2038
|
end
|
2027
2039
|
|
2028
|
-
#
|
2029
|
-
|
2030
|
-
|
2040
|
+
# alias of `get_bulk_delete_catalog_items_job_with_http_info`
|
2041
|
+
alias get_delete_items_job_with_http_info get_bulk_delete_catalog_items_job_with_http_info
|
2042
|
+
|
2043
|
+
# alias of `get_bulk_delete_catalog_items_job_with_http_info`
|
2044
|
+
alias get_catalog_item_bulk_delete_job_with_http_info get_bulk_delete_catalog_items_job_with_http_info
|
2045
|
+
|
2046
|
+
# Get Bulk Delete Catalog Items Jobs
|
2047
|
+
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2031
2048
|
# @param [Hash] opts the optional parameters
|
2032
|
-
# @option opts [Array<String>] :
|
2049
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2050
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2051
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2033
2052
|
# @return [Hash<String, Object>]
|
2034
|
-
def
|
2035
|
-
data, _status_code, _headers =
|
2053
|
+
def get_bulk_delete_catalog_items_jobs(opts = {})
|
2054
|
+
data, _status_code, _headers = get_bulk_delete_catalog_items_jobs_with_http_info(opts)
|
2036
2055
|
data
|
2037
2056
|
end
|
2038
2057
|
|
2039
|
-
#
|
2040
|
-
|
2041
|
-
|
2058
|
+
# alias of `get_bulk_delete_catalog_items_jobs`
|
2059
|
+
alias get_delete_items_jobs get_bulk_delete_catalog_items_jobs
|
2060
|
+
|
2061
|
+
# alias of `get_bulk_delete_catalog_items_jobs`
|
2062
|
+
alias get_catalog_item_bulk_delete_jobs get_bulk_delete_catalog_items_jobs
|
2063
|
+
|
2064
|
+
# Get Bulk Delete Catalog Items Jobs
|
2065
|
+
# Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2042
2066
|
# @param [Hash] opts the optional parameters
|
2043
|
-
# @option opts [Array<String>] :
|
2067
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2068
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2069
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2044
2070
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2045
|
-
def
|
2071
|
+
def get_bulk_delete_catalog_items_jobs_with_http_info(opts = {})
|
2046
2072
|
if @api_client.config.debugging
|
2047
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2048
|
-
end
|
2049
|
-
# verify the required parameter 'id' is set
|
2050
|
-
if @api_client.config.client_side_validation && id.nil?
|
2051
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_category"
|
2073
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_catalog_items_jobs ...'
|
2052
2074
|
end
|
2053
|
-
allowable_values = ["
|
2054
|
-
if @api_client.config.client_side_validation && opts[:'
|
2055
|
-
fail ArgumentError, "invalid value for \"
|
2075
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2076
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
2077
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}"
|
2056
2078
|
end
|
2057
2079
|
# resource path
|
2058
|
-
local_var_path = '/api/catalog-
|
2080
|
+
local_var_path = '/api/catalog-item-bulk-delete-jobs'
|
2059
2081
|
|
2060
2082
|
# query parameters
|
2061
2083
|
query_params = opts[:query_params] || {}
|
2062
|
-
query_params[:'fields[catalog-
|
2084
|
+
query_params[:'fields[catalog-item-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_delete_job'], :csv) if !opts[:'fields_catalog_item_bulk_delete_job'].nil?
|
2085
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2086
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2063
2087
|
|
2064
2088
|
# header parameters
|
2065
2089
|
header_params = opts[:header_params] || {}
|
2066
2090
|
# klaviyo api revision
|
2067
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2091
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2068
2092
|
# HTTP header 'Accept' (if needed)
|
2069
2093
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2070
2094
|
|
@@ -2081,7 +2105,7 @@ module KlaviyoAPI
|
|
2081
2105
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2082
2106
|
|
2083
2107
|
new_options = opts.merge(
|
2084
|
-
:operation => :"CatalogsApi.
|
2108
|
+
:operation => :"CatalogsApi.get_bulk_delete_catalog_items_jobs",
|
2085
2109
|
:header_params => header_params,
|
2086
2110
|
:query_params => query_params,
|
2087
2111
|
:form_params => form_params,
|
@@ -2092,65 +2116,63 @@ module KlaviyoAPI
|
|
2092
2116
|
|
2093
2117
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2094
2118
|
if @api_client.config.debugging
|
2095
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2119
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_delete_catalog_items_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2096
2120
|
end
|
2097
2121
|
return data, status_code, headers
|
2098
2122
|
end
|
2099
2123
|
|
2100
|
-
#
|
2101
|
-
|
2102
|
-
|
2124
|
+
# alias of `get_bulk_delete_catalog_items_jobs_with_http_info`
|
2125
|
+
alias get_delete_items_jobs_with_http_info get_bulk_delete_catalog_items_jobs_with_http_info
|
2126
|
+
|
2127
|
+
# alias of `get_bulk_delete_catalog_items_jobs_with_http_info`
|
2128
|
+
alias get_catalog_item_bulk_delete_jobs_with_http_info get_bulk_delete_catalog_items_jobs_with_http_info
|
2129
|
+
|
2130
|
+
# Get Bulk Delete Categories Job
|
2131
|
+
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2132
|
+
# @param job_id [String] ID of the job to retrieve.
|
2103
2133
|
# @param [Hash] opts the optional parameters
|
2104
|
-
# @option opts [Array<String>] :
|
2105
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2106
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2134
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2107
2135
|
# @return [Hash<String, Object>]
|
2108
|
-
def
|
2109
|
-
data, _status_code, _headers =
|
2136
|
+
def get_bulk_delete_categories_job(job_id, opts = {})
|
2137
|
+
data, _status_code, _headers = get_bulk_delete_categories_job_with_http_info(job_id, opts)
|
2110
2138
|
data
|
2111
2139
|
end
|
2112
2140
|
|
2113
|
-
#
|
2114
|
-
|
2115
|
-
|
2141
|
+
# alias of `get_bulk_delete_categories_job`
|
2142
|
+
alias get_delete_categories_job get_bulk_delete_categories_job
|
2143
|
+
|
2144
|
+
# alias of `get_bulk_delete_categories_job`
|
2145
|
+
alias get_catalog_category_bulk_delete_job get_bulk_delete_categories_job
|
2146
|
+
|
2147
|
+
# Get Bulk Delete Categories Job
|
2148
|
+
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2149
|
+
# @param job_id [String] ID of the job to retrieve.
|
2116
2150
|
# @param [Hash] opts the optional parameters
|
2117
|
-
# @option opts [Array<String>] :
|
2118
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
|
2119
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2151
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2120
2152
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2121
|
-
def
|
2153
|
+
def get_bulk_delete_categories_job_with_http_info(job_id, opts = {})
|
2122
2154
|
if @api_client.config.debugging
|
2123
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2155
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_categories_job ...'
|
2124
2156
|
end
|
2125
|
-
# verify the required parameter '
|
2126
|
-
if @api_client.config.client_side_validation &&
|
2127
|
-
fail ArgumentError, "Missing the required parameter '
|
2128
|
-
end
|
2129
|
-
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
2130
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
2131
|
-
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
2132
|
-
end
|
2133
|
-
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
2134
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
2135
|
-
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
2157
|
+
# verify the required parameter 'job_id' is set
|
2158
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
2159
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_delete_categories_job"
|
2136
2160
|
end
|
2137
|
-
allowable_values = ["
|
2138
|
-
if @api_client.config.client_side_validation && opts[:'
|
2139
|
-
fail ArgumentError, "invalid value for \"
|
2161
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2162
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
2163
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}"
|
2140
2164
|
end
|
2141
2165
|
# resource path
|
2142
|
-
local_var_path = '/api/catalog-
|
2166
|
+
local_var_path = '/api/catalog-category-bulk-delete-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
2143
2167
|
|
2144
2168
|
# query parameters
|
2145
2169
|
query_params = opts[:query_params] || {}
|
2146
|
-
query_params[:'fields[catalog-
|
2147
|
-
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
2148
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2170
|
+
query_params[:'fields[catalog-category-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_delete_job'], :csv) if !opts[:'fields_catalog_category_bulk_delete_job'].nil?
|
2149
2171
|
|
2150
2172
|
# header parameters
|
2151
2173
|
header_params = opts[:header_params] || {}
|
2152
2174
|
# klaviyo api revision
|
2153
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2175
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2154
2176
|
# HTTP header 'Accept' (if needed)
|
2155
2177
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2156
2178
|
|
@@ -2167,7 +2189,7 @@ module KlaviyoAPI
|
|
2167
2189
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2168
2190
|
|
2169
2191
|
new_options = opts.merge(
|
2170
|
-
:operation => :"CatalogsApi.
|
2192
|
+
:operation => :"CatalogsApi.get_bulk_delete_categories_job",
|
2171
2193
|
:header_params => header_params,
|
2172
2194
|
:query_params => query_params,
|
2173
2195
|
:form_params => form_params,
|
@@ -2178,72 +2200,63 @@ module KlaviyoAPI
|
|
2178
2200
|
|
2179
2201
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2180
2202
|
if @api_client.config.debugging
|
2181
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2203
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_delete_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2182
2204
|
end
|
2183
2205
|
return data, status_code, headers
|
2184
2206
|
end
|
2185
2207
|
|
2186
|
-
#
|
2187
|
-
|
2208
|
+
# alias of `get_bulk_delete_categories_job_with_http_info`
|
2209
|
+
alias get_delete_categories_job_with_http_info get_bulk_delete_categories_job_with_http_info
|
2210
|
+
|
2211
|
+
# alias of `get_bulk_delete_categories_job_with_http_info`
|
2212
|
+
alias get_catalog_category_bulk_delete_job_with_http_info get_bulk_delete_categories_job_with_http_info
|
2213
|
+
|
2214
|
+
# Get Bulk Delete Categories Jobs
|
2215
|
+
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2188
2216
|
# @param [Hash] opts the optional parameters
|
2189
|
-
# @option opts [Array<String>] :
|
2190
|
-
# @option opts [
|
2191
|
-
# @option opts [String] :
|
2192
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2193
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2194
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2217
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2218
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2219
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2195
2220
|
# @return [Hash<String, Object>]
|
2196
|
-
def
|
2197
|
-
data, _status_code, _headers =
|
2221
|
+
def get_bulk_delete_categories_jobs(opts = {})
|
2222
|
+
data, _status_code, _headers = get_bulk_delete_categories_jobs_with_http_info(opts)
|
2198
2223
|
data
|
2199
2224
|
end
|
2200
2225
|
|
2201
|
-
#
|
2202
|
-
|
2226
|
+
# alias of `get_bulk_delete_categories_jobs`
|
2227
|
+
alias get_delete_categories_jobs get_bulk_delete_categories_jobs
|
2228
|
+
|
2229
|
+
# alias of `get_bulk_delete_categories_jobs`
|
2230
|
+
alias get_catalog_category_bulk_delete_jobs get_bulk_delete_categories_jobs
|
2231
|
+
|
2232
|
+
# Get Bulk Delete Categories Jobs
|
2233
|
+
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2203
2234
|
# @param [Hash] opts the optional parameters
|
2204
|
-
# @option opts [Array<String>] :
|
2205
|
-
# @option opts [
|
2206
|
-
# @option opts [String] :
|
2207
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
|
2208
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
2209
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2235
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2236
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2237
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2210
2238
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2211
|
-
def
|
2239
|
+
def get_bulk_delete_categories_jobs_with_http_info(opts = {})
|
2212
2240
|
if @api_client.config.debugging
|
2213
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2214
|
-
end
|
2215
|
-
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
2216
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
2217
|
-
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
2218
|
-
end
|
2219
|
-
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
2220
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
2221
|
-
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
2241
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_categories_jobs ...'
|
2222
2242
|
end
|
2223
|
-
allowable_values = ["
|
2224
|
-
if @api_client.config.client_side_validation && opts[:'
|
2225
|
-
fail ArgumentError, "invalid value for \"
|
2226
|
-
end
|
2227
|
-
allowable_values = ["created", "-created"]
|
2228
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2229
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2243
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2244
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
2245
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}"
|
2230
2246
|
end
|
2231
2247
|
# resource path
|
2232
|
-
local_var_path = '/api/catalog-
|
2248
|
+
local_var_path = '/api/catalog-category-bulk-delete-jobs'
|
2233
2249
|
|
2234
2250
|
# query parameters
|
2235
2251
|
query_params = opts[:query_params] || {}
|
2236
|
-
query_params[:'fields[catalog-
|
2237
|
-
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
2252
|
+
query_params[:'fields[catalog-category-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_delete_job'], :csv) if !opts[:'fields_catalog_category_bulk_delete_job'].nil?
|
2238
2253
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2239
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2240
2254
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2241
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2242
2255
|
|
2243
2256
|
# header parameters
|
2244
2257
|
header_params = opts[:header_params] || {}
|
2245
2258
|
# klaviyo api revision
|
2246
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2259
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2247
2260
|
# HTTP header 'Accept' (if needed)
|
2248
2261
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2249
2262
|
|
@@ -2260,7 +2273,7 @@ module KlaviyoAPI
|
|
2260
2273
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2261
2274
|
|
2262
2275
|
new_options = opts.merge(
|
2263
|
-
:operation => :"CatalogsApi.
|
2276
|
+
:operation => :"CatalogsApi.get_bulk_delete_categories_jobs",
|
2264
2277
|
:header_params => header_params,
|
2265
2278
|
:query_params => query_params,
|
2266
2279
|
:form_params => form_params,
|
@@ -2271,51 +2284,63 @@ module KlaviyoAPI
|
|
2271
2284
|
|
2272
2285
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2273
2286
|
if @api_client.config.debugging
|
2274
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2287
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_delete_categories_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2275
2288
|
end
|
2276
2289
|
return data, status_code, headers
|
2277
2290
|
end
|
2278
2291
|
|
2279
|
-
#
|
2280
|
-
|
2281
|
-
|
2292
|
+
# alias of `get_bulk_delete_categories_jobs_with_http_info`
|
2293
|
+
alias get_delete_categories_jobs_with_http_info get_bulk_delete_categories_jobs_with_http_info
|
2294
|
+
|
2295
|
+
# alias of `get_bulk_delete_categories_jobs_with_http_info`
|
2296
|
+
alias get_catalog_category_bulk_delete_jobs_with_http_info get_bulk_delete_categories_jobs_with_http_info
|
2297
|
+
|
2298
|
+
# Get Bulk Delete Variants Job
|
2299
|
+
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2300
|
+
# @param job_id [String] ID of the job to retrieve.
|
2282
2301
|
# @param [Hash] opts the optional parameters
|
2283
|
-
# @option opts [Array<String>] :
|
2302
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2284
2303
|
# @return [Hash<String, Object>]
|
2285
|
-
def
|
2286
|
-
data, _status_code, _headers =
|
2304
|
+
def get_bulk_delete_variants_job(job_id, opts = {})
|
2305
|
+
data, _status_code, _headers = get_bulk_delete_variants_job_with_http_info(job_id, opts)
|
2287
2306
|
data
|
2288
2307
|
end
|
2289
2308
|
|
2290
|
-
#
|
2291
|
-
|
2292
|
-
|
2309
|
+
# alias of `get_bulk_delete_variants_job`
|
2310
|
+
alias get_delete_variants_job get_bulk_delete_variants_job
|
2311
|
+
|
2312
|
+
# alias of `get_bulk_delete_variants_job`
|
2313
|
+
alias get_catalog_variant_bulk_delete_job get_bulk_delete_variants_job
|
2314
|
+
|
2315
|
+
# Get Bulk Delete Variants Job
|
2316
|
+
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2317
|
+
# @param job_id [String] ID of the job to retrieve.
|
2293
2318
|
# @param [Hash] opts the optional parameters
|
2294
|
-
# @option opts [Array<String>] :
|
2319
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2295
2320
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2296
|
-
def
|
2321
|
+
def get_bulk_delete_variants_job_with_http_info(job_id, opts = {})
|
2297
2322
|
if @api_client.config.debugging
|
2298
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2323
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_variants_job ...'
|
2299
2324
|
end
|
2300
|
-
# verify the required parameter '
|
2301
|
-
if @api_client.config.client_side_validation &&
|
2302
|
-
fail ArgumentError, "Missing the required parameter '
|
2325
|
+
# verify the required parameter 'job_id' is set
|
2326
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
2327
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_delete_variants_job"
|
2303
2328
|
end
|
2304
|
-
allowable_values = ["
|
2305
|
-
if @api_client.config.client_side_validation && opts[:'
|
2306
|
-
fail ArgumentError, "invalid value for \"
|
2329
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2330
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
2331
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}"
|
2307
2332
|
end
|
2308
2333
|
# resource path
|
2309
|
-
local_var_path = '/api/catalog-
|
2334
|
+
local_var_path = '/api/catalog-variant-bulk-delete-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
2310
2335
|
|
2311
2336
|
# query parameters
|
2312
2337
|
query_params = opts[:query_params] || {}
|
2313
|
-
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'
|
2338
|
+
query_params[:'fields[catalog-variant-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_delete_job'], :csv) if !opts[:'fields_catalog_variant_bulk_delete_job'].nil?
|
2314
2339
|
|
2315
2340
|
# header parameters
|
2316
2341
|
header_params = opts[:header_params] || {}
|
2317
2342
|
# klaviyo api revision
|
2318
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2343
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2319
2344
|
# HTTP header 'Accept' (if needed)
|
2320
2345
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2321
2346
|
|
@@ -2332,7 +2357,7 @@ module KlaviyoAPI
|
|
2332
2357
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2333
2358
|
|
2334
2359
|
new_options = opts.merge(
|
2335
|
-
:operation => :"CatalogsApi.
|
2360
|
+
:operation => :"CatalogsApi.get_bulk_delete_variants_job",
|
2336
2361
|
:header_params => header_params,
|
2337
2362
|
:query_params => query_params,
|
2338
2363
|
:form_params => form_params,
|
@@ -2343,58 +2368,63 @@ module KlaviyoAPI
|
|
2343
2368
|
|
2344
2369
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2345
2370
|
if @api_client.config.debugging
|
2346
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2371
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_delete_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2347
2372
|
end
|
2348
2373
|
return data, status_code, headers
|
2349
2374
|
end
|
2350
2375
|
|
2351
|
-
#
|
2352
|
-
|
2376
|
+
# alias of `get_bulk_delete_variants_job_with_http_info`
|
2377
|
+
alias get_delete_variants_job_with_http_info get_bulk_delete_variants_job_with_http_info
|
2378
|
+
|
2379
|
+
# alias of `get_bulk_delete_variants_job_with_http_info`
|
2380
|
+
alias get_catalog_variant_bulk_delete_job_with_http_info get_bulk_delete_variants_job_with_http_info
|
2381
|
+
|
2382
|
+
# Get Bulk Delete Variants Jobs
|
2383
|
+
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2353
2384
|
# @param [Hash] opts the optional parameters
|
2354
|
-
# @option opts [Array<String>] :
|
2355
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2356
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2357
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2385
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2386
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2387
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2358
2388
|
# @return [Hash<String, Object>]
|
2359
|
-
def
|
2360
|
-
data, _status_code, _headers =
|
2389
|
+
def get_bulk_delete_variants_jobs(opts = {})
|
2390
|
+
data, _status_code, _headers = get_bulk_delete_variants_jobs_with_http_info(opts)
|
2361
2391
|
data
|
2362
2392
|
end
|
2363
2393
|
|
2364
|
-
#
|
2365
|
-
|
2394
|
+
# alias of `get_bulk_delete_variants_jobs`
|
2395
|
+
alias get_delete_variants_jobs get_bulk_delete_variants_jobs
|
2396
|
+
|
2397
|
+
# alias of `get_bulk_delete_variants_jobs`
|
2398
|
+
alias get_catalog_variant_bulk_delete_jobs get_bulk_delete_variants_jobs
|
2399
|
+
|
2400
|
+
# Get Bulk Delete Variants Jobs
|
2401
|
+
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2366
2402
|
# @param [Hash] opts the optional parameters
|
2367
|
-
# @option opts [Array<String>] :
|
2368
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2369
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2370
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2403
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2404
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2405
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2371
2406
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2372
|
-
def
|
2407
|
+
def get_bulk_delete_variants_jobs_with_http_info(opts = {})
|
2373
2408
|
if @api_client.config.debugging
|
2374
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2409
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_delete_variants_jobs ...'
|
2375
2410
|
end
|
2376
|
-
allowable_values = ["
|
2377
|
-
if @api_client.config.client_side_validation && opts[:'
|
2378
|
-
fail ArgumentError, "invalid value for \"
|
2379
|
-
end
|
2380
|
-
allowable_values = ["created", "-created"]
|
2381
|
-
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
2382
|
-
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2411
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2412
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
|
2413
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}"
|
2383
2414
|
end
|
2384
2415
|
# resource path
|
2385
|
-
local_var_path = '/api/catalog-
|
2416
|
+
local_var_path = '/api/catalog-variant-bulk-delete-jobs'
|
2386
2417
|
|
2387
2418
|
# query parameters
|
2388
2419
|
query_params = opts[:query_params] || {}
|
2389
|
-
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'
|
2420
|
+
query_params[:'fields[catalog-variant-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_delete_job'], :csv) if !opts[:'fields_catalog_variant_bulk_delete_job'].nil?
|
2390
2421
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2391
2422
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2392
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2393
2423
|
|
2394
2424
|
# header parameters
|
2395
2425
|
header_params = opts[:header_params] || {}
|
2396
2426
|
# klaviyo api revision
|
2397
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2427
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2398
2428
|
# HTTP header 'Accept' (if needed)
|
2399
2429
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2400
2430
|
|
@@ -2411,7 +2441,7 @@ module KlaviyoAPI
|
|
2411
2441
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2412
2442
|
|
2413
2443
|
new_options = opts.merge(
|
2414
|
-
:operation => :"CatalogsApi.
|
2444
|
+
:operation => :"CatalogsApi.get_bulk_delete_variants_jobs",
|
2415
2445
|
:header_params => header_params,
|
2416
2446
|
:query_params => query_params,
|
2417
2447
|
:form_params => form_params,
|
@@ -2422,63 +2452,77 @@ module KlaviyoAPI
|
|
2422
2452
|
|
2423
2453
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2424
2454
|
if @api_client.config.debugging
|
2425
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2455
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_delete_variants_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2426
2456
|
end
|
2427
2457
|
return data, status_code, headers
|
2428
2458
|
end
|
2429
2459
|
|
2430
|
-
#
|
2431
|
-
|
2432
|
-
|
2460
|
+
# alias of `get_bulk_delete_variants_jobs_with_http_info`
|
2461
|
+
alias get_delete_variants_jobs_with_http_info get_bulk_delete_variants_jobs_with_http_info
|
2462
|
+
|
2463
|
+
# alias of `get_bulk_delete_variants_jobs_with_http_info`
|
2464
|
+
alias get_catalog_variant_bulk_delete_jobs_with_http_info get_bulk_delete_variants_jobs_with_http_info
|
2465
|
+
|
2466
|
+
# Get Bulk Update Catalog Items Job
|
2467
|
+
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2468
|
+
# @param job_id [String] ID of the job to retrieve.
|
2433
2469
|
# @param [Hash] opts the optional parameters
|
2434
|
-
# @option opts [Array<String>] :
|
2435
|
-
# @option opts [String] :
|
2436
|
-
# @option opts [String] :
|
2437
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2470
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2471
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2472
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2438
2473
|
# @return [Hash<String, Object>]
|
2439
|
-
def
|
2440
|
-
data, _status_code, _headers =
|
2474
|
+
def get_bulk_update_catalog_items_job(job_id, opts = {})
|
2475
|
+
data, _status_code, _headers = get_bulk_update_catalog_items_job_with_http_info(job_id, opts)
|
2441
2476
|
data
|
2442
2477
|
end
|
2443
2478
|
|
2444
|
-
# alias of `
|
2445
|
-
alias
|
2479
|
+
# alias of `get_bulk_update_catalog_items_job`
|
2480
|
+
alias get_update_items_job get_bulk_update_catalog_items_job
|
2446
2481
|
|
2447
|
-
#
|
2448
|
-
|
2449
|
-
|
2482
|
+
# alias of `get_bulk_update_catalog_items_job`
|
2483
|
+
alias get_catalog_item_bulk_update_job get_bulk_update_catalog_items_job
|
2484
|
+
|
2485
|
+
# Get Bulk Update Catalog Items Job
|
2486
|
+
# Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2487
|
+
# @param job_id [String] ID of the job to retrieve.
|
2450
2488
|
# @param [Hash] opts the optional parameters
|
2451
|
-
# @option opts [Array<String>] :
|
2452
|
-
# @option opts [String] :
|
2453
|
-
# @option opts [String] :
|
2454
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
2489
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2490
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2491
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2455
2492
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2456
|
-
def
|
2493
|
+
def get_bulk_update_catalog_items_job_with_http_info(job_id, opts = {})
|
2457
2494
|
if @api_client.config.debugging
|
2458
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2495
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_catalog_items_job ...'
|
2459
2496
|
end
|
2460
|
-
|
2461
|
-
if @api_client.config.client_side_validation &&
|
2462
|
-
fail ArgumentError, "
|
2497
|
+
# verify the required parameter 'job_id' is set
|
2498
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
2499
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_update_catalog_items_job"
|
2463
2500
|
end
|
2464
|
-
allowable_values = ["
|
2465
|
-
if @api_client.config.client_side_validation && opts[:'
|
2466
|
-
fail ArgumentError, "invalid value for \"
|
2501
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2502
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
2503
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}"
|
2504
|
+
end
|
2505
|
+
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
2506
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
2507
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
2508
|
+
end
|
2509
|
+
allowable_values = ["items"]
|
2510
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
2511
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
2467
2512
|
end
|
2468
2513
|
# resource path
|
2469
|
-
local_var_path = '/api/catalog-
|
2514
|
+
local_var_path = '/api/catalog-item-bulk-update-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
2470
2515
|
|
2471
2516
|
# query parameters
|
2472
2517
|
query_params = opts[:query_params] || {}
|
2473
|
-
query_params[:'fields[catalog-
|
2474
|
-
query_params[:'
|
2475
|
-
query_params[:'
|
2476
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2518
|
+
query_params[:'fields[catalog-item-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_update_job'], :csv) if !opts[:'fields_catalog_item_bulk_update_job'].nil?
|
2519
|
+
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
2520
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2477
2521
|
|
2478
2522
|
# header parameters
|
2479
2523
|
header_params = opts[:header_params] || {}
|
2480
2524
|
# klaviyo api revision
|
2481
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2525
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2482
2526
|
# HTTP header 'Accept' (if needed)
|
2483
2527
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2484
2528
|
|
@@ -2495,7 +2539,7 @@ module KlaviyoAPI
|
|
2495
2539
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2496
2540
|
|
2497
2541
|
new_options = opts.merge(
|
2498
|
-
:operation => :"CatalogsApi.
|
2542
|
+
:operation => :"CatalogsApi.get_bulk_update_catalog_items_job",
|
2499
2543
|
:header_params => header_params,
|
2500
2544
|
:query_params => query_params,
|
2501
2545
|
:form_params => form_params,
|
@@ -2506,59 +2550,63 @@ module KlaviyoAPI
|
|
2506
2550
|
|
2507
2551
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2508
2552
|
if @api_client.config.debugging
|
2509
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2553
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_update_catalog_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2510
2554
|
end
|
2511
2555
|
return data, status_code, headers
|
2512
2556
|
end
|
2513
2557
|
|
2514
|
-
# alias of `
|
2515
|
-
alias
|
2558
|
+
# alias of `get_bulk_update_catalog_items_job_with_http_info`
|
2559
|
+
alias get_update_items_job_with_http_info get_bulk_update_catalog_items_job_with_http_info
|
2516
2560
|
|
2517
|
-
#
|
2518
|
-
|
2519
|
-
|
2561
|
+
# alias of `get_bulk_update_catalog_items_job_with_http_info`
|
2562
|
+
alias get_catalog_item_bulk_update_job_with_http_info get_bulk_update_catalog_items_job_with_http_info
|
2563
|
+
|
2564
|
+
# Get Bulk Update Catalog Items Jobs
|
2565
|
+
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2520
2566
|
# @param [Hash] opts the optional parameters
|
2521
|
-
# @option opts [String] :
|
2522
|
-
# @option opts [String] :
|
2523
|
-
# @option opts [String] :
|
2567
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2568
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2569
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2524
2570
|
# @return [Hash<String, Object>]
|
2525
|
-
def
|
2526
|
-
data, _status_code, _headers =
|
2571
|
+
def get_bulk_update_catalog_items_jobs(opts = {})
|
2572
|
+
data, _status_code, _headers = get_bulk_update_catalog_items_jobs_with_http_info(opts)
|
2527
2573
|
data
|
2528
2574
|
end
|
2529
2575
|
|
2530
|
-
# alias of `
|
2531
|
-
alias
|
2576
|
+
# alias of `get_bulk_update_catalog_items_jobs`
|
2577
|
+
alias get_update_items_jobs get_bulk_update_catalog_items_jobs
|
2532
2578
|
|
2533
|
-
#
|
2534
|
-
|
2535
|
-
|
2579
|
+
# alias of `get_bulk_update_catalog_items_jobs`
|
2580
|
+
alias get_catalog_item_bulk_update_jobs get_bulk_update_catalog_items_jobs
|
2581
|
+
|
2582
|
+
# Get Bulk Update Catalog Items Jobs
|
2583
|
+
# Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2536
2584
|
# @param [Hash] opts the optional parameters
|
2537
|
-
# @option opts [String] :
|
2538
|
-
# @option opts [String] :
|
2539
|
-
# @option opts [String] :
|
2585
|
+
# @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2586
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2587
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2540
2588
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2541
|
-
def
|
2589
|
+
def get_bulk_update_catalog_items_jobs_with_http_info(opts = {})
|
2542
2590
|
if @api_client.config.debugging
|
2543
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2591
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_catalog_items_jobs ...'
|
2544
2592
|
end
|
2545
|
-
allowable_values = ["
|
2546
|
-
if @api_client.config.client_side_validation && opts[:'
|
2547
|
-
fail ArgumentError, "invalid value for \"
|
2593
|
+
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2594
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
2595
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}"
|
2548
2596
|
end
|
2549
2597
|
# resource path
|
2550
|
-
local_var_path = '/api/catalog-
|
2598
|
+
local_var_path = '/api/catalog-item-bulk-update-jobs'
|
2551
2599
|
|
2552
2600
|
# query parameters
|
2553
2601
|
query_params = opts[:query_params] || {}
|
2602
|
+
query_params[:'fields[catalog-item-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_update_job'], :csv) if !opts[:'fields_catalog_item_bulk_update_job'].nil?
|
2554
2603
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2555
2604
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2556
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2557
2605
|
|
2558
2606
|
# header parameters
|
2559
2607
|
header_params = opts[:header_params] || {}
|
2560
2608
|
# klaviyo api revision
|
2561
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2609
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2562
2610
|
# HTTP header 'Accept' (if needed)
|
2563
2611
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2564
2612
|
|
@@ -2575,7 +2623,7 @@ module KlaviyoAPI
|
|
2575
2623
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2576
2624
|
|
2577
2625
|
new_options = opts.merge(
|
2578
|
-
:operation => :"CatalogsApi.
|
2626
|
+
:operation => :"CatalogsApi.get_bulk_update_catalog_items_jobs",
|
2579
2627
|
:header_params => header_params,
|
2580
2628
|
:query_params => query_params,
|
2581
2629
|
:form_params => form_params,
|
@@ -2586,49 +2634,55 @@ module KlaviyoAPI
|
|
2586
2634
|
|
2587
2635
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2588
2636
|
if @api_client.config.debugging
|
2589
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2637
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_update_catalog_items_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2590
2638
|
end
|
2591
2639
|
return data, status_code, headers
|
2592
2640
|
end
|
2593
2641
|
|
2594
|
-
# alias of `
|
2595
|
-
alias
|
2642
|
+
# alias of `get_bulk_update_catalog_items_jobs_with_http_info`
|
2643
|
+
alias get_update_items_jobs_with_http_info get_bulk_update_catalog_items_jobs_with_http_info
|
2596
2644
|
|
2597
|
-
#
|
2598
|
-
|
2645
|
+
# alias of `get_bulk_update_catalog_items_jobs_with_http_info`
|
2646
|
+
alias get_catalog_item_bulk_update_jobs_with_http_info get_bulk_update_catalog_items_jobs_with_http_info
|
2647
|
+
|
2648
|
+
# Get Bulk Update Categories Job
|
2649
|
+
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2599
2650
|
# @param job_id [String] ID of the job to retrieve.
|
2600
2651
|
# @param [Hash] opts the optional parameters
|
2601
|
-
# @option opts [Array<String>] :
|
2602
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-
|
2603
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2652
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2653
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2654
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2604
2655
|
# @return [Hash<String, Object>]
|
2605
|
-
def
|
2606
|
-
data, _status_code, _headers =
|
2656
|
+
def get_bulk_update_categories_job(job_id, opts = {})
|
2657
|
+
data, _status_code, _headers = get_bulk_update_categories_job_with_http_info(job_id, opts)
|
2607
2658
|
data
|
2608
2659
|
end
|
2609
2660
|
|
2610
|
-
# alias of `
|
2611
|
-
alias
|
2661
|
+
# alias of `get_bulk_update_categories_job`
|
2662
|
+
alias get_update_categories_job get_bulk_update_categories_job
|
2612
2663
|
|
2613
|
-
#
|
2614
|
-
|
2664
|
+
# alias of `get_bulk_update_categories_job`
|
2665
|
+
alias get_catalog_category_bulk_update_job get_bulk_update_categories_job
|
2666
|
+
|
2667
|
+
# Get Bulk Update Categories Job
|
2668
|
+
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2615
2669
|
# @param job_id [String] ID of the job to retrieve.
|
2616
2670
|
# @param [Hash] opts the optional parameters
|
2617
|
-
# @option opts [Array<String>] :
|
2618
|
-
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-
|
2619
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2671
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2672
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2673
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2620
2674
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2621
|
-
def
|
2675
|
+
def get_bulk_update_categories_job_with_http_info(job_id, opts = {})
|
2622
2676
|
if @api_client.config.debugging
|
2623
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2677
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_categories_job ...'
|
2624
2678
|
end
|
2625
2679
|
# verify the required parameter 'job_id' is set
|
2626
2680
|
if @api_client.config.client_side_validation && job_id.nil?
|
2627
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.
|
2681
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_update_categories_job"
|
2628
2682
|
end
|
2629
2683
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2630
|
-
if @api_client.config.client_side_validation && opts[:'
|
2631
|
-
fail ArgumentError, "invalid value for \"
|
2684
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
2685
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}"
|
2632
2686
|
end
|
2633
2687
|
allowable_values = ["external_id", "name", "updated"]
|
2634
2688
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
@@ -2639,18 +2693,18 @@ module KlaviyoAPI
|
|
2639
2693
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
2640
2694
|
end
|
2641
2695
|
# resource path
|
2642
|
-
local_var_path = '/api/catalog-category-bulk-
|
2696
|
+
local_var_path = '/api/catalog-category-bulk-update-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
2643
2697
|
|
2644
2698
|
# query parameters
|
2645
2699
|
query_params = opts[:query_params] || {}
|
2646
|
-
query_params[:'fields[catalog-category-bulk-
|
2700
|
+
query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil?
|
2647
2701
|
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
2648
2702
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2649
2703
|
|
2650
2704
|
# header parameters
|
2651
2705
|
header_params = opts[:header_params] || {}
|
2652
2706
|
# klaviyo api revision
|
2653
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2707
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2654
2708
|
# HTTP header 'Accept' (if needed)
|
2655
2709
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2656
2710
|
|
@@ -2667,7 +2721,7 @@ module KlaviyoAPI
|
|
2667
2721
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2668
2722
|
|
2669
2723
|
new_options = opts.merge(
|
2670
|
-
:operation => :"CatalogsApi.
|
2724
|
+
:operation => :"CatalogsApi.get_bulk_update_categories_job",
|
2671
2725
|
:header_params => header_params,
|
2672
2726
|
:query_params => query_params,
|
2673
2727
|
:form_params => form_params,
|
@@ -2678,57 +2732,63 @@ module KlaviyoAPI
|
|
2678
2732
|
|
2679
2733
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2680
2734
|
if @api_client.config.debugging
|
2681
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2735
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_update_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2682
2736
|
end
|
2683
2737
|
return data, status_code, headers
|
2684
2738
|
end
|
2685
2739
|
|
2686
|
-
# alias of `
|
2687
|
-
alias
|
2740
|
+
# alias of `get_bulk_update_categories_job_with_http_info`
|
2741
|
+
alias get_update_categories_job_with_http_info get_bulk_update_categories_job_with_http_info
|
2688
2742
|
|
2689
|
-
#
|
2690
|
-
|
2743
|
+
# alias of `get_bulk_update_categories_job_with_http_info`
|
2744
|
+
alias get_catalog_category_bulk_update_job_with_http_info get_bulk_update_categories_job_with_http_info
|
2745
|
+
|
2746
|
+
# Get Bulk Update Categories Jobs
|
2747
|
+
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2691
2748
|
# @param [Hash] opts the optional parameters
|
2692
|
-
# @option opts [Array<String>] :
|
2693
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2694
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2749
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2750
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2751
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2695
2752
|
# @return [Hash<String, Object>]
|
2696
|
-
def
|
2697
|
-
data, _status_code, _headers =
|
2753
|
+
def get_bulk_update_categories_jobs(opts = {})
|
2754
|
+
data, _status_code, _headers = get_bulk_update_categories_jobs_with_http_info(opts)
|
2698
2755
|
data
|
2699
2756
|
end
|
2700
2757
|
|
2701
|
-
# alias of `
|
2702
|
-
alias
|
2758
|
+
# alias of `get_bulk_update_categories_jobs`
|
2759
|
+
alias get_update_categories_jobs get_bulk_update_categories_jobs
|
2703
2760
|
|
2704
|
-
#
|
2705
|
-
|
2761
|
+
# alias of `get_bulk_update_categories_jobs`
|
2762
|
+
alias get_catalog_category_bulk_update_jobs get_bulk_update_categories_jobs
|
2763
|
+
|
2764
|
+
# Get Bulk Update Categories Jobs
|
2765
|
+
# Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2706
2766
|
# @param [Hash] opts the optional parameters
|
2707
|
-
# @option opts [Array<String>] :
|
2708
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2709
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2767
|
+
# @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2768
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2769
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2710
2770
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2711
|
-
def
|
2771
|
+
def get_bulk_update_categories_jobs_with_http_info(opts = {})
|
2712
2772
|
if @api_client.config.debugging
|
2713
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2773
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_categories_jobs ...'
|
2714
2774
|
end
|
2715
2775
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2716
|
-
if @api_client.config.client_side_validation && opts[:'
|
2717
|
-
fail ArgumentError, "invalid value for \"
|
2776
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
2777
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}"
|
2718
2778
|
end
|
2719
2779
|
# resource path
|
2720
|
-
local_var_path = '/api/catalog-category-bulk-
|
2780
|
+
local_var_path = '/api/catalog-category-bulk-update-jobs'
|
2721
2781
|
|
2722
2782
|
# query parameters
|
2723
2783
|
query_params = opts[:query_params] || {}
|
2724
|
-
query_params[:'fields[catalog-category-bulk-
|
2784
|
+
query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil?
|
2725
2785
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2726
2786
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2727
2787
|
|
2728
2788
|
# header parameters
|
2729
2789
|
header_params = opts[:header_params] || {}
|
2730
2790
|
# klaviyo api revision
|
2731
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2791
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2732
2792
|
# HTTP header 'Accept' (if needed)
|
2733
2793
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2734
2794
|
|
@@ -2745,7 +2805,7 @@ module KlaviyoAPI
|
|
2745
2805
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2746
2806
|
|
2747
2807
|
new_options = opts.merge(
|
2748
|
-
:operation => :"CatalogsApi.
|
2808
|
+
:operation => :"CatalogsApi.get_bulk_update_categories_jobs",
|
2749
2809
|
:header_params => header_params,
|
2750
2810
|
:query_params => query_params,
|
2751
2811
|
:form_params => form_params,
|
@@ -2756,49 +2816,55 @@ module KlaviyoAPI
|
|
2756
2816
|
|
2757
2817
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2758
2818
|
if @api_client.config.debugging
|
2759
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2819
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_update_categories_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2760
2820
|
end
|
2761
2821
|
return data, status_code, headers
|
2762
2822
|
end
|
2763
2823
|
|
2764
|
-
# alias of `
|
2765
|
-
alias
|
2824
|
+
# alias of `get_bulk_update_categories_jobs_with_http_info`
|
2825
|
+
alias get_update_categories_jobs_with_http_info get_bulk_update_categories_jobs_with_http_info
|
2766
2826
|
|
2767
|
-
#
|
2768
|
-
|
2827
|
+
# alias of `get_bulk_update_categories_jobs_with_http_info`
|
2828
|
+
alias get_catalog_category_bulk_update_jobs_with_http_info get_bulk_update_categories_jobs_with_http_info
|
2829
|
+
|
2830
|
+
# Get Bulk Update Variants Job
|
2831
|
+
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2769
2832
|
# @param job_id [String] ID of the job to retrieve.
|
2770
2833
|
# @param [Hash] opts the optional parameters
|
2771
|
-
# @option opts [Array<String>] :
|
2772
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-
|
2773
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2834
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2835
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2836
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2774
2837
|
# @return [Hash<String, Object>]
|
2775
|
-
def
|
2776
|
-
data, _status_code, _headers =
|
2838
|
+
def get_bulk_update_variants_job(job_id, opts = {})
|
2839
|
+
data, _status_code, _headers = get_bulk_update_variants_job_with_http_info(job_id, opts)
|
2777
2840
|
data
|
2778
2841
|
end
|
2779
2842
|
|
2780
|
-
# alias of `
|
2781
|
-
alias
|
2843
|
+
# alias of `get_bulk_update_variants_job`
|
2844
|
+
alias get_update_variants_job get_bulk_update_variants_job
|
2782
2845
|
|
2783
|
-
#
|
2784
|
-
|
2846
|
+
# alias of `get_bulk_update_variants_job`
|
2847
|
+
alias get_catalog_variant_bulk_update_job get_bulk_update_variants_job
|
2848
|
+
|
2849
|
+
# Get Bulk Update Variants Job
|
2850
|
+
# Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2785
2851
|
# @param job_id [String] ID of the job to retrieve.
|
2786
2852
|
# @param [Hash] opts the optional parameters
|
2787
|
-
# @option opts [Array<String>] :
|
2788
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-
|
2789
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2853
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2854
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2855
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
2790
2856
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2791
|
-
def
|
2857
|
+
def get_bulk_update_variants_job_with_http_info(job_id, opts = {})
|
2792
2858
|
if @api_client.config.debugging
|
2793
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2859
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_variants_job ...'
|
2794
2860
|
end
|
2795
2861
|
# verify the required parameter 'job_id' is set
|
2796
2862
|
if @api_client.config.client_side_validation && job_id.nil?
|
2797
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.
|
2863
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_bulk_update_variants_job"
|
2798
2864
|
end
|
2799
2865
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2800
|
-
if @api_client.config.client_side_validation && opts[:'
|
2801
|
-
fail ArgumentError, "invalid value for \"
|
2866
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
2867
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}"
|
2802
2868
|
end
|
2803
2869
|
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
2804
2870
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
@@ -2809,18 +2875,18 @@ module KlaviyoAPI
|
|
2809
2875
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
2810
2876
|
end
|
2811
2877
|
# resource path
|
2812
|
-
local_var_path = '/api/catalog-variant-bulk-
|
2878
|
+
local_var_path = '/api/catalog-variant-bulk-update-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
|
2813
2879
|
|
2814
2880
|
# query parameters
|
2815
2881
|
query_params = opts[:query_params] || {}
|
2816
|
-
query_params[:'fields[catalog-variant-bulk-
|
2882
|
+
query_params[:'fields[catalog-variant-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_update_job'], :csv) if !opts[:'fields_catalog_variant_bulk_update_job'].nil?
|
2817
2883
|
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
2818
2884
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
2819
2885
|
|
2820
2886
|
# header parameters
|
2821
2887
|
header_params = opts[:header_params] || {}
|
2822
2888
|
# klaviyo api revision
|
2823
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2889
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2824
2890
|
# HTTP header 'Accept' (if needed)
|
2825
2891
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2826
2892
|
|
@@ -2837,7 +2903,7 @@ module KlaviyoAPI
|
|
2837
2903
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2838
2904
|
|
2839
2905
|
new_options = opts.merge(
|
2840
|
-
:operation => :"CatalogsApi.
|
2906
|
+
:operation => :"CatalogsApi.get_bulk_update_variants_job",
|
2841
2907
|
:header_params => header_params,
|
2842
2908
|
:query_params => query_params,
|
2843
2909
|
:form_params => form_params,
|
@@ -2848,57 +2914,63 @@ module KlaviyoAPI
|
|
2848
2914
|
|
2849
2915
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2850
2916
|
if @api_client.config.debugging
|
2851
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
2917
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_update_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2852
2918
|
end
|
2853
2919
|
return data, status_code, headers
|
2854
2920
|
end
|
2855
2921
|
|
2856
|
-
# alias of `
|
2857
|
-
alias
|
2922
|
+
# alias of `get_bulk_update_variants_job_with_http_info`
|
2923
|
+
alias get_update_variants_job_with_http_info get_bulk_update_variants_job_with_http_info
|
2858
2924
|
|
2859
|
-
#
|
2860
|
-
|
2925
|
+
# alias of `get_bulk_update_variants_job_with_http_info`
|
2926
|
+
alias get_catalog_variant_bulk_update_job_with_http_info get_bulk_update_variants_job_with_http_info
|
2927
|
+
|
2928
|
+
# Get Bulk Update Variants Jobs
|
2929
|
+
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2861
2930
|
# @param [Hash] opts the optional parameters
|
2862
|
-
# @option opts [Array<String>] :
|
2863
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2864
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2931
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2932
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2933
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2865
2934
|
# @return [Hash<String, Object>]
|
2866
|
-
def
|
2867
|
-
data, _status_code, _headers =
|
2935
|
+
def get_bulk_update_variants_jobs(opts = {})
|
2936
|
+
data, _status_code, _headers = get_bulk_update_variants_jobs_with_http_info(opts)
|
2868
2937
|
data
|
2869
2938
|
end
|
2870
2939
|
|
2871
|
-
# alias of `
|
2872
|
-
alias
|
2940
|
+
# alias of `get_bulk_update_variants_jobs`
|
2941
|
+
alias get_update_variants_jobs get_bulk_update_variants_jobs
|
2873
2942
|
|
2874
|
-
#
|
2875
|
-
|
2943
|
+
# alias of `get_bulk_update_variants_jobs`
|
2944
|
+
alias get_catalog_variant_bulk_update_jobs get_bulk_update_variants_jobs
|
2945
|
+
|
2946
|
+
# Get Bulk Update Variants Jobs
|
2947
|
+
# Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2876
2948
|
# @param [Hash] opts the optional parameters
|
2877
|
-
# @option opts [Array<String>] :
|
2878
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2879
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2949
|
+
# @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
2950
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
2951
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
2880
2952
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2881
|
-
def
|
2953
|
+
def get_bulk_update_variants_jobs_with_http_info(opts = {})
|
2882
2954
|
if @api_client.config.debugging
|
2883
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
2955
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_bulk_update_variants_jobs ...'
|
2884
2956
|
end
|
2885
2957
|
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
2886
|
-
if @api_client.config.client_side_validation && opts[:'
|
2887
|
-
fail ArgumentError, "invalid value for \"
|
2958
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
2959
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}"
|
2888
2960
|
end
|
2889
2961
|
# resource path
|
2890
|
-
local_var_path = '/api/catalog-variant-bulk-
|
2962
|
+
local_var_path = '/api/catalog-variant-bulk-update-jobs'
|
2891
2963
|
|
2892
2964
|
# query parameters
|
2893
2965
|
query_params = opts[:query_params] || {}
|
2894
|
-
query_params[:'fields[catalog-variant-bulk-
|
2966
|
+
query_params[:'fields[catalog-variant-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_update_job'], :csv) if !opts[:'fields_catalog_variant_bulk_update_job'].nil?
|
2895
2967
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
2896
2968
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
2897
2969
|
|
2898
2970
|
# header parameters
|
2899
2971
|
header_params = opts[:header_params] || {}
|
2900
2972
|
# klaviyo api revision
|
2901
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2973
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2902
2974
|
# HTTP header 'Accept' (if needed)
|
2903
2975
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2904
2976
|
|
@@ -2915,7 +2987,7 @@ module KlaviyoAPI
|
|
2915
2987
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2916
2988
|
|
2917
2989
|
new_options = opts.merge(
|
2918
|
-
:operation => :"CatalogsApi.
|
2990
|
+
:operation => :"CatalogsApi.get_bulk_update_variants_jobs",
|
2919
2991
|
:header_params => header_params,
|
2920
2992
|
:query_params => query_params,
|
2921
2993
|
:form_params => form_params,
|
@@ -2926,57 +2998,64 @@ module KlaviyoAPI
|
|
2926
2998
|
|
2927
2999
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2928
3000
|
if @api_client.config.debugging
|
2929
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3001
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_bulk_update_variants_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2930
3002
|
end
|
2931
3003
|
return data, status_code, headers
|
2932
3004
|
end
|
2933
3005
|
|
2934
|
-
# alias of `
|
2935
|
-
alias
|
3006
|
+
# alias of `get_bulk_update_variants_jobs_with_http_info`
|
3007
|
+
alias get_update_variants_jobs_with_http_info get_bulk_update_variants_jobs_with_http_info
|
2936
3008
|
|
2937
|
-
#
|
2938
|
-
|
2939
|
-
|
3009
|
+
# alias of `get_bulk_update_variants_jobs_with_http_info`
|
3010
|
+
alias get_catalog_variant_bulk_update_jobs_with_http_info get_bulk_update_variants_jobs_with_http_info
|
3011
|
+
|
3012
|
+
# Get Catalog Categories
|
3013
|
+
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2940
3014
|
# @param [Hash] opts the optional parameters
|
2941
|
-
# @option opts [Array<String>] :
|
3015
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3016
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
3017
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3018
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
2942
3019
|
# @return [Hash<String, Object>]
|
2943
|
-
def
|
2944
|
-
data, _status_code, _headers =
|
3020
|
+
def get_catalog_categories(opts = {})
|
3021
|
+
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
|
2945
3022
|
data
|
2946
3023
|
end
|
2947
3024
|
|
2948
|
-
#
|
2949
|
-
|
2950
|
-
|
2951
|
-
# Get Delete Categories Job
|
2952
|
-
# Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2953
|
-
# @param job_id [String] ID of the job to retrieve.
|
3025
|
+
# Get Catalog Categories
|
3026
|
+
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
2954
3027
|
# @param [Hash] opts the optional parameters
|
2955
|
-
# @option opts [Array<String>] :
|
3028
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3029
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
3030
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3031
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
2956
3032
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2957
|
-
def
|
3033
|
+
def get_catalog_categories_with_http_info(opts = {})
|
2958
3034
|
if @api_client.config.debugging
|
2959
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3035
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_categories ...'
|
2960
3036
|
end
|
2961
|
-
|
2962
|
-
if @api_client.config.client_side_validation &&
|
2963
|
-
fail ArgumentError, "
|
3037
|
+
allowable_values = ["external_id", "name", "updated"]
|
3038
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
3039
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
2964
3040
|
end
|
2965
|
-
allowable_values = ["
|
2966
|
-
if @api_client.config.client_side_validation && opts[:'
|
2967
|
-
fail ArgumentError, "invalid value for \"
|
3041
|
+
allowable_values = ["created", "-created"]
|
3042
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3043
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
2968
3044
|
end
|
2969
3045
|
# resource path
|
2970
|
-
local_var_path = '/api/catalog-
|
3046
|
+
local_var_path = '/api/catalog-categories'
|
2971
3047
|
|
2972
3048
|
# query parameters
|
2973
3049
|
query_params = opts[:query_params] || {}
|
2974
|
-
query_params[:'fields[catalog-category
|
3050
|
+
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
3051
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3052
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3053
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
2975
3054
|
|
2976
3055
|
# header parameters
|
2977
3056
|
header_params = opts[:header_params] || {}
|
2978
3057
|
# klaviyo api revision
|
2979
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3058
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
2980
3059
|
# HTTP header 'Accept' (if needed)
|
2981
3060
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2982
3061
|
|
@@ -2993,7 +3072,7 @@ module KlaviyoAPI
|
|
2993
3072
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
2994
3073
|
|
2995
3074
|
new_options = opts.merge(
|
2996
|
-
:operation => :"CatalogsApi.
|
3075
|
+
:operation => :"CatalogsApi.get_catalog_categories",
|
2997
3076
|
:header_params => header_params,
|
2998
3077
|
:query_params => query_params,
|
2999
3078
|
:form_params => form_params,
|
@@ -3004,57 +3083,51 @@ module KlaviyoAPI
|
|
3004
3083
|
|
3005
3084
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3006
3085
|
if @api_client.config.debugging
|
3007
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3086
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_catalog_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3008
3087
|
end
|
3009
3088
|
return data, status_code, headers
|
3010
3089
|
end
|
3011
3090
|
|
3012
|
-
#
|
3013
|
-
|
3014
|
-
|
3015
|
-
# Get Delete Categories Jobs
|
3016
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3091
|
+
# Get Catalog Category
|
3092
|
+
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3093
|
+
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3017
3094
|
# @param [Hash] opts the optional parameters
|
3018
|
-
# @option opts [Array<String>] :
|
3019
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3020
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3095
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3021
3096
|
# @return [Hash<String, Object>]
|
3022
|
-
def
|
3023
|
-
data, _status_code, _headers =
|
3097
|
+
def get_catalog_category(id, opts = {})
|
3098
|
+
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
|
3024
3099
|
data
|
3025
3100
|
end
|
3026
3101
|
|
3027
|
-
#
|
3028
|
-
|
3029
|
-
|
3030
|
-
# Get Delete Categories Jobs
|
3031
|
-
# Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3102
|
+
# Get Catalog Category
|
3103
|
+
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3104
|
+
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3032
3105
|
# @param [Hash] opts the optional parameters
|
3033
|
-
# @option opts [Array<String>] :
|
3034
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
|
3035
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3106
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3036
3107
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3037
|
-
def
|
3108
|
+
def get_catalog_category_with_http_info(id, opts = {})
|
3038
3109
|
if @api_client.config.debugging
|
3039
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3110
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_category ...'
|
3040
3111
|
end
|
3041
|
-
|
3042
|
-
if @api_client.config.client_side_validation &&
|
3043
|
-
fail ArgumentError, "
|
3112
|
+
# verify the required parameter 'id' is set
|
3113
|
+
if @api_client.config.client_side_validation && id.nil?
|
3114
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_category"
|
3115
|
+
end
|
3116
|
+
allowable_values = ["external_id", "name", "updated"]
|
3117
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
3118
|
+
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
3044
3119
|
end
|
3045
3120
|
# resource path
|
3046
|
-
local_var_path = '/api/catalog-
|
3121
|
+
local_var_path = '/api/catalog-categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3047
3122
|
|
3048
3123
|
# query parameters
|
3049
3124
|
query_params = opts[:query_params] || {}
|
3050
|
-
query_params[:'fields[catalog-category
|
3051
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3052
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3125
|
+
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
3053
3126
|
|
3054
3127
|
# header parameters
|
3055
3128
|
header_params = opts[:header_params] || {}
|
3056
3129
|
# klaviyo api revision
|
3057
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3058
3131
|
# HTTP header 'Accept' (if needed)
|
3059
3132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3060
3133
|
|
@@ -3071,7 +3144,7 @@ module KlaviyoAPI
|
|
3071
3144
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3072
3145
|
|
3073
3146
|
new_options = opts.merge(
|
3074
|
-
:operation => :"CatalogsApi.
|
3147
|
+
:operation => :"CatalogsApi.get_catalog_category",
|
3075
3148
|
:header_params => header_params,
|
3076
3149
|
:query_params => query_params,
|
3077
3150
|
:form_params => form_params,
|
@@ -3082,57 +3155,65 @@ module KlaviyoAPI
|
|
3082
3155
|
|
3083
3156
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3084
3157
|
if @api_client.config.debugging
|
3085
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3158
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3086
3159
|
end
|
3087
3160
|
return data, status_code, headers
|
3088
3161
|
end
|
3089
3162
|
|
3090
|
-
#
|
3091
|
-
|
3092
|
-
|
3093
|
-
# Get Delete Variants Job
|
3094
|
-
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3095
|
-
# @param job_id [String] ID of the job to retrieve.
|
3163
|
+
# Get Catalog Item
|
3164
|
+
# Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3165
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3096
3166
|
# @param [Hash] opts the optional parameters
|
3097
|
-
# @option opts [Array<String>] :
|
3167
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3168
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3169
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
3098
3170
|
# @return [Hash<String, Object>]
|
3099
|
-
def
|
3100
|
-
data, _status_code, _headers =
|
3171
|
+
def get_catalog_item(id, opts = {})
|
3172
|
+
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
|
3101
3173
|
data
|
3102
3174
|
end
|
3103
3175
|
|
3104
|
-
#
|
3105
|
-
|
3106
|
-
|
3107
|
-
# Get Delete Variants Job
|
3108
|
-
# Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3109
|
-
# @param job_id [String] ID of the job to retrieve.
|
3176
|
+
# Get Catalog Item
|
3177
|
+
# Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3178
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3110
3179
|
# @param [Hash] opts the optional parameters
|
3111
|
-
# @option opts [Array<String>] :
|
3180
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3181
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3182
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
3112
3183
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3113
|
-
def
|
3184
|
+
def get_catalog_item_with_http_info(id, opts = {})
|
3114
3185
|
if @api_client.config.debugging
|
3115
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3186
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item ...'
|
3116
3187
|
end
|
3117
|
-
# verify the required parameter '
|
3118
|
-
if @api_client.config.client_side_validation &&
|
3119
|
-
fail ArgumentError, "Missing the required parameter '
|
3188
|
+
# verify the required parameter 'id' is set
|
3189
|
+
if @api_client.config.client_side_validation && id.nil?
|
3190
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_item"
|
3120
3191
|
end
|
3121
|
-
allowable_values = ["
|
3122
|
-
if @api_client.config.client_side_validation && opts[:'
|
3123
|
-
fail ArgumentError, "invalid value for \"
|
3192
|
+
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3193
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
3194
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
3195
|
+
end
|
3196
|
+
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3197
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
3198
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
3199
|
+
end
|
3200
|
+
allowable_values = ["variants"]
|
3201
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
3202
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
3124
3203
|
end
|
3125
3204
|
# resource path
|
3126
|
-
local_var_path = '/api/catalog-
|
3205
|
+
local_var_path = '/api/catalog-items/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3127
3206
|
|
3128
3207
|
# query parameters
|
3129
3208
|
query_params = opts[:query_params] || {}
|
3130
|
-
query_params[:'fields[catalog-
|
3209
|
+
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
3210
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
3211
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
3131
3212
|
|
3132
3213
|
# header parameters
|
3133
3214
|
header_params = opts[:header_params] || {}
|
3134
3215
|
# klaviyo api revision
|
3135
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3216
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3136
3217
|
# HTTP header 'Accept' (if needed)
|
3137
3218
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3138
3219
|
|
@@ -3149,7 +3230,7 @@ module KlaviyoAPI
|
|
3149
3230
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3150
3231
|
|
3151
3232
|
new_options = opts.merge(
|
3152
|
-
:operation => :"CatalogsApi.
|
3233
|
+
:operation => :"CatalogsApi.get_catalog_item",
|
3153
3234
|
:header_params => header_params,
|
3154
3235
|
:query_params => query_params,
|
3155
3236
|
:form_params => form_params,
|
@@ -3160,57 +3241,72 @@ module KlaviyoAPI
|
|
3160
3241
|
|
3161
3242
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3162
3243
|
if @api_client.config.debugging
|
3163
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3244
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3164
3245
|
end
|
3165
3246
|
return data, status_code, headers
|
3166
3247
|
end
|
3167
3248
|
|
3168
|
-
#
|
3169
|
-
|
3170
|
-
|
3171
|
-
# Get Delete Variants Jobs
|
3172
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3249
|
+
# Get Catalog Items
|
3250
|
+
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3173
3251
|
# @param [Hash] opts the optional parameters
|
3174
|
-
# @option opts [Array<String>] :
|
3175
|
-
# @option opts [String] :
|
3176
|
-
# @option opts [String] :
|
3252
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3253
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3254
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3255
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
3256
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3257
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3177
3258
|
# @return [Hash<String, Object>]
|
3178
|
-
def
|
3179
|
-
data, _status_code, _headers =
|
3259
|
+
def get_catalog_items(opts = {})
|
3260
|
+
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
|
3180
3261
|
data
|
3181
3262
|
end
|
3182
3263
|
|
3183
|
-
#
|
3184
|
-
|
3185
|
-
|
3186
|
-
# Get Delete Variants Jobs
|
3187
|
-
# Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3264
|
+
# Get Catalog Items
|
3265
|
+
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3188
3266
|
# @param [Hash] opts the optional parameters
|
3189
|
-
# @option opts [Array<String>] :
|
3190
|
-
# @option opts [String] :
|
3191
|
-
# @option opts [String] :
|
3267
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3268
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3269
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3270
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
3271
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3272
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3192
3273
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3193
|
-
def
|
3274
|
+
def get_catalog_items_with_http_info(opts = {})
|
3194
3275
|
if @api_client.config.debugging
|
3195
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3276
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_items ...'
|
3196
3277
|
end
|
3197
|
-
allowable_values = ["
|
3198
|
-
if @api_client.config.client_side_validation && opts[:'
|
3199
|
-
fail ArgumentError, "invalid value for \"
|
3278
|
+
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3279
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
3280
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
3281
|
+
end
|
3282
|
+
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3283
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
3284
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
3285
|
+
end
|
3286
|
+
allowable_values = ["variants"]
|
3287
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
3288
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
3289
|
+
end
|
3290
|
+
allowable_values = ["created", "-created"]
|
3291
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3292
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3200
3293
|
end
|
3201
3294
|
# resource path
|
3202
|
-
local_var_path = '/api/catalog-
|
3295
|
+
local_var_path = '/api/catalog-items'
|
3203
3296
|
|
3204
3297
|
# query parameters
|
3205
3298
|
query_params = opts[:query_params] || {}
|
3206
|
-
query_params[:'fields[catalog-
|
3299
|
+
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
3300
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
3207
3301
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3302
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
3208
3303
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3304
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3209
3305
|
|
3210
3306
|
# header parameters
|
3211
3307
|
header_params = opts[:header_params] || {}
|
3212
3308
|
# klaviyo api revision
|
3213
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3309
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3214
3310
|
# HTTP header 'Accept' (if needed)
|
3215
3311
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3216
3312
|
|
@@ -3227,7 +3323,7 @@ module KlaviyoAPI
|
|
3227
3323
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3228
3324
|
|
3229
3325
|
new_options = opts.merge(
|
3230
|
-
:operation => :"CatalogsApi.
|
3326
|
+
:operation => :"CatalogsApi.get_catalog_items",
|
3231
3327
|
:header_params => header_params,
|
3232
3328
|
:query_params => query_params,
|
3233
3329
|
:form_params => form_params,
|
@@ -3238,59 +3334,51 @@ module KlaviyoAPI
|
|
3238
3334
|
|
3239
3335
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3240
3336
|
if @api_client.config.debugging
|
3241
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3337
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_catalog_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3242
3338
|
end
|
3243
3339
|
return data, status_code, headers
|
3244
3340
|
end
|
3245
3341
|
|
3246
|
-
#
|
3247
|
-
|
3248
|
-
|
3249
|
-
# Get Item IDs for Catalog Category
|
3250
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3251
|
-
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3342
|
+
# Get Catalog Variant
|
3343
|
+
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3344
|
+
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3252
3345
|
# @param [Hash] opts the optional parameters
|
3253
|
-
# @option opts [String] :
|
3254
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3255
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3346
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3256
3347
|
# @return [Hash<String, Object>]
|
3257
|
-
def
|
3258
|
-
data, _status_code, _headers =
|
3348
|
+
def get_catalog_variant(id, opts = {})
|
3349
|
+
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
|
3259
3350
|
data
|
3260
3351
|
end
|
3261
3352
|
|
3262
|
-
#
|
3263
|
-
|
3264
|
-
|
3265
|
-
# Get Item IDs for Catalog Category
|
3266
|
-
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3267
|
-
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3353
|
+
# Get Catalog Variant
|
3354
|
+
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3355
|
+
# @param id [String] The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3268
3356
|
# @param [Hash] opts the optional parameters
|
3269
|
-
# @option opts [String] :
|
3270
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3271
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3357
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3272
3358
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3273
|
-
def
|
3359
|
+
def get_catalog_variant_with_http_info(id, opts = {})
|
3274
3360
|
if @api_client.config.debugging
|
3275
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3361
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_variant ...'
|
3276
3362
|
end
|
3277
|
-
|
3278
|
-
if @api_client.config.client_side_validation &&
|
3279
|
-
fail ArgumentError, "
|
3363
|
+
# verify the required parameter 'id' is set
|
3364
|
+
if @api_client.config.client_side_validation && id.nil?
|
3365
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_variant"
|
3366
|
+
end
|
3367
|
+
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3368
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
3369
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
3280
3370
|
end
|
3281
3371
|
# resource path
|
3282
|
-
local_var_path = '/api/catalog-
|
3372
|
+
local_var_path = '/api/catalog-variants/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3283
3373
|
|
3284
3374
|
# query parameters
|
3285
3375
|
query_params = opts[:query_params] || {}
|
3286
|
-
query_params[:'
|
3287
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3288
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3376
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
3289
3377
|
|
3290
3378
|
# header parameters
|
3291
3379
|
header_params = opts[:header_params] || {}
|
3292
3380
|
# klaviyo api revision
|
3293
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3381
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3294
3382
|
# HTTP header 'Accept' (if needed)
|
3295
3383
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3296
3384
|
|
@@ -3307,7 +3395,7 @@ module KlaviyoAPI
|
|
3307
3395
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3308
3396
|
|
3309
3397
|
new_options = opts.merge(
|
3310
|
-
:operation => :"CatalogsApi.
|
3398
|
+
:operation => :"CatalogsApi.get_catalog_variant",
|
3311
3399
|
:header_params => header_params,
|
3312
3400
|
:query_params => query_params,
|
3313
3401
|
:form_params => form_params,
|
@@ -3318,80 +3406,58 @@ module KlaviyoAPI
|
|
3318
3406
|
|
3319
3407
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3320
3408
|
if @api_client.config.debugging
|
3321
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3409
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_catalog_variant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3322
3410
|
end
|
3323
3411
|
return data, status_code, headers
|
3324
3412
|
end
|
3325
3413
|
|
3326
|
-
#
|
3327
|
-
|
3328
|
-
|
3329
|
-
# Get Items for Catalog Category
|
3330
|
-
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3331
|
-
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3414
|
+
# Get Catalog Variants
|
3415
|
+
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3332
3416
|
# @param [Hash] opts the optional parameters
|
3333
|
-
# @option opts [Array<String>] :
|
3334
|
-
# @option opts [
|
3335
|
-
# @option opts [String] :
|
3336
|
-
# @option opts [
|
3337
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3338
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3417
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3418
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3419
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3420
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3339
3421
|
# @return [Hash<String, Object>]
|
3340
|
-
def
|
3341
|
-
data, _status_code, _headers =
|
3422
|
+
def get_catalog_variants(opts = {})
|
3423
|
+
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
|
3342
3424
|
data
|
3343
3425
|
end
|
3344
3426
|
|
3345
|
-
#
|
3346
|
-
|
3347
|
-
|
3348
|
-
# Get Items for Catalog Category
|
3349
|
-
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3350
|
-
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3427
|
+
# Get Catalog Variants
|
3428
|
+
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3351
3429
|
# @param [Hash] opts the optional parameters
|
3352
|
-
# @option opts [Array<String>] :
|
3353
|
-
# @option opts [
|
3354
|
-
# @option opts [String] :
|
3355
|
-
# @option opts [
|
3356
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
|
3357
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
|
3430
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3431
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3432
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3433
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3358
3434
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3359
|
-
def
|
3435
|
+
def get_catalog_variants_with_http_info(opts = {})
|
3360
3436
|
if @api_client.config.debugging
|
3361
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3362
|
-
end
|
3363
|
-
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3364
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
3365
|
-
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
3437
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_variants ...'
|
3366
3438
|
end
|
3367
3439
|
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3368
3440
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
3369
3441
|
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
3370
3442
|
end
|
3371
|
-
allowable_values = ["variants"]
|
3372
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
3373
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
3374
|
-
end
|
3375
3443
|
allowable_values = ["created", "-created"]
|
3376
3444
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3377
3445
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3378
3446
|
end
|
3379
3447
|
# resource path
|
3380
|
-
local_var_path = '/api/catalog-
|
3448
|
+
local_var_path = '/api/catalog-variants'
|
3381
3449
|
|
3382
3450
|
# query parameters
|
3383
3451
|
query_params = opts[:query_params] || {}
|
3384
|
-
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
3385
3452
|
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
3386
3453
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3387
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
3388
3454
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3389
3455
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3390
3456
|
|
3391
3457
|
# header parameters
|
3392
3458
|
header_params = opts[:header_params] || {}
|
3393
3459
|
# klaviyo api revision
|
3394
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3460
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3395
3461
|
# HTTP header 'Accept' (if needed)
|
3396
3462
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3397
3463
|
|
@@ -3408,7 +3474,7 @@ module KlaviyoAPI
|
|
3408
3474
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3409
3475
|
|
3410
3476
|
new_options = opts.merge(
|
3411
|
-
:operation => :"CatalogsApi.
|
3477
|
+
:operation => :"CatalogsApi.get_catalog_variants",
|
3412
3478
|
:header_params => header_params,
|
3413
3479
|
:query_params => query_params,
|
3414
3480
|
:form_params => form_params,
|
@@ -3419,71 +3485,63 @@ module KlaviyoAPI
|
|
3419
3485
|
|
3420
3486
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3421
3487
|
if @api_client.config.debugging
|
3422
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3488
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_catalog_variants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3423
3489
|
end
|
3424
3490
|
return data, status_code, headers
|
3425
3491
|
end
|
3426
3492
|
|
3427
|
-
#
|
3428
|
-
|
3429
|
-
|
3430
|
-
# Get Update Categories Job
|
3431
|
-
# Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3432
|
-
# @param job_id [String] ID of the job to retrieve.
|
3493
|
+
# Get Categories for Catalog Item
|
3494
|
+
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3495
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3433
3496
|
# @param [Hash] opts the optional parameters
|
3434
|
-
# @option opts [Array<String>] :
|
3435
|
-
# @option opts [
|
3436
|
-
# @option opts [
|
3497
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3498
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
3499
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3500
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3437
3501
|
# @return [Hash<String, Object>]
|
3438
|
-
def
|
3439
|
-
data, _status_code, _headers =
|
3502
|
+
def get_categories_for_catalog_item(id, opts = {})
|
3503
|
+
data, _status_code, _headers = get_categories_for_catalog_item_with_http_info(id, opts)
|
3440
3504
|
data
|
3441
3505
|
end
|
3442
3506
|
|
3443
|
-
# alias of `
|
3444
|
-
alias
|
3507
|
+
# alias of `get_categories_for_catalog_item`
|
3508
|
+
alias get_catalog_item_categories get_categories_for_catalog_item
|
3445
3509
|
|
3446
|
-
# Get
|
3447
|
-
# Get
|
3448
|
-
# @param
|
3510
|
+
# Get Categories for Catalog Item
|
3511
|
+
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3512
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3449
3513
|
# @param [Hash] opts the optional parameters
|
3450
|
-
# @option opts [Array<String>] :
|
3451
|
-
# @option opts [
|
3452
|
-
# @option opts [
|
3514
|
+
# @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3515
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
3516
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3517
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3453
3518
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3454
|
-
def
|
3519
|
+
def get_categories_for_catalog_item_with_http_info(id, opts = {})
|
3455
3520
|
if @api_client.config.debugging
|
3456
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3457
|
-
end
|
3458
|
-
# verify the required parameter 'job_id' is set
|
3459
|
-
if @api_client.config.client_side_validation && job_id.nil?
|
3460
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_update_categories_job"
|
3461
|
-
end
|
3462
|
-
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
3463
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
3464
|
-
fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}"
|
3521
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_categories_for_catalog_item ...'
|
3465
3522
|
end
|
3466
3523
|
allowable_values = ["external_id", "name", "updated"]
|
3467
3524
|
if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) }
|
3468
3525
|
fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}"
|
3469
3526
|
end
|
3470
|
-
allowable_values = ["
|
3471
|
-
if @api_client.config.client_side_validation && opts[:'
|
3472
|
-
fail ArgumentError, "invalid value for \"
|
3527
|
+
allowable_values = ["created", "-created"]
|
3528
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3529
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3473
3530
|
end
|
3474
3531
|
# resource path
|
3475
|
-
local_var_path = '/api/catalog-
|
3532
|
+
local_var_path = '/api/catalog-items/{id}/categories'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3476
3533
|
|
3477
3534
|
# query parameters
|
3478
3535
|
query_params = opts[:query_params] || {}
|
3479
|
-
query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil?
|
3480
3536
|
query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil?
|
3481
|
-
query_params[:'
|
3537
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3538
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3539
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3482
3540
|
|
3483
3541
|
# header parameters
|
3484
3542
|
header_params = opts[:header_params] || {}
|
3485
3543
|
# klaviyo api revision
|
3486
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3544
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3487
3545
|
# HTTP header 'Accept' (if needed)
|
3488
3546
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3489
3547
|
|
@@ -3500,7 +3558,7 @@ module KlaviyoAPI
|
|
3500
3558
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3501
3559
|
|
3502
3560
|
new_options = opts.merge(
|
3503
|
-
:operation => :"CatalogsApi.
|
3561
|
+
:operation => :"CatalogsApi.get_categories_for_catalog_item",
|
3504
3562
|
:header_params => header_params,
|
3505
3563
|
:query_params => query_params,
|
3506
3564
|
:form_params => form_params,
|
@@ -3511,57 +3569,59 @@ module KlaviyoAPI
|
|
3511
3569
|
|
3512
3570
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3513
3571
|
if @api_client.config.debugging
|
3514
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3572
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_categories_for_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3515
3573
|
end
|
3516
3574
|
return data, status_code, headers
|
3517
3575
|
end
|
3518
3576
|
|
3519
|
-
# alias of `
|
3520
|
-
alias
|
3577
|
+
# alias of `get_categories_for_catalog_item_with_http_info`
|
3578
|
+
alias get_catalog_item_categories_with_http_info get_categories_for_catalog_item_with_http_info
|
3521
3579
|
|
3522
|
-
# Get
|
3523
|
-
# Get all catalog
|
3580
|
+
# Get Category IDs for Catalog Item
|
3581
|
+
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3582
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3524
3583
|
# @param [Hash] opts the optional parameters
|
3525
|
-
# @option opts [
|
3526
|
-
# @option opts [String] :
|
3527
|
-
# @option opts [String] :
|
3584
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
3585
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3586
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3528
3587
|
# @return [Hash<String, Object>]
|
3529
|
-
def
|
3530
|
-
data, _status_code, _headers =
|
3588
|
+
def get_category_ids_for_catalog_item(id, opts = {})
|
3589
|
+
data, _status_code, _headers = get_category_ids_for_catalog_item_with_http_info(id, opts)
|
3531
3590
|
data
|
3532
3591
|
end
|
3533
3592
|
|
3534
|
-
# alias of `
|
3535
|
-
alias
|
3593
|
+
# alias of `get_category_ids_for_catalog_item`
|
3594
|
+
alias get_catalog_item_relationships_categories get_category_ids_for_catalog_item
|
3536
3595
|
|
3537
|
-
# Get
|
3538
|
-
# Get all catalog
|
3596
|
+
# Get Category IDs for Catalog Item
|
3597
|
+
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3598
|
+
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3539
3599
|
# @param [Hash] opts the optional parameters
|
3540
|
-
# @option opts [
|
3541
|
-
# @option opts [String] :
|
3542
|
-
# @option opts [String] :
|
3600
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
|
3601
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3602
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3543
3603
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3544
|
-
def
|
3604
|
+
def get_category_ids_for_catalog_item_with_http_info(id, opts = {})
|
3545
3605
|
if @api_client.config.debugging
|
3546
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3606
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_category_ids_for_catalog_item ...'
|
3547
3607
|
end
|
3548
|
-
allowable_values = ["
|
3549
|
-
if @api_client.config.client_side_validation && opts[:'
|
3550
|
-
fail ArgumentError, "invalid value for \"
|
3608
|
+
allowable_values = ["created", "-created"]
|
3609
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3610
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3551
3611
|
end
|
3552
3612
|
# resource path
|
3553
|
-
local_var_path = '/api/catalog-
|
3613
|
+
local_var_path = '/api/catalog-items/{id}/relationships/categories'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3554
3614
|
|
3555
3615
|
# query parameters
|
3556
3616
|
query_params = opts[:query_params] || {}
|
3557
|
-
query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil?
|
3558
3617
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3559
3618
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3619
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3560
3620
|
|
3561
3621
|
# header parameters
|
3562
3622
|
header_params = opts[:header_params] || {}
|
3563
3623
|
# klaviyo api revision
|
3564
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3624
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3565
3625
|
# HTTP header 'Accept' (if needed)
|
3566
3626
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3567
3627
|
|
@@ -3578,7 +3638,7 @@ module KlaviyoAPI
|
|
3578
3638
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3579
3639
|
|
3580
3640
|
new_options = opts.merge(
|
3581
|
-
:operation => :"CatalogsApi.
|
3641
|
+
:operation => :"CatalogsApi.get_category_ids_for_catalog_item",
|
3582
3642
|
:header_params => header_params,
|
3583
3643
|
:query_params => query_params,
|
3584
3644
|
:form_params => form_params,
|
@@ -3589,71 +3649,59 @@ module KlaviyoAPI
|
|
3589
3649
|
|
3590
3650
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3591
3651
|
if @api_client.config.debugging
|
3592
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3652
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_category_ids_for_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3593
3653
|
end
|
3594
3654
|
return data, status_code, headers
|
3595
3655
|
end
|
3596
3656
|
|
3597
|
-
# alias of `
|
3598
|
-
alias
|
3657
|
+
# alias of `get_category_ids_for_catalog_item_with_http_info`
|
3658
|
+
alias get_catalog_item_relationships_categories_with_http_info get_category_ids_for_catalog_item_with_http_info
|
3599
3659
|
|
3600
|
-
# Get
|
3601
|
-
# Get
|
3602
|
-
# @param
|
3660
|
+
# Get Item IDs for Catalog Category
|
3661
|
+
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3662
|
+
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3603
3663
|
# @param [Hash] opts the optional parameters
|
3604
|
-
# @option opts [
|
3605
|
-
# @option opts [
|
3606
|
-
# @option opts [
|
3664
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3665
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3666
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3607
3667
|
# @return [Hash<String, Object>]
|
3608
|
-
def
|
3609
|
-
data, _status_code, _headers =
|
3668
|
+
def get_item_ids_for_catalog_category(id, opts = {})
|
3669
|
+
data, _status_code, _headers = get_item_ids_for_catalog_category_with_http_info(id, opts)
|
3610
3670
|
data
|
3611
3671
|
end
|
3612
3672
|
|
3613
|
-
# alias of `
|
3614
|
-
alias
|
3673
|
+
# alias of `get_item_ids_for_catalog_category`
|
3674
|
+
alias get_catalog_category_relationships_items get_item_ids_for_catalog_category
|
3615
3675
|
|
3616
|
-
# Get
|
3617
|
-
# Get
|
3618
|
-
# @param
|
3676
|
+
# Get Item IDs for Catalog Category
|
3677
|
+
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3678
|
+
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3619
3679
|
# @param [Hash] opts the optional parameters
|
3620
|
-
# @option opts [
|
3621
|
-
# @option opts [
|
3622
|
-
# @option opts [
|
3680
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3681
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3682
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3623
3683
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3624
|
-
def
|
3684
|
+
def get_item_ids_for_catalog_category_with_http_info(id, opts = {})
|
3625
3685
|
if @api_client.config.debugging
|
3626
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3627
|
-
end
|
3628
|
-
# verify the required parameter 'job_id' is set
|
3629
|
-
if @api_client.config.client_side_validation && job_id.nil?
|
3630
|
-
fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_update_variants_job"
|
3631
|
-
end
|
3632
|
-
allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"]
|
3633
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) }
|
3634
|
-
fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}"
|
3635
|
-
end
|
3636
|
-
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3637
|
-
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
3638
|
-
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
3686
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_item_ids_for_catalog_category ...'
|
3639
3687
|
end
|
3640
|
-
allowable_values = ["
|
3641
|
-
if @api_client.config.client_side_validation && opts[:'
|
3642
|
-
fail ArgumentError, "invalid value for \"
|
3688
|
+
allowable_values = ["created", "-created"]
|
3689
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3690
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3643
3691
|
end
|
3644
3692
|
# resource path
|
3645
|
-
local_var_path = '/api/catalog-
|
3693
|
+
local_var_path = '/api/catalog-categories/{id}/relationships/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3646
3694
|
|
3647
3695
|
# query parameters
|
3648
3696
|
query_params = opts[:query_params] || {}
|
3649
|
-
query_params[:'
|
3650
|
-
query_params[:'
|
3651
|
-
query_params[:'
|
3697
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3698
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3699
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3652
3700
|
|
3653
3701
|
# header parameters
|
3654
3702
|
header_params = opts[:header_params] || {}
|
3655
3703
|
# klaviyo api revision
|
3656
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3704
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3657
3705
|
# HTTP header 'Accept' (if needed)
|
3658
3706
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3659
3707
|
|
@@ -3670,7 +3718,7 @@ module KlaviyoAPI
|
|
3670
3718
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3671
3719
|
|
3672
3720
|
new_options = opts.merge(
|
3673
|
-
:operation => :"CatalogsApi.
|
3721
|
+
:operation => :"CatalogsApi.get_item_ids_for_catalog_category",
|
3674
3722
|
:header_params => header_params,
|
3675
3723
|
:query_params => query_params,
|
3676
3724
|
:form_params => form_params,
|
@@ -3681,57 +3729,80 @@ module KlaviyoAPI
|
|
3681
3729
|
|
3682
3730
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3683
3731
|
if @api_client.config.debugging
|
3684
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3732
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_item_ids_for_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3685
3733
|
end
|
3686
3734
|
return data, status_code, headers
|
3687
3735
|
end
|
3688
3736
|
|
3689
|
-
# alias of `
|
3690
|
-
alias
|
3737
|
+
# alias of `get_item_ids_for_catalog_category_with_http_info`
|
3738
|
+
alias get_catalog_category_relationships_items_with_http_info get_item_ids_for_catalog_category_with_http_info
|
3691
3739
|
|
3692
|
-
# Get
|
3693
|
-
# Get all
|
3740
|
+
# Get Items for Catalog Category
|
3741
|
+
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3742
|
+
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3694
3743
|
# @param [Hash] opts the optional parameters
|
3695
|
-
# @option opts [Array<String>] :
|
3696
|
-
# @option opts [String] :
|
3697
|
-
# @option opts [String] :
|
3744
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3745
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3746
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3747
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
3748
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3749
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3698
3750
|
# @return [Hash<String, Object>]
|
3699
|
-
def
|
3700
|
-
data, _status_code, _headers =
|
3751
|
+
def get_items_for_catalog_category(id, opts = {})
|
3752
|
+
data, _status_code, _headers = get_items_for_catalog_category_with_http_info(id, opts)
|
3701
3753
|
data
|
3702
3754
|
end
|
3703
3755
|
|
3704
|
-
# alias of `
|
3705
|
-
alias
|
3756
|
+
# alias of `get_items_for_catalog_category`
|
3757
|
+
alias get_catalog_category_items get_items_for_catalog_category
|
3706
3758
|
|
3707
|
-
# Get
|
3708
|
-
# Get all
|
3759
|
+
# Get Items for Catalog Category
|
3760
|
+
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3761
|
+
# @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3709
3762
|
# @param [Hash] opts the optional parameters
|
3710
|
-
# @option opts [Array<String>] :
|
3711
|
-
# @option opts [String] :
|
3712
|
-
# @option opts [String] :
|
3763
|
+
# @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3764
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3765
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3766
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
|
3767
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3768
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3713
3769
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3714
|
-
def
|
3770
|
+
def get_items_for_catalog_category_with_http_info(id, opts = {})
|
3715
3771
|
if @api_client.config.debugging
|
3716
|
-
@api_client.config.logger.debug 'Calling API: CatalogsApi.
|
3772
|
+
@api_client.config.logger.debug 'Calling API: CatalogsApi.get_items_for_catalog_category ...'
|
3717
3773
|
end
|
3718
|
-
allowable_values = ["
|
3719
|
-
if @api_client.config.client_side_validation && opts[:'
|
3720
|
-
fail ArgumentError, "invalid value for \"
|
3774
|
+
allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3775
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
|
3776
|
+
fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
|
3777
|
+
end
|
3778
|
+
allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
|
3779
|
+
if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) }
|
3780
|
+
fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}"
|
3781
|
+
end
|
3782
|
+
allowable_values = ["variants"]
|
3783
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
3784
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
3785
|
+
end
|
3786
|
+
allowable_values = ["created", "-created"]
|
3787
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3788
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3721
3789
|
end
|
3722
3790
|
# resource path
|
3723
|
-
local_var_path = '/api/catalog-
|
3791
|
+
local_var_path = '/api/catalog-categories/{id}/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
3724
3792
|
|
3725
3793
|
# query parameters
|
3726
3794
|
query_params = opts[:query_params] || {}
|
3727
|
-
query_params[:'fields[catalog-
|
3795
|
+
query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil?
|
3796
|
+
query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil?
|
3728
3797
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
3798
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
3729
3799
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
3800
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3730
3801
|
|
3731
3802
|
# header parameters
|
3732
3803
|
header_params = opts[:header_params] || {}
|
3733
3804
|
# klaviyo api revision
|
3734
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3805
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3735
3806
|
# HTTP header 'Accept' (if needed)
|
3736
3807
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3737
3808
|
|
@@ -3748,7 +3819,7 @@ module KlaviyoAPI
|
|
3748
3819
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
3749
3820
|
|
3750
3821
|
new_options = opts.merge(
|
3751
|
-
:operation => :"CatalogsApi.
|
3822
|
+
:operation => :"CatalogsApi.get_items_for_catalog_category",
|
3752
3823
|
:header_params => header_params,
|
3753
3824
|
:query_params => query_params,
|
3754
3825
|
:form_params => form_params,
|
@@ -3759,21 +3830,21 @@ module KlaviyoAPI
|
|
3759
3830
|
|
3760
3831
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3761
3832
|
if @api_client.config.debugging
|
3762
|
-
@api_client.config.logger.debug "API called: CatalogsApi#
|
3833
|
+
@api_client.config.logger.debug "API called: CatalogsApi#get_items_for_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3763
3834
|
end
|
3764
3835
|
return data, status_code, headers
|
3765
3836
|
end
|
3766
3837
|
|
3767
|
-
# alias of `
|
3768
|
-
alias
|
3838
|
+
# alias of `get_items_for_catalog_category_with_http_info`
|
3839
|
+
alias get_catalog_category_items_with_http_info get_items_for_catalog_category_with_http_info
|
3769
3840
|
|
3770
3841
|
# Get Variant IDs for Catalog Item
|
3771
3842
|
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3772
3843
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3773
3844
|
# @param [Hash] opts the optional parameters
|
3774
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
3775
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
3776
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
3845
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3846
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3847
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3777
3848
|
# @return [Hash<String, Object>]
|
3778
3849
|
def get_variant_ids_for_catalog_item(id, opts = {})
|
3779
3850
|
data, _status_code, _headers = get_variant_ids_for_catalog_item_with_http_info(id, opts)
|
@@ -3787,9 +3858,9 @@ module KlaviyoAPI
|
|
3787
3858
|
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3788
3859
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3789
3860
|
# @param [Hash] opts the optional parameters
|
3790
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
3791
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
3792
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
3861
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3862
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3863
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3793
3864
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3794
3865
|
def get_variant_ids_for_catalog_item_with_http_info(id, opts = {})
|
3795
3866
|
if @api_client.config.debugging
|
@@ -3811,7 +3882,7 @@ module KlaviyoAPI
|
|
3811
3882
|
# header parameters
|
3812
3883
|
header_params = opts[:header_params] || {}
|
3813
3884
|
# klaviyo api revision
|
3814
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3885
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3815
3886
|
# HTTP header 'Accept' (if needed)
|
3816
3887
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3817
3888
|
|
@@ -3851,10 +3922,10 @@ module KlaviyoAPI
|
|
3851
3922
|
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3852
3923
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3853
3924
|
# @param [Hash] opts the optional parameters
|
3854
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-
|
3855
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
3856
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
3857
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
3925
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3926
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3927
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3928
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3858
3929
|
# @return [Hash<String, Object>]
|
3859
3930
|
def get_variants_for_catalog_item(id, opts = {})
|
3860
3931
|
data, _status_code, _headers = get_variants_for_catalog_item_with_http_info(id, opts)
|
@@ -3868,10 +3939,10 @@ module KlaviyoAPI
|
|
3868
3939
|
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
|
3869
3940
|
# @param id [String] The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
|
3870
3941
|
# @param [Hash] opts the optional parameters
|
3871
|
-
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-
|
3872
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
3873
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
3874
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
3942
|
+
# @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
|
3943
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
|
3944
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
|
3945
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
|
3875
3946
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
3876
3947
|
def get_variants_for_catalog_item_with_http_info(id, opts = {})
|
3877
3948
|
if @api_client.config.debugging
|
@@ -3898,7 +3969,7 @@ module KlaviyoAPI
|
|
3898
3969
|
# header parameters
|
3899
3970
|
header_params = opts[:header_params] || {}
|
3900
3971
|
# klaviyo api revision
|
3901
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
3972
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3902
3973
|
# HTTP header 'Accept' (if needed)
|
3903
3974
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3904
3975
|
|
@@ -3975,7 +4046,7 @@ module KlaviyoAPI
|
|
3975
4046
|
# header parameters
|
3976
4047
|
header_params = opts[:header_params] || {}
|
3977
4048
|
# klaviyo api revision
|
3978
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4049
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
3979
4050
|
# HTTP header 'Accept' (if needed)
|
3980
4051
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
3981
4052
|
# HTTP header 'Content-Type'
|
@@ -4057,7 +4128,7 @@ module KlaviyoAPI
|
|
4057
4128
|
# header parameters
|
4058
4129
|
header_params = opts[:header_params] || {}
|
4059
4130
|
# klaviyo api revision
|
4060
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4131
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
4061
4132
|
# HTTP header 'Accept' (if needed)
|
4062
4133
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4063
4134
|
# HTTP header 'Content-Type'
|
@@ -4136,7 +4207,7 @@ module KlaviyoAPI
|
|
4136
4207
|
# header parameters
|
4137
4208
|
header_params = opts[:header_params] || {}
|
4138
4209
|
# klaviyo api revision
|
4139
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4210
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
4140
4211
|
# HTTP header 'Accept' (if needed)
|
4141
4212
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4142
4213
|
# HTTP header 'Content-Type'
|
@@ -4212,7 +4283,7 @@ module KlaviyoAPI
|
|
4212
4283
|
# header parameters
|
4213
4284
|
header_params = opts[:header_params] || {}
|
4214
4285
|
# klaviyo api revision
|
4215
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4286
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
4216
4287
|
# HTTP header 'Accept' (if needed)
|
4217
4288
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4218
4289
|
# HTTP header 'Content-Type'
|
@@ -4288,7 +4359,7 @@ module KlaviyoAPI
|
|
4288
4359
|
# header parameters
|
4289
4360
|
header_params = opts[:header_params] || {}
|
4290
4361
|
# klaviyo api revision
|
4291
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4362
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
4292
4363
|
# HTTP header 'Accept' (if needed)
|
4293
4364
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4294
4365
|
# HTTP header 'Content-Type'
|
@@ -4367,7 +4438,7 @@ module KlaviyoAPI
|
|
4367
4438
|
# header parameters
|
4368
4439
|
header_params = opts[:header_params] || {}
|
4369
4440
|
# klaviyo api revision
|
4370
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4441
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
4371
4442
|
# HTTP header 'Accept' (if needed)
|
4372
4443
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4373
4444
|
# HTTP header 'Content-Type'
|
@@ -4449,7 +4520,7 @@ module KlaviyoAPI
|
|
4449
4520
|
# header parameters
|
4450
4521
|
header_params = opts[:header_params] || {}
|
4451
4522
|
# klaviyo api revision
|
4452
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
4523
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
|
4453
4524
|
# HTTP header 'Accept' (if needed)
|
4454
4525
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
4455
4526
|
# HTTP header 'Content-Type'
|